(GET) Wear Management Belts API

Description

Supplies data on wear, specifically for conveyor belts. As well as providing wear information, this API provides belt specific information, such as belt specification, skirt width, and grade for example.

 

Note that the use of the lastSynced parameter relates to wear data. This means the API will return wear data which has changed since that date. 

 

URL

https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementbelts/V5

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).

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.

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.

groupName: string(50) The name of the group as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

groupFunctionalLocation: string(50) Unique code used to identify the group. Can be obtained from the group edit dialog in the software, or the Area Details API.

departmentName: string(50) The name of the department as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

departmentFunctionalLocation: string(50) Unique code used to identify the department. Can be obtained from the department edit dialog in the software, or the Area Details API.

areaName: string(50) The name of the area as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

areaFunctionalLocation: string(50) Unique code used to identify the area. Can be obtained from the area edit dialog, or the Area Details API.

equipmentType: string(50) The type of equipment as specified in the Equipment Type dialog.

installed: boolean Returns records based on their install status. Set to true to return equipment which is currently installed. Set to false to return equipment which is not installed. Set to null to return both.

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.

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 header 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.

groupName: string(50)

The name of the group as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

groupFunctionalLocation: string(50)

Unique code used to identify the group. Can be obtained from the group edit dialog in the software, or the Area Details API.

groupSortOrder: integer

All groups have a sort order number assigned to them. It determines the sequence of the group.

departmentName: string(50)

The name of the department as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

departmentFunctionalLocation: string(50)

Unique code used to identify the department. Can be obtained from the department edit dialog in the software, or the Area Details API.

departmentSortOrder: integer

All departments have a sort order number assigned to them. It determines the sequence of the department.

areaName: string(50)

The name of the area as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

areaFunctionalLocation: string(50)

Unique code used to identify the area. Can be obtained from the area edit dialog, or the Area Details API.

areaSortOrder: integer

All areas have a sort order number assigned to them. It determines the sequence of the area.

areaType: string(50)

Defines the general equipment type for the area, such as Transfer Chute or Screens. This is configured in the Area Types dialog.

areaId: integer

This is the unique identifier (primary key) for the area. This can be obtained from the hierarchy or the Area Details API.

hash: integer

Sometimes referred to as SortOrder. All items of equipment have a sort order number assigned to them. It identifies them as an individual item within an area, and for some equipment it determines the sequence of the item.

equipmentType: string(50)

The type of equipment as specified in the Equipment Type dialog.

equipmentId: integer

This is the unique identifier (primary key) for the equipment.

fullSpecification: string(350)

The specification recorded against the belt section, with additional size, cover, and grade information.

specification: string(255)

The specification recorded against the belt section. 

width: decimal(18,3)

The width of the belt section in the relevant Unit of Measurement.

skirtWidth: decimal(18,3)

The width of the skirt in the relevant Unit of Measurement.

topCover: decimal(18,3)

The thickness of the top cover in the relevant Unit of Measurement.

bottomCover: decimal(18,3)

The thickness of the bottom cover in the relevant Unit of Measurement.

grade: string(50)

The belt grade. Free text.

length: decimal(18,3)

The length of the belt section in the relevant Unit of Measurement.

breakerFabric: boolean

Used to indicate if the belt section has a breaker fabric.

sealedEdge: boolean

Used to indicate a sealed edge.

rollNumber: string(50)

The roll number of the belt section. Free text.

stationMarkers: string(50)

The station markers printed on the belt section. Free text.

manufactureDate: DateTime

The date of manufacture for the equipment.

manufacturer: string(50)

The name of the manufacturer as configured in the Belt Manufacturer dialog.

installed: boolean

Indicates whether the equipment is currently installed.

installDate: DateTime

The date the equipment was installed. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

originalDate: DateTime

The original date when the wear rate was calculated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

partNumber: string(50)

Unique code used for ordering the equipment. Free text.

leadTime: integer

The number of days required to order the part. 

replacementInterval: integer

The number of days the equipment is expected to last before replacement.

scheduledCOutDate: DateTime

The date on which the equipment is scheduled to be changed out (replaced).

scheduledShut: string(50)

The shutdown which the equipment has been allocated to for change out.

removalDate: DateTime

The date on which the equipment was removed.

lastTestDate: DateTime

The last date a wear measurement was taken for this equipment.

lastTestMinimum: decimal

The smallest measurement recorded during the last test.

lastTestId: integer

The primary key for the last Wear Measurement test performed on this equipment.

wearSurface: string(50)

The name of the wear surface which was tested (e.g. 'Top').

wearMeasurementType: string(50)

The name of the measurement being performed, such as 'Thickness' or 'Height' for example.

partition: string(50)

The name of the partition which the wear rate calculation is against.

testedBy: string(50)

Identifies the user who performed the test (email address).

workOrderNo: string(50)

The Work Order number for the repair. Free text.

testComments: string(500)

Free text for comments on the wear measurement.

currentLifeDailyWearRate: decimal

Returns the current calculated daily wear rate for this partition.

currentLifeCriticalChangeout: DateTime

Returns the current calculated lifetime critical changeout date for this partition.

daysToLifeCriticalChangeout: integer

Returns the current calculated number of days to the critical lifetime changeout date for this partition.

previousLifeDailyWearRate: decimal

Returns the previous calculated daily wear rate for this partition.

previousLifeCriticalChangeout: DateTime

Returns the previously calculated lifetime critical changeout date for this partition.

daysToPreviousCriticalChangeout: integer

Returns the previously calculated number of days to the previous critical lifetime changeout date for this partition.

criticalAlarm: decimal

Displays the critical alarm setting for the belt section.

severeAlarm: decimal

Displays the severe alarm setting for the belt section.

testsInTrend: integer

Returns the number of test being used in the calculations.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

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/wear/wearmanagementbelts/V5?api_key=ABC123

 

Response Body: 

{
    "changedRecords": [
        {
            "businessName""Mine Operations",
            "businessFunctionalLocation"null,
            "businessSortOrder"1,
            "groupName""Raw Coal",
            "groupFunctionalLocation"null,
            "groupSortOrder"1,
            "departmentName""Conveyors",
            "departmentFunctionalLocation"null,
            "departmentSortOrder"1,
            "areaName""CV102",
            "areaFunctionalLocation"null,
            "areaSortOrder"2,
            "areaType"null,
            "hash"2,
            "equipmentType""Belt Sections",
            "fullSpecification""PN640/4 1200 6.0+2.0 M Grade",
            "specification""PN640/4",
            "width"1200,
            "skirtWidth"200,
            "topCover"6,
            "bottomCover"2,
            "grade""M Grade",
            "length"228,
            "breakerFabric"false,
            "sealedEdge"false,
            "rollNumber"null,
            "stationMarkers"null,
            "manufactureDate"null,
            "manufacturer""Contitech",
            "partNumber"null,
            "leadTime"null,
            "replacementInterval"null,
            "installed"true,
            "installDate""2018-04-17T01:29:06.000Z",
            "originalDate""2020-02-07T00:00:00.000Z",
            "scheduledCOutDate""2020-12-09T13:00:00.000Z",
            "scheduledShut""Shut 1101 - Week 1",
            "removalDate"null,
            "wearSurface""Top",
            "wearMeasurementType""Thickness",
            "partition""LHS",
            "lastTestMinimum"8.0,
            "lastTestDate""2021-07-21T01:29:46.000Z",
            "lastTestId"16426,
            "equipmentId"2814,
            "areaId"8,
            "testedBy"null,
            "workOrderNo"null,
            "testComments"null,
            "currentLifeDailyWearRate"0,
            "currentLifeCriticalChangeout""2023-08-02T00:00:00.000Z",
            "daysToLifeCriticalChangeout"561,
            "previousLifeDailyWearRate"null,
            "previousLifeCriticalChangeout"null,
            "daysToPreviousCriticalChangeout"null,
            "criticalAlarm"1,
            "severeAlarm"2,
            "testsInTrend"3,
            "lastSavedBy""Test2@pdsglobal.com",
            "lastSavedDateTime""2021-07-21T01:29:50.257Z"
        }
    ],
    "lastPage"0
}

 

 

prev next
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

prev next

Related sections