(POST) Idler Fault API

Description

This API Endpoint will allow a customer to add their idler faults into the PDS software. The faults must be described with the same terminology used for the customer in the PDS software. This terminology is described below.

URL

https://apiprod.pdsglobal.com/V2/api/integration/idler/V1

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

Request

Mandatory Fields are denoted by *

Type

POST

Headers

Content-Type = Application/Json

Parameters

Api_key*
This is required for authentication. If you do not have your API key please contact PDS Support (support@pdsglobal.com).

Body

Object: CreateIdlerTagRequest:

areaId* - int
The area ID 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.

 

Response

After sending through your data, the API call will return a response entity with a body and a status. The response entity will let you know if the data you sent through was successful or unsuccessful.

Status

HTTP Response OK (200)

HTTP Response Bad Request (400)

HTTP Response Forbidden (403)

HTTP Response Unsupported Media Type (415)

HTTP Response Internal Server Error (500)

Body

Object: ResponseEntity
The ResponseEntity object will contain a string or object value. This will have an error or success message – examples below:

- Successfully Created Idler Fault(s)
- Invalid Security Token
- Error Locating Equipment
- Invalid/Incorrect API Key
- Missing Content-Type header
- Error connecting to PDS Server

Examples

Example URL:
https://api.pdsglobal.com/api/integration/idler/V1?api_key=xxx123

Example Body - Multiple Results:

[

{

"areaId":"1",

"frame":”10”,

"idlerPositionId": 10,

"idlerLocation": ”Line”,

"idlerType": “Steel”,

"idlerManufacturer": “PDS”,        (optional)

"idlerFailureType": “Broken”,

"idlerComment": "broken ",        (optional)

"atRisk": false,

“createdDateTime” : “2017-01-01T11:00:00.000”,

“timeZoneOffset” : “+1100”

},

{

"areaId":"1",

"frame":”11”,

"idlerPositionId": 11,

"idlerLocation": ”Line”,

"idlerType": “Steel”,

"idlerManufacturer": “PDS”,        (optional)

"idlerFailureType": “Broken”,

"idlerComment": "broken ",        (optional)

"atRisk": true,

“createdDateTime” : “2017-01-01T11:00:00.000”,

“timeZoneOffset” : “+1100”

}

]

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

Articles in this section

prev next

Related sections