Description
Supplies a summary of Idler fault information for a given business. An example is the total number of Idlers currently in failure.
URL
https://apiprod.pdsglobal.com/V2/api/idler/idlerfailuresbybusiness/V2
Note: There are two non-production environments that can be used for testing.
Request
Type
GET
Headers
No header is required for this API Endpoint.
Parameters
Mandatory parameters are denoted by *
*
api_key: string(50)
This is required for authentication. It is used to identify the user and determine access to the system. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
businessName: string(50)
The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
businessFunctionalLocation: string(50)
Unique code used to identify the business. Can be obtained from the business edit dialog in the software, or the Area Details API.
page: integer Large datasets are broken down into pages with 2000 records per page. Use the page parameter to specify which page of the paged dataset to retrieve. Note that this number cannot be greater than the lastPage value returned by the first call to the endpoint.
0 is the starting page. For example if there was a total of 3517 records for the last 6 months, then page 0 will show 1 - 2000 records, and page 1 will show the remaining 1517 records.
lastPage: integer
When a paged endpoint is called, it calculates the number of records it will return, then calculates the number of pages required.
This is an intensive operation which affects the performance of the endpoint. After calling the endpoint the first time the lastPage value is returned in the result. By passing that value in to the lastPage parameter on subsequent calls the service will know not to recalculate the number of pages.
Body
No body is required for this API Endpoint.
Response
Body
| Object: ResponseEntity<string> |
|
changedRecords[]
List of records returned by the call.
|
|
businessName: string(50)
The name of the business as recorded in the hierarchy.
|
|
businessFunctionalLocation: string(50)
Unique code used to identify the business. Can be obtained from the business edit dialog in the software, or the Area Details API.
|
|
businessSortOrder: integer
All businesses have a sort order number assigned to them. It determines the sequence of the business.
|
|
totalConveyors: integer
The total number of conveyors within the business.
|
|
totalFrames: integer
The total number of frames within the business.
|
|
totalTagged: integer
The total number of Idler Failures recorded within the business.
|
|
totalTaggedOnPDA: integer
No longer used.
|
|
totalReplaced: integer
The total number of Idlers which have been replaced within the business.
|
|
totalInFailure: integer
The number of Idler Failures which have not been replaced.
|
|
averageFailuresPerConveyor: integer
The average number of Idler Failures across all conveyors.
|
|
averageFailuresPerDayInUse: integer
The total number of Idler Failures divided by the total number of days since the first failure was recorded.
|
|
daysInUse: integer
The total number of days since the first Idler Failure was recorded.
|
|
taggedOnPDALast30Days: integer
No longer used.
|
|
taggedLast30Days: integer
The total number of Idler Failures recorded in the last 30 days.
|
|
taggedLast90Days: integer
The total number of Idler Failures recorded in the last 90 days.
|
|
taggedLast180Days: integer
The total number of Idler Failures recorded in the last 180 days.
|
|
taggedLast365Days: integer
The total number of Idler Failures recorded in the last 365 days.
|
|
replacedLast30Days: integer
The total number of Idlers replaced in the last 30 days.
|
|
replacedLast90Days: integer
The total number of Idlers replaced in the last 90 days.
|
|
replacedLast180Days: integer
The total number of Idlers replaced in the last 180 days.
|
|
replacedLast365Days: integer
The total number of Idlers replaced in the last 365 days.
|
|
|
lastPage: integer
Indicates the page number of the last page when a paged endpoint is called.
|
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/idler/idlerfailuresbybusiness/V2?api_key=ABC123
Response Body:
{
"changedRecords": [
{
"database": "TESTING",
"businessName": "Mine Operations",
"businessFunctionalLocation": null,
"businessSortOrder": 1,
"totalConveyors": 125,
"totalFrames": null,
"totalTagged": 851,
"totalTaggedOnPDA": 0,
"totalReplaced": 791,
"totalInFailure": 60,
"averageFailuresPerConveyor": 6,
"averageFailuresPerDayInUse": 0,
"daysInUse": 1904,
"taggedOnPDALast30Days": 0,
"taggedLast30Days": 0,
"taggedLast90Days": 86,
"taggedLast180Days": 133,
"taggedLast365Days": 179,
"replacedLast30Days": 0,
"replacedLast90Days": 475,
"replacedLast180Days": 479,
"replacedLast365Days": 496
}
],
"lastPage": 0
}
