(GET) Belt Joints API

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.