(GET) Wear Management Tests API

Version 3: (V3)

URL https://api.pdsglobal.com/api/wear/wearmanagementtests/V3
Description This URL will allow a customer to request wear management tests 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 (mandatory)

(value)  Provided separately to this article


(key)     lastSynced (mandatory)

(value)   yyyy-MM-dd HH:mm:ss.sss
             e.g. 2017-01-01 00:00:00.000


(key)     businessName (optional)

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


(key)     businessFunctionalLocation (optional)

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


(key)     groupName (optional)

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


(key)     groupFunctionalLocation (optional)

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


(key)     departmentName (optional)

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


(key)     departmentFunctionalLocation (optional)

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


(key)     areaName (optional)

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


(key)     areaFunctionalLocation (optional)

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


(key)     equipmentType (optional)

(value)  Provided separately to this document


(key)     installed (optional)

(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 1: (V1)

URL https://api.pdsglobal.com/api/wear/wearmanagementtests/V1
Description This URL will allow a customer to request wear management tests 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


(key)     businessName (optional)

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


(key)     businessFunctionalLocation (optional)

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


(key)     groupName (optional)

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


(key)     groupFunctionalLocation (optional)

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


(key)     departmentName (optional)

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


(key)     departmentFunctionalLocation (optional)

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


(key)     areaName (optional)

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


(key)     areaFunctionalLocation (optional)

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


(key)     equipmentType (optional)

(value)  Provided separately to this document


(key)     installed (optional)

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

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

Articles in this section

prev next

Related sections