(GET) Wear Management Tests Minimum

Description

This API Endpoint supplies all wear tests carried out on equipment, along with the minimum measurement (per partition) taken during each test.

The endpoint supplies data for belts, liners, and screen panels.

 

URL

https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementtestsminimum/V1

Note: There are two non-production environments that can be used for testing.

 


Request

Mandatory Fields are denoted by *

Type

GET

Headers

No header is required for this API Endpoint.

Parameters

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.

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.

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

installed: boolean
Indicates whether the equipment is currently installed.

lastSynced: DateTime
Used to retrieve only the records which have 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.

rowVersion: string(50)
Used to retrieve only the records which have changed since the last call to the endpoint. On first call of the endpoint leave blank - this will return all records, and will also return the current 'maxRowVersion'. Store the maxRowVersion after every call and pass it in the rowVersion parameter to retrieve only records which have changed since that rowVersion.

Note that rowVersion takes precedence over lastSynced as it provides more accuracy.

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

businessId: integer

This is the unique identifier (primary key) for the business. This can be obtained from the hierarchy 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.

groupSortOrder: integer

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

groupId: integer

This is the unique identifier (primary key) for the group. This can be obtained from the hierarchy 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.

departmentSortOrder: integer

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

departmentId: integer

This is the unique identifier (primary key) for the department. This can be obtained from the hierarchy 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.

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.

sortOrder: integer

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.

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

wearSurface: string(50)

The type of wear surface as specified in the Wear Surface Type dialog.

wearMeasurementType: string(50)

The type of wear measurement as specified in the Wear Measurement Type dialog.

partition: string(50)

Identifies a section of equipment which is broken down into partitions. Examples are left, centre, and right partitions of a belt section.

minimumResult: decimal

The minimum recorded wear test for the related partition.

testDate: DateTime

Indicates the time the test was performed.

testId: integer

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

testedBy: string(50)

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

testComments: string(255)

Comments entered by user when performing a test. Free text.

lastSavedBy: string(50)

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

lastSavedDateTime: DateTime

Indicates the last time the record was updated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

rowVersion: string(50)

Incrementing marker which indicates when the record has changed.

lastPage: integer

Indicates the page number of the last page when a paged endpoint is called. 

maxRowVersion: string(50)

Marker used to identify the last updated record in the recordset.

 

Response Status Code

See HTTP Response Codes and Errors

 


Examples

URL:
https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementtestsminimum/V1?api_key=xxx123

 

Response Body

{
    "changedRecords": [
        {           
            "businessName""Mine Operations",
            "businessFunctionalLocation"null,
            "businessSortOrder"1,
            "businessId"1,
            "groupName""Raw Coal",
            "groupFunctionalLocation"null,
            "groupSortOrder"1,
            "groupId"1,
            "departmentName""Transfer Chutes",
            "departmentFunctionalLocation"null,
            "departmentSortOrder"2,
            "departmentId"2,
            "areaName""TC01 Deflector",
            "areaFunctionalLocation"null,
            "areaSortOrder"1,
            "areaType"null,
            "areaId"3,
            "sortOrder"2,
            "equipmentTypeName""Liners",
            "equipmentId"707,
            "installed"false,
            "installDate""2015-02-03T11:00:00.000Z",
            "wearSurface""Top of Liner",
            "wearMeasurementType""Thickness",
            "partition"null,
            "minimumResult"20.0,
            "testDate""2015-05-11T21:09:55.000Z",
            "testId"5,
            "testedBy""demo@pdsonline.com.au",
            "testComments"null,
            "lastSavedBy""demo@pdsonline.com.au",
            "lastSavedDateTime""2017-03-15T00:12:16.170Z",
            "rowVersion""0000000000B8E153"
        },
        {
            "businessName""Mine Operations",
            "businessFunctionalLocation"null,
            "businessSortOrder"1,
            "businessId"1,
            "groupName""Raw Coal",
            "groupFunctionalLocation"null,
            "groupSortOrder"1,
            "groupId"1,
            "departmentName""Transfer Chutes",
            "departmentFunctionalLocation"null,
            "departmentSortOrder"2,
            "departmentId"2,
            "areaName""TC01 Deflector",
            "areaFunctionalLocation"null,
            "areaSortOrder"1,
            "areaType"null,
            "areaId"3,
            "sortOrder"8,
            "equipmentTypeName""Liners",
            "equipmentId"713,
            "installed"false,
            "installDate""2015-02-03T11:00:00.000Z",
            "wearSurface""Top of Liner",
            "wearMeasurementType""Thickness",
            "partition"null,
            "minimumResult"20.0,
            "testDate""2015-05-11T21:09:55.000Z",
            "testId"6,
            "testedBy""demo@pdsonline.com.au",
            "testComments"null,
            "lastSavedBy""demo@pdsonline.com.au",
            "lastSavedDateTime""2017-03-15T00:12:16.170Z",
            "rowVersion""0000000000B8E154" 
        }
    ],
    "lastPage"0,
    "rowVersion""000000065097D4F9"
}

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

Articles in this section

prev next

Related sections