(GET) Idler Failures API

Get idler failure data

Version 1: (V1)

URL

https://api.pdsglobal.com/api/idler/idlerfailures/V1

Description

This URL will allow a customer to request idler failure 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)      replaced

(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, replaced, 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/idler/idlerfailures/V3

Description

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

The optional parameter, replaced, can be null. This will show records that have, and have not been replaced.

The optional parameter, showDeleted, cannot be null. You can only show records that have been deleted, or have not been deleted.

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

(value)   true or false

 

(optional) (If a value is not provided, defaults to false)
(key) showDeleted
(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, replaced, or lastSynced value

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

 

Version 4: (V4)

URL

https://api.pdsglobal.com/api/idler/idlerfailures/V4

Description

This URL will allow a customer to request idler failure information from PDS.

NB: This version exposes the primary keys AreaId and TagId.

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.

The optional parameter, replaced, can be null. This will show records that have, and have not been replaced.

The optional parameter, showDeleted, cannot be null. You can only show records that have been deleted, or have not been deleted.

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

(value)   true or false

 

(optional) (If a value is not provided, defaults to false)

(key) showDeleted

(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, replaced, or lastSynced value

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

 

Version 5: (V5)

URL

https://api.pdsglobal.com/api/idler/idlerfailures/V5

Description

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

The optional parameter, replaced, can be null. This will show records that have, and have not been replaced.

The optional parameter, showDeleted, can be null. This will show records that have, and have not been deleted.

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

(value)   true or false

 

(optional)
(key)       showDeleted
(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, replaced, or lastSynced value

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role.

 

Version 6: (V6)

URL

https://api.pdsglobal.com/api/idler/idlerfailures/V6

Description

This URL will allow a customer to request idler failure information from PDS.

NB: This version exposes the primary keys AreaId and TagId.

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.

The optional parameter, replaced, can be null. This will show records that have, and have not been replaced.

The optional parameter, showDeleted, can be null. This will show records that have, and have not been deleted.

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

(value)   true or false

 

(optional) (If a value is not provided, defaults to false)

(key)     showDeleted

(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, replaced, 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