Description
Provides a facility to register tonnes information for a certain area into the software.
URL
https://apiprod.pdsglobal.com/V2/api/integration/tonnes/V5
Note: There are two non-production environments that can be used for testing.
Request
Type
POST
Headers
Content-Type = Application/Json
Parameters
Mandatory parameters are denoted by *
*
api_key: string(50) This is required for authentication. It is used to identify the user and determine access to the system. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
Body
|
Object: CreateTonnesRequest: |
|
|
areaId - int |
|
|
tonnesDate - DateTime Defines the date and time in which the Tonnes data was recorded in the user’s local datetime. The format is yyyy-MM-dd HH:mm:ss.SSS (e.g. "2017-01-01 00:00:00.000") |
|
|
tonnes - integer The tonnage to be recorded for this area. |
|
|
timeZoneOffset - string(7) |
Response
Body
|
Object: ResponseEntity<string> |
|
|
errorMessage: string(50) Contains error details |
|
|
successMessage: string(50) Message containing success details |
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/integration/tonnes/V5?api_key=ABC123
Request Body:
Response Body: