(GET) Wear Management API

Get wear management data

Version 1: (V1)

URL

https://api.pdsglobal.com/api/wear/wearmanagement/V1

Description

This URL will allow a customer to request wear management 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

 

(optional)

(key)      businessFunctionalLocation

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

 

(optional)

(key)      groupName

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

 

(optional)

(key)      groupFunctionalLocation

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

 

(optional)

(key)      departmentName

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

 

(optional)

(key)      departmentFunctionalLocation

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

 

(optional)

(key)      areaName

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

 

(optional)

(key)      areaFunctionalLocation

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

 

(optional)

(key)      equipmentType

(value)   Provided separately to this document

 

(optional)

(key)      installed

(value)   true or false

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing API Key

-          Invalid/Incorrect businessName, businessFunctionalLocation, groupName, groupFunctionalLocation, departmentName, departmentFunctionalLocation, areaName, areaFunctionalLocation, equipmentType, installed, or lastSynced value.

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

 

Version 2: (V2)  Internal Use Only

 

Version 3: (V3)

URL

https://api.pdsglobal.com/api/wear/wearmanagement/V3

Description

This URL will allow a customer to request wear management 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.

In this version, the field LastTestId has been changed to TestId.

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

 

(optional)

(key)      businessFunctionalLocation

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

 

(optional)

(key)      groupName

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

 

(optional)

(key)      groupFunctionalLocation

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

 

(optional)

(key)      departmentName

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

 

(optional)

(key)      departmentFunctionalLocation

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

 

(optional)

(key)      areaName

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

 

(optional)

(key)      areaFunctionalLocation

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

 

(optional)

(key)      equipmentType

(value)   Provided separately to this document

 

(optional)

(key)      installed

(value)   true or false

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing API Key

-          Invalid/Incorrect businessName, businessFunctionalLocation, groupName, groupFunctionalLocation, departmentName, departmentFunctionalLocation, areaName, areaFunctionalLocation, equipmentType, installed, or lastSynced value.

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

Version 4: (V4)

URL

https://api.pdsglobal.com/api/wear/wearmanagement/V4

Description

This URL will allow a customer to request wear management information from PDS.

NB: Same as V3 above, but includes the fields Hardness, Current Recent Daily Wear Rate, Current Recent Critical Changeout, Days to Recent Critical Changeout, Previous Recent Daily Wear Rate, Previous Recent Critical Changeout, Days to Previous Recent Critical Changeout. 

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

 

(optional)

(key)      businessFunctionalLocation

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

 

(optional)

(key)      groupName

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

 

(optional)

(key)      groupFunctionalLocation

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

 

(optional)

(key)      departmentName

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

 

(optional)

(key)      departmentFunctionalLocation

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

 

(optional)

(key)      areaName

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

 

(optional)

(key)      areaFunctionalLocation

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

 

(optional)

(key)      equipmentType

(value)   Provided separately to this document

 

(optional)

(key)      installed

(value)   true or false

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing API Key

-          Invalid/Incorrect businessName, businessFunctionalLocation, groupName, groupFunctionalLocation, departmentName, departmentFunctionalLocation, areaName, areaFunctionalLocation, equipmentType, installed, or lastSynced value.

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

z

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

Articles in this section

prev next

Related sections