Description
Supplies data relating to the belt sections registered in the system.
This API is limited to results recorded in the last 6 months only.
URL
https://apiprod.pdsglobal.com/V2/api/equipment/beltsections/V3
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.
*
lastSynced: DateTime Used to retrieve only the records which have wear tests changed since the last call to the endpoint. On first call of the endpoint leave blank - this will return all records. Store the timestamp after every call and pass it in the lastSynced parameter to retrieve only records which have changed since that time.
The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).
Note that if both rowVersion and lastSynced are populated, rowVersion will take precedence. For some endpoints the lastSynced value is limited to 6 months.
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> |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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/equipment/beltsections/V3?api_key=ABC123
Response Body
{
"changedRecords": [
{
"equipmentId": 37274,
"businessName": "Mine Operations",
"groupName": "Raw Coal",
"departmentName": "Conveyors",
"areaName": "Automation Test",
"areaType": "Conveyors",
"hash": 1,
"equipmentType": "Belt Sections",
"fullSpecification": "100 100 100.0+100.0 ",
"specification": "100",
"width": 100,
"skirtWidth": 100,
"topCover": 100,
"bottomCover": 100,
"grade": null,
"length": null,
"breakerFabric": false,
"sealedEdge": false,
"rollNumber": null,
"stationMarkers": null,
"manufactureDate": null,
"manufacturer": null,
"purchaseDate": null,
"purchaseWO": null,
"installed": true,
"installDate": "2021-09-24T01:21:38.000Z",
"installWO": null,
"life": 24,
"leadTime": null,
"replacementInterval": null,
"functionalLocation": null,
"partNumber": null,
"documentLink": null,
"comments": null,
"cOutComments": null,
"reasonForReplacement": null,
"reference": null,
"lastSavedBy": "Test3@pdsglobal.com",
"lastSavedDate": "2021-09-24T01:21:51.790Z",
"createdBy": "Test3@pdsglobal.com",
"createdDate": "2021-09-24T01:21:51.787Z",
"attachedFiles": null
}],
"lastPage": 0
}