HTTP Methods

Plant Applications REST API supports these standard HTTP request methods:

  • GET
  • POST
  • PUT
  • DELETE
Method Usage Resource Examples
GET (Read) Retrieves a resource. /Waste locations

Purpose: Get locations of Waste.

Return: A collection of Waste locations.

Status Code:

  • 200 Successful retrieval of all Waste locations.
  • 401 Unauthorized.
  • 404 Record Not Found.
POST (Create) Creates or adds a resource. /Waste Event Record

Purpose: Create Waste Event Records.

Return: Creation of Waste Event Records.

Status Code:

  • 201 Created.
  • 401 Unauthorized (No Content).
  • 403 Forbidden.
  • 400 Invalid data supplied.
PUT (Update) Updates a resource. /Waste Events

Purpose: Bulk update of Waste Events.

Return: Waste Events updated.

Status Code: 204 No Content (success)

  • 201 Created.
  • 400 Invalid data supplied.
  • 401 Unauthorized.
  • 404 Not Found.
  • 422 Unprocessable Entity.
DELETE (Delete) Removes a resource. /Waste Events

Purpose: Delete Waste Events by ID.

Return: Waste Events Deleted.

Status Code:

  • 200 OK.
  • 400 Invalid data supplied.
  • 401 Unauthorized.
  • 403 Forbidden.
  • 404 Not Found.