(GET) Equipment Liner Types API 

Description

This API Endpoint will allow a customer to get the Complex Equipment Liner Types from an existing area within the PDS Software, from the hierarchy

URL

https://apiprod.pdsglobal.com/V2/api/equipment/linertypes/V1  

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

Request

Mandatory Fields are denoted by *

Type

GET

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

businessName* 
 Should already be known as per the PDS hierarchy

 groupName * 
Should already be known as per the PDS hierarchy  

departmentName*
Should already be known as per the PDS hierarchy  

areaName*
 Should already be known as per the PDS hierarchy 

lastSynced
Filter records based on date e.g. 2017-01-01 00:00:00.000 

GET Area Details can be used to get the hierarchy details above.

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

-          Invalid Security Token

-          Missing API Key 
-          businessName/groupName/departmentName/areaName/equipmentTypeName is not provided
403 - HTTP Response Forbidden

-          Invalid/Incorrect API Key
-          Non “API User” role.
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:
- Downloaded Equipment Liner Type Records
- Missing API Key
- businessName/groupName/departmentName/areaName/equipmentTypeName is not provided
- Invalid/Incorrect API Key
- Non “API User” role.

Example URL:
https://apiprod.pdsglobal.com/V2/api/equipment/linertypes/V1?api_key=xxx123&businessName=BusinessName&groupName=GroupName&departmentName=DepartmentName&AreaName=AreaName

Example of Successful Response Entity:

[ 

    { 

        "linerItemNumber": null, 

        "linerMaterialTypeName": "Bisalloy", 

        "linerManufacturerName": "Braeken", 

        "linerBackingName": "Rubber", 

        "linerFixingName": "M20", 

        "linerFixingTypeName": "Bolt", 

        "width": 5, 

        "height": 15, 

        "markingPlanDrawing": "marking plan test", 

        "detailDrawing": "DetailDrawing test", 

        "backingThickness": 55, 

        "thickness": 49, 

        "linerWearPackName": "Wear Pack D", 

        "equipmentId": 18371, 

        "name": "200918-LNRS-018371", 

        "isInstalled": false, 

        "functionalLocation": null, 

        "comments": "Cicci did this", 

        "url": "docu link test", 

        "partNumber": "partnum test", 

        "installedDate": "2020-09-18T12:12:24.110Z", 

        "installWONumber": null, 

        "removalDate": null, 

        "removalWONumber": null, 

        "scheduledRemoval": null, 

        "cOutComments": null, 

        "leadTime": null, 

        "replacementInterval": null, 

        "originalSize": null, 

        "partitionSize": null, 

        "timeToReplace": null,     

    }] 
 
Note: For "thickness", "width", “height” , the unit of measurements are configured in System Administration > Unit Of Measurements. 

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

Articles in this section

prev next

Related sections