Description
Supplies information on all Screen Panel equipment from the Complex module within a certain area, as configured in the hierarchy.
URL
https://apiprod.pdsglobal.com/V2/api/equipment/screenpanels/V1
Note: There are two non-production environments that can be used for testing.
Request
Type
GET
Headers
Content-Type = Application/Json
Parameters
Mandatory parameters are denoted by *
*
api_key: string(50)
This is required for authentication. It is used to identify the user and determine access to the system. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
businessName: string(50)
The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
groupName: string(50)
The name of the group as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
departmentName: string(50)
The name of the department as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
areaName: string(50)
The name of the area as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
lastSynced: DateTime
Used to retrieve only the records which have changed since the last call to the endpoint. On first call of the endpoint leave blank - this will return all records. Store the timestamp after every call and pass it in the lastSynced parameter to retrieve only records which have changed since that time.
The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).
Note that if both rowVersion and lastSynced are populated, rowVersion will take precedence. For some endpoints the lastSynced value is limited to 6 months.
Body
No body is required for this API Endpoint.
Response
Body
|
Object: ResponseEntity<string>
|
|
screenPanels[]
|
|
screenPanelItemNumber: string(50)
The Item Number for the panel as recorded against the equipment.
|
|
rowLabel: string(2)
Label for the row in which the panel resides. Used in conjunction with columnLabel. E.g. 1, 15, etc.
|
|
columnLabel: string(2)
Label for the column in which the panel resides. Used in conjunction with rowLabel. E.g. 'A', 'E'.
|
|
screenPanelTypeName: string(50)
The type of panel. E.g. 'Aperture'
|
|
screenPanelMaterialTypeName: string(50)
The material which the equipment is made from. E.g. 'Polyurethane'.
|
|
screenPanelManufacturerName: string(50)
The name of the manufacturer of the equipment.
|
|
screenPanelFixingTypeName: string(50)
The type of the fixing used for the equipment. E.g. 'WEIDE 3 Groove'.
|
|
width: decimal(18,3)
The width of the equipment in the relevant Unit of Measurement.
|
|
length: decimal(18,3)
The length of the equipment in the relevant Unit of Measurement.
|
|
apertureLength: decimal(18,3)
The aperture Length of the equipment in the relevant Unit of Measurement.
|
|
apertureWidth: decimal(18,3)
The aperture Width of the equipment in the relevant Unit of Measurement.
|
|
apertureStyle: string(50)
The style of aperture being used. E.g. 'CONT'
|
|
thickness: integer
The thickness of the equipment in the relevant Unit of Measurement.
|
|
orientation: string(50)
Indicates the orientation of the equipment. E.g. 'W/F'.
|
|
wireProfile: string(50)
The type of wire used. E.g. 'Poly'.
|
|
surfaceTreatment: string(50)
The type of treatment on the equipment surface. E.g. 'HCF'.
|
|
deflector: string(50)
|
|
feature: string(50)
|
|
openArea: decimal(18,3)
The open area of the equipment in the relevant Unit of Measurement.
|
|
alarmPoint: decimal(18,3)
The Alarm Point is a preconfigured value to which the forecast Changeout date is calculated in the relevant Unit of Measurement. Screen Panel Thickness will get smaller with wear.
|
|
openAreaAlarmPoint: decimal(18,3)
The Alarm Point is a preconfigured value to which the forecast Changeout date is calculated in the relevant Unit of Measurement. Screen Panel Open Area results will get larger with wear.
|
|
apertureLengthAlarmPoint: decimal(18,3)
The Alarm Point is a preconfigured value to which the forecast Changeout date is calculated in the relevant Unit of Measurement. Screen Panel Aperture Length results will get larger with wear.
|
|
apertureWidthAlarmPoint: decimal(18,3)
The Alarm Point is a preconfigured value to which the forecast Changeout date is calculated in the relevant Unit of Measurement. Screen Panel Aperture Width results will get larger with wear.
|
|
equipmentId: int
This is the unique identifier (primary key) for the equipment.
|
|
name: string(50)
The name allocated to the equipment. This is automatically generated.
|
|
isInstalled: boolean
Indicates whether the equipment is currently installed.
|
|
functionalLocation: string(50)
Unique code used to identify the equipment. Free text.
|
|
comments: string(255)
The comments noted against the equipment. Free text.
|
|
url: string(255)
A link for documentation on the equipment.
|
|
partNumber: string(50)
Unique code used for ordering the equipment. Free text.
|
|
installedDate: DateTime
The date the equipment was installed.
|
|
installWONumber: string(50)
The workorder reference/number for the install. Free text.
|
|
removalDate: DateTime
The date on which the equipment was removed.
|
|
removalWONumber: string(50)
The Work Order number associated with the removal of the equipment.
|
|
scheduledRemoval: DateTime
The date the equipment is scheduled to be removed.
|
|
cOutComments: string(255)
Comments entered by user at change out. Free text.
|
|
leadTime: integer
The number of days required to order the part.
|
|
replacementInterval: integer
The number of days the equipment is expected to last before replacement.
|
|
originalSize: decimal(18,3)
Not used.
|
|
partitionSize:decimal(18,3)
Not used.
|
|
rfid:
Not used.
|
|
installedRunHours:
Not used.
|
|
removalRunHours:
Not used.
|
|
actualShutName: string(50)
The shutdown during which the equipment was replaced.
|
|
scheduledShutName: string(50)
The shutdown which the equipment was scheduled to be replaced.
|
|
timeToReplace:
Not used.
|
|
purchasingDate: DateTime
The date the equipment was purchased.
|
|
purchasingOrder: string(50)
The purchase order which the equipment was purchased on.
|
|
purchasingInvoice: string(50)
The invoice which the equipment was purchased on.
|
|
purchasingCost: decimal
The cost of the equipment at time of purchase.
|
|
purchaseCostCentre: string(50)
The cost centre the equipment was allocated to when purchased.
|
|
warrantyExpiryDate: DateTime
The date on which the warranty expires.
|
|
rotatedDate: DateTime
The date when the equipment was rotated.
|
|
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/equipment/screenpanel/V1?api_key=ABC123&businessName=BusinessName&groupName=GroupName&departmentName=DepartmentName&areaName=AreaName
Response Body:
[
{
"screenPanelItemNumber": null,
"rowLabel": null,
"columnLabel": null,
"screenPanelTypeName": "Aperture",
"screenPanelMaterialTypeName": null,
"screenPanelManufacturerName": null,
"screenPanelFixingTypeName": null,
"width": null,
"length": null,
"thickness": null,
"apertureLength": null,
"apertureWidth": null,
"apertureStyle": null,
"orientation": null,
"wireProfile": null,
"surfaceTreatment": null,
"deflector": null,
"feature": null,
"openArea": null,
"equipmentId": 23503,
"name": "210112-SCPN-023503",
"isInstalled": false,
"functionalLocation": null,
"comments": null,
"url": null,
"partNumber": null,
"installedDate": "2021-01-12T22:29:46.000Z",
"installWONumber": null,
"removalDate": null,
"removalWONumber": null,
"scheduledRemoval": null,
"cOutComments": null,
"leadTime": null,
"replacementInterval": null,
"originalSize": null,
"partitionSize": null,
"rfid": null,
"installedRunHours": null,
"removalRunHours": null,
"actualShutName": null,
"scheduledShutName": null,
"timeToReplace": null,
"purchasingDate": null,
"purchasingOrder": null,
"purchasingInvoice": null,
"purchasingCost": null,
"purchaseCostCentre": null,
"warrantyExpiryDate": null,
"rotatedDate": null
