(GET) Idler Failures Life Calculation API

Get idler failure life calculation data

Version 1: (V1)

URL

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

Description

This URL will allow a customer to request idler failures life calculation information from PDS.

Type

GET

URL Parameters

(1)

(key)      api_key

(value)   Provided separately to this document

 

(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)     daysBetweenFailures

(value)  operator followed by an integer. There can be a space between the operator and the integer, but it is not necessary.

             e.g. >10, <20, >= 30, etc.

 

(optional but must be paired with maxDaysBetweenFailures)

(key)     minDaysBetweenFailures

(value)   an integer value. The operator >= is already included.

 

(optional but must be paired with minDaysBetweenFailures)

(key)     maxDaysBetweenFailures

(value)   an integer value. The operator <= is already included.

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing API Key

-          Invalid/Incorrect businessName, businessFunctionalLocation, groupName, groupFunctionalLocation, departmentName, departmentFunctionalLocation, areaName, areaFunctionalLocation, daysBetweenFailures, minDaysBetweenFailures, or maxDaysBetweenFailures 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