(GET) Generate Work Management – Idlers With Summary Report PDF in JSON

Version 1: (V1)

URL

https://apiprod.pdsglobal.com/api/report/workmanagementidlerswithsummary/V1

Description  

This URL will allow a user to generate a Work Management – Idlers report in byte
array together with pickling list data. Picking list data is showing the
quantity of each part required.

The functionalLocation parameter can either be for business, group, department,
and area that you wish to generate the report for.

The language parameter is the language code for determining the datetime
format of the report (en-AU, en-US, es-ES, etc). 

Only api_key, and functionalLocation are mandatory.

Type

GET

URL Parameters  
(1)

(key)      api_key
(value)   Provided separately to this document

(key)     functionalLocation
(value)  The unique code used to identify either business, group,
department or area

(key)     failurePriorities
(value)  name of valid Failure Priorities. Kindly refer on
Web app's Idler > Settings > Failure Priorities.

(key)     atRiskFailuresOnly
(value)   a boolean or flag that filters the report 
to At risks Idler faults only

(key)     last
(value)   filter report within number of periods

(key)     period
(value)   either year/s, month/s, week/s, day/s or hour/s

(key)     onlyShowAreasWithFailures
(value)   filter report to only show areas with idler faults

(key)     daysInFailure
(value)   filter report to only show faults within number of
days provided

(key)     addPageBreaks
(value)   boolean or flag to add page breaks on reports

(key)     includePhotos
(value)   boolean or flag to show photos

(key)     language
(value)  The language code for determining the datetime format
of the report

Response Data

HTTP Response OK (200)
-         JSON Response Body
         

Object: ResponseEntity<string>

pickingList[]

List of quantity of each part required

partNo: String
unique code for identifying an Idler Configuration
type: String
name of the idler type
dia: String
diameter value
faceWidth: String
faceWidth value
shaft: String
shaft value

af: String

across flats value

numberNeeded: String

count for the parts needed

totalNumberNeeded

sum of numbers needed from the picking list

byteArrayPdfFile[]

pdf report in byte array form.


Example:
  url:https://apiprod.pdsglobal.com/V2/api/report/
workmanagementidlerswithsummary/V1?api_key=
{{api_key}}&functionalLocation=301610CELEMBELT

Response body:

{
"pickingList": [
{
"partNo": "-",
"type": "Composite",
"dia": "-",
"faceWidth": "-",
"shaft": "-",
"af": "-",
"numberNeeded": 2
},
{
"partNo": "-",
"type": "Rubber Impact",
"dia": "-",
"faceWidth": "-",
"shaft": "-",
"af": "-",
"numberNeeded": 4
},
{
"partNo": "-",
"type": "Steel",
"dia": "-",
"faceWidth": "-",
"shaft": "-",
"af": "-",
"numberNeeded": 1
},
{
"partNo": "20633550",
"type": "HDPE",
"dia": "152",
"faceWidth": "315",
"shaft": "30",
"af": "22",
"numberNeeded": 19
},
{
"partNo": "20633551",
"type": "HDPE",
"dia": "152",
"faceWidth": "318",
"shaft": "30",
"af": "14",
"numberNeeded": 11
},
{
"partNo": "20633611",
"type": "HDPE",
"dia": "152",
"faceWidth": "657",
"shaft": "25",
"af": "14",
"numberNeeded": 1
},
{
"partNo": "20947389",
"type": "PU Full Sleeve Impact",
"dia": "159",
"faceWidth": "319",
"shaft": "30",
"af": "22",
"numberNeeded": 34
},
{
"partNo": "40568764",
"type": "Weightometer",
"dia": "152",
"faceWidth": "300",
"shaft": "-",
"af": "-",
"numberNeeded": 3
}
],
"totalNumberNeeded": 75,

"byteArrayPdfFile": [<byte array>]

}


           

HTTP Response Bad Request (400)

-          Missing api_key

-          functionalLocation Parameter value is required.

-          Functional Location is invalid or not existing.

  -          Either last and period must both be null, or both must have a value.
  -          The value for last must be an integer value,
              and period can only be equal to hour/s, day/s, week/s, month/s, or
              year/s

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