(POST) Idler Fault API


Provides a facility to register new Idler Faults into the software.  




Note: There are two non-production environments that can be used for testing.







Content-Type = Application/Json


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).



Object: CreateIdlerTagRequest:

areaId* - integer
This is the unique identifier (primary key) for the area. It can be obtained using the Area Details API

frame – string(20)
The frame number you are recording the fault on. The frame string value accepts integer and decimal for frame number.

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)
The type of fault (failure) being recorded. The available options can be viewed at Idler Administration>Idler Fault Type.

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)
The creation date and time to be recorded for the fault.

timeZoneOffset* - string(7)
The timezone offset from UTC DateTime. It effects createdDateTime and converts it to UTC.






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






Request Body:

        "idlerPosition""3 Roll Trough - LHS",
        "idlerFailureType""Bearing Noisy",
        "idlerComment""broken ",
        "createdDateTime""2017-01-01 11:00:00.000",
        "idlerPosition""3 Roll Trough - Centre",
        "idlerFailureType""Bearing Noisy",
        "idlerComment""broken ",
        "createdDateTime""2017-01-01 11:00:00.000",
Response Body:
    "successMessage""Successfully Created Idler Fault(s)"

prev next
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

prev next

Related sections