(GET) Equipment Screen Panel API 

Description

This API Endpoint will allow a customer to get the Complex Equipment Screen Panels on an existing hierarchy within the PDS Software

URL

https://apiprod.pdsglobal.com/V2/api/equipment/screenpanel/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* - string(50)
Obtained from the hierarchy as shown in the PDS software. 

groupName* - string(50)
Obtained from the hierarchy as shown in the PDS software.

departmentName* - string(50)
Obtained from the hierarchy as shown in the PDS software.

areaName* - string(50)
Obtained from the hierarchy as shown in the PDS software.

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 calling this endpoint, the API call will return a response entity with a body and a status. The response entity will display the data for Business, Group, Department and Area if successful.

Status

200 - HTTP Response OK 

400 - HTTP Response Bad Request 
 
-          Invalid Security Token 

-     Missing API Key   
-          businessName/groupName/departmentName/areaName 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 ScreenPanel Records 

-  Missing API Key 

- businessName/groupName/departmentName/areaName is not provided 

- Invalid User Token 

- Non “API User” role. 

Examples

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

Example of Successful Response Entity:

[ 

    { 

        "screenPanelItemNumber": null, 

        "rowLabel": null, 

        "columnLabel": null, 

        "screenPanelTypeName": "Aperture", 

        "screenPanelMaterialTypeName": "MAT", 

        "screenPanelManufacturerName": "MFG", 

        "screenPanelFixingTypeName": "Weide 3 Groove", 

        "width": 600, 

        "length": 600, 

        "thickness": 40, 

        "apertureLength": 100, 

        "apertureWidth": 50, 

        "apertureStyle": "Square", 

        "orientation": "SWF", 

        "wireProfile": "#130", 

        "surfaceTreatment": "Hard Chrome Finish", 

        "deflector": null, 

        "feature": "50mm HIgh Dam RH", 

        "openArea": 15, 

        "equipmentId": 24325, 

        "name": "210224-SCPN-024325", 

        "isInstalled": false, 

        "functionalLocation": null, 

        "comments": "Cicci did this", 

        "url": null, 

        "partNumber": "EG1234", 

        "installedDate": "2021-02-24T02:57:54.763Z", 

        "installWONumber": null, 

          "leadTime": null, 

        "replacementInterval": null, 

        "originalSize": null, 

        "partitionSize": null, 

        "timeToReplace": null 
 
 
Note: For "thickness", "width", “length” , 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