(GET) Belt Joints API

Get belt joint equipment data

Version 3: (V3)

URL

https://apiprod.pdsglobal.com/V2/api/equipment/beltjoints/V3

Description

This URL will allow a customer to request belt joint information from PDS.

NB: To limit the amount of data that is returned, two restrictions have been put in place. One is that if a lastSynced value is entered that is older than 6 months, lastSynced will be updated to the DateTime of 6 months ago.

Type

GET

URL Parameters

(1)

(key)      api_key

(value)   Provided separately to this document

 

(key)     lastSynced

(value)  yyyy-MM-dd HH:mm:ss.sss

             e.g. 2017-01-01 00:00:00.000

 

(optional)

(key)      businessName

(value)   Should already be known as per the PDS hierarchy

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing API Key

-          Invalid businessId, or lastSynced value

HTTP Response Forbidden (403)

-          Invalid API Key

-          Non “API User” role.

 

Examples

Example URL:
https://ahttps://apiprod.pdsglobal.com/V2/api/equipment/beltjoints/V3?api_key=xxx123

Example of Successful Response Entity:

{

"changedRecords": [

{

"equipmentId": 37402,

"businessName": "Mine Operations",

"groupName": "Raw Coal",

"departmentName": "Conveyors",

"areaName": "Automation Test",

"areaType": "Conveyors",

"hash": 1,

"equipmentType": "Belt Joints",

"jointType": "Splice",

"jointId": "220001",

"serviceCompany": "SC Sample",

"installed": true,

"installDate": "2021-01-22T09:06:14.000Z",

"installWo": null,

"scheduledCOutDate": null,

"scheduledShut": null,

"removalDate": null,

"removalWo": null,

"life": 269,

"functionalLocation": null,

"comments": "Sample Comment",

"cOutComments": null,

"documentLink": null,

"reference": null,

"lastSavedBy": "Test3@pdsglobal.com",

"LastSavedDate": "2021-09-29T07:42:05.670Z",

"createdBy": "Test3@pdsglobal.com",

"createdDate": "2021-09-29T07:42:05.670Z",

"attachedFiles": null

}],
"lastPage": 0

}

 
Note: The "result" unit of measurement is configured in System Administration > Unit Of Measurements.

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

Articles in this section

prev next

Related sections