(POST) Wear Measurement

Description

This API Endpoint will allow a customer to add their wear data into the PDS software.

URL

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

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

Request

Mandatory Fields are denoted by *

Type

POST

Headers

Content-Type = Application/Json

Parameters

Api_key*
This is required for authentication. If you do not have your API key please contact PDS Support (support@pdsglobal.com).

Body

Object: CreateWearRequest:

equipmentIdentifier*

An object containing the primary key identifying the equipment being measured. The primary key can be specified by use of one of the properties of the object: equipmentID, equipmentFunctionalLocation or externalEquipmentID.

Examples:
    • “equipmentIdentifier":{"equipmentID" : 7227} or
    • “equipmentIdentifier":{" equipmentFunctionalLocation " : “ABC-123”} or
    • “equipmentIdentifier":{" externalEquipmentID " : “ABC123”}.

The values passed must relate to existing equipment in the PDS system. EquipmentID can be found on the Equipment Dashboard in Asset by scrolling to the right. Equipment Functional Location and External Equipment ID can be found on the Asset’s edit page.

wearSurfaceType* - string(50)
The type of wear surface being measured. Values can be obtained from the Wear Surface Types dialog
wearMeasurementType* - string(50)
The type of wear measurement being performed. Values can be obtained from the Wear Measurement Types dialog.
inspectedBy - string(50)
Free text limited to 50 characters. InspectedBy should be who or what inspected the wear measurement. Generally this will be the username or email address of the user.
instrumentType - string(50)
Free text limited to 50 characters. Instrument type should be the name of the instrument used to take the wear measurement.
instrumentVelocity - decimal (18,1)
Decimal value limited to 1 decimal place. The velocity setting as shown on the thickness testing unit (as recorded in instrumentType).
callibrationThickness - decimal (18,1)
Decimal value limited to 1 decimal Place. Calibration thickness used on the thickness testing unit in millimetres.
surfaceTemperature - decimal (18,1)
Decimal value limited to 1 decimal place. The temperature of the surface being measured.
testPosition - string (50)
Free text limited to 50 characters. The position on the equipment where the wear measurement is taking place.
comments - string (500)
Free text limited to 500 characters. Any comments can be added as required.
hardness - int
Whole number. A hardness measurement can be recorded for the belt section.

wearMeasurementResults* - List<WearMeasurementResult>
This is a list containing the wear measurement results.

x, y* - int
Whole number. X and Y represent the coordinates for the location of the measurement on the equipment. X represents the location across the width of the equipment, and Y represents the location along the length.
result* - decimal (18,2)
Decimal value limited to 2 decimal places. The thickness measurement at point x, y.

 

Response

After sending through your data, the API call will return a response entity with a body and a status. The response entity will let you know if the data you sent through was successful or unsuccessful.

Status

200 - HTTP Response OK
400 - HTTP Response Bad Request
403 - HTTP Response Forbidden
415 - HTTP Response Unsupported Media Type
500 - HTTP Response Internal Server Error

Body

Object: ResponseEntity
The ResponseEntity object will contain a string or object value. This will have an error or success message – examples below:

- Successfully Created Wear Measurement and Wear Measurement Results
- Invalid Security Token
- Error Locating Equipment
- Invalid/Incorrect API Key
- Missing Content-Type header
- Error connecting to PDS Server

Examples

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

Example Body - Multiple Results:

[

{

"equipmentIdentifier": {

"equipmentID" : 277361

},

"wearSurfaceType": "Top",

"wearMeasurementType": "Thickness",


"inspectedBy": "example@pdsglobal.com",

"instrumentType": "DMS GO",

"instrumentVelocity": 1536,

"calibrationThickness": 23.9,

"surfaceTemperature": 35,

"hardness": 11,

"testPosition": "left",

"wearMeasurementResults": [

{

"x": 10,

"y": 1,

"result": 20

},

{

"x": 20,

"y": 1,

"result": 20

},

{

"x": 30,

"y": 1,

"result": 20

}

]

},

{

"equipmentIdentifier": {

"equipmentID" : 277361

},

"wearSurfaceType": "Top",

"wearMeasurementType": "Thickness",


"inspectedBy": "example@pdsglobal.com",

"instrumentType": "DMS GO",

"instrumentVelocity": 1536,

"calibrationThickness": 23.9,

"surfaceTemperature": 35,

"hardness": 11,

"testPosition": "right",

"wearMeasurementResults": [

{

"x": 10,

"y": 1,

"result":15

},

{

"x": 20,

"y": 1,

"result": 15

},

{

"x": 30,

"y": 1,

"result": 15

}

]

}

]

 

 

 

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

Articles in this section

prev next

Related sections