(POST) Wear Measurement API

Add Wear data (V1)

 

URL

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

Description

This URL will allow a customer to add their wear and wear results data into the PDS software in real-time.

The wearSurfaceType field is the name of the type of wear surface being measured.

The wearMeasurementType field is the name of the type of wear measurement being done.

The equipment field is the name of the equipment/asset that the wear measurement is being done on.

The inspectedBy and testDate fields are the username of the user conducting the wear measurement and the date and time it is being conducted.

The isValid field is either true or false and represents whether the entire test is valid or not, and whether it will or will not be included in the forecast.

The instrumentType field is the name of the instrument used for taking the measurement.

The instrumentVelocity field is the velocity setting as shown on the thickness testing unit.

The calibrationThickness field is what you are calibrating your thickness tester to in millimetres.

The surfaceTemperature field is the temperature of the surface being measured.

wearMeasurementResults is an array of results. You can tell this as the results data is encapsulated in square brackets [ ].  

The X and Y fields represent the location of the measurement. For instance, X can represent the location across the width of a conveyor belt, whereas Y would represent the location across the length of a conveyor belt (e.g. Before the splice Y = 1, and after the splice Y = 2).

The Result field is the result of the measurement.

The isInvalid field can either be true or false and represents that the result will not be included in the forecast.

A single result would look like this { result data } . To add more results, just follow with a comma and a new { } e.g. { result1 }, { result2 }, { result3 }

Type

POST

URL Parameters

(1)

(key)      api_key

(value) Provided separately to this document

Headers (1)

(key)     Content-Type

(value)  application/json

 

Request Data

(single result)

 

   "wearSurfaceType": "Top",

   "wearMeasurementType": "Thickness",

   "equipment": "170922-SCRP-025329",

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

   "testDate": "2017-01-01 00:00:00.000",

   "isValid": true,

   "instrumentType": “Ultra-sonic thickness tester”,

   "instrumentVelocity": 12.3,

   "calibrationThickness": 45.6,

   "surfaceTemperature": 78.9,

  

   "wearMeasurementResults": [ 

      { 

        "x": 1,

        "y": 1,

        "result": 20,

        "isInvalid": false

      }

   ]

}

Request Data

(multiple results)

   "wearSurfaceType": "Top",

   "wearMeasurementType": "Thickness",

   "equipment": "170922-SCRP-025329",

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

   "testDate": "2017-01-01 00:00:00.000",

   "isValid": true,

   "instrumentType": “Ultra-sonic thickness tester”,

   "instrumentVelocity": 12.3,

   "calibrationThickness": 45.6,

   "surfaceTemperature": 78.9,

  

   "wearMeasurementResults": [ 

      { 

        "x": 100,

        "y": 1,

        "result": 22,

        "isInvalid": false

      },

      { 

        "x": 200,

        "y": 1,

        "result": 21.9,

        "isInvalid": false

      }

   ]

}

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing api_key parameter

-          Incorrect/Invalid field value except testDate

-          Invalid JSON syntax

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key

-          Non “API User” role

HTTP Response Unsupported Media Type (415)

-          Missing Content-Type header

HTTP Response Internal Server Error (500)

-          Invalid testDate format

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

Articles in this section

prev next

Related sections