Description
Provides a facility to register new Idler Faults into the software.
URL
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: CreateIdlerTagRequest: |
|
|
areaId* - integer |
|
|
frame – string(20) |
|
|
idlerPosition* - string(50) This can be obtained from the spreadsheet attached to this article. Users will need to have knowledge of the idler sets used on the target conveyor/s to be able to select the correct ID from the spreadsheet. |
|
|
idlerLocation* - string(50) The location of the idler fault on the conveyor. The available options can be viewed at Idler Administration>Idler Locations. |
|
|
idlerType - string(50) The type of idler that has the fault. The available options can be viewed at Idler Administration>Idler Types. |
|
|
idlerManufacturer - string(50) The manufacturer of the idler that has the fault. The available options can be viewed at Idler Administration> Idler Manufacturer. |
|
|
idlerFailureType - decimal (18,1) |
|
|
atRisk - boolean If the idler fault is severe enough to risk immanent damage to the belt, it can be marked as At Risk. |
|
|
idlerComment - string(255) Free text limited to 255 characters. Any comments can be added as required. |
|
|
createdDateTime* – string(50) |
|
|
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://api.pdsglobal.com/api/integration/idler/V1?api_key=ABC123
Request Body: