(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 results data into the PDS software in real-time.

Mandatory fields are denoted by *.

equipmentIdentifier* – a container for the primary key. The options here are equipmentID, equipmentFunctionalLocation and externalEquipmentID. Only one identifier should be used as follows:
“equipmentIdentifier":{"equipmentID" : 7227}
or “equipmentIdentifier":{" equipmentFunctionalLocation " : “ABC-123”}
or “equipmentIdentifier":{" externalEquipmentID " : “ABC123”}.

Any one of the three can be used but must already be stored in the PDS database.  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*  - the type of wear surface being measured. The values for belt sections are “Top” and “Bottom”.  Values for other surfaces can be obtained from the Wear Surface Types table (Business Admin access required).

wearMeasurementType*  - type of wear measurement being done. The only one currently used for belt sections is “Thickness”. Values for other surfaces can be obtained from the Wear Measurement Types table (Business Admin access required).

inspectedBy - username of the user conducting the wear measurement

instrumentType  - the type of the instrument used for taking the measurement. An example would be DMS Go.

instrumentVelocity - the velocity setting as shown on the thickness testing unit (as recorded in instrumentType). 

calibrationThickness - calibration thickness used on the thickness testing unit in millimetres.

surfaceTemperature -  the temperature of the surface being measured. Typically the temperature of the belt measured in Celsius.

comments – comments can be added as required, with a character limit of 500.

hardness – A hardness measurement to be recorded for the belt section.

wearMeasurementResults is an array of results encapsulated in square brackets [ ].  Multiple results can be created in one POST call.

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

result - the wear measurement result.

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)

  "equipmentIdentifier" : { "equipmentID" : 7227 },
  "wearSurfaceType": "Top",
  "wearMeasurementType": "Thickness",
  "inspectedBy": "example@pdsglobal.com",
  "instrumentType": “DMS GO”,
  "instrumentVelocity": 1536,
  "calibrationThickness": 23.9,
  "surfaceTemperature": 35,
  

   "wearMeasurementResults": [ 

      { 

        "x": 1,

        "y": 1,

        "result": 20,

        "isInvalid": false

      }

   ]

}

Request Data

(multiple results)

   "equipmentIdentifier" : { "equipmentID" : 7227 },
   "wearSurfaceType": "Top",
   "wearMeasurementType": "Thickness",
   "inspectedBy": "example@pdsglobal.com",
   "instrumentType": “DMS GO”,
   "instrumentVelocity": 1536,
   "calibrationThickness": 23.9,
   "surfaceTemperature": 35,

  

   "wearMeasurementResults": [ 

      { 

        "x": 100,

        "y": 1,

        "result": 22,

      },

      { 

        "x": 200,

        "y": 1,

        "result": 21.9,

      }

   ]

}

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing api_key parameter

-          Incorrect/Invalid field value

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

-          Error connecting to PDS Server

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

Articles in this section

prev next

Related sections