(POST) DXF file for Screen Panels

Description

This API Endpoint will allow the user to create or overwrite a complex layout for screens by uploading a DXF file. The API can be called with just the mandatory parameters to create a layout with default settings. The optional fields can be used to specify the default screen settings, meaning all screen panels in the layout will have the same attributes (thickness, dimensions, part number, etc). The attributes for the individual screen panels can then be edited in the PDS software at a later stage.

The Area that the DXF is being imported to will have to be already created in the PDS software before the import is 

URL

https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1

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

Request

Mandatory Fields are denoted by *

Type

POST

Headers

Content-Type = Multipart/Form-data

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.

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.

equipmentTypeName* - string(50)
Defines the equipment type being used in the DXF. Values can be obtained from the Equipment Type dialog

Body

Object: screenpanel

partNumber - string(50)
The part number assigned to the type of panel. This can be obtained by going to Complex Administration>Screen Panels.

screenPanelTypeName  string(50)
Describes the type of screen panel being installed. This can be obtained by going to Complex Administration>Screen Panels. The linear relationship to Part Number should be preserved.

screenPanelFixingTypeName - string(50)
Describes the type of screen panel fixing being used. This can be obtained by going to Complex Administration>Screen Panels. The linear relationship to Part Number should be preserved.

screenPanelMaterialTypeName*  string(50)
Describes the material from which the screen panel is manufactured. Describes the type of screen panel being installed. This can be obtained by going to Complex Administration>Screen Panels. The linear relationship to Part Number should be preserved.

screenPanelManufacturerName  string(50)
Gives the manufacturer of screen panel being installed. This can be obtained by going to Complex Administration>Screen Panels. The linear relationship to Part Number should be preserved.

length – int 
Screen panel length in mm.

width – int 
Screen panel width in mm.

thickness – int 
Screen panel thickness in mm.

openArea - string(50)
The amount of the panel that is not solid, as a percentage. Free text.

apertureLength - decimal(18,2)
The length dimension of the aperture in the screen panel.

apertureWidth - decimal(18,2)
The width dimension of the aperture in the screen panel.

apertureStyle - string(50)
The shape of the apertures in the screen panel. Free text.

wireProfile - string(50)
The profile of the top of the impact surface on the wire used in the screen panel. Free text.

surfaceTreatment - string(50)
The surface treatment applied to the panel material. Free text.

orientation - string(50)
Gives the orientation of the screen panel, either across the flow or with the flow. Free text.

feature - string(50)
Any other features of the screen panel not described in other fields. Free text.
deflector - string(50)
The type of deflector built into the screen panel. Free text.
InstallationDate - dateTime
The time the panel was installed. If not populated, this will default to the date and time the record was sent to PDS.

InsatllationWorkOrder - string(50)
Allows the addition of a work order number if required.

leadTime – int
The time in days required to order replacement panels and have them delivered to site ready for installation.

replacementInterval – int
This is an indication of the life of the panel. It's the time in days that the panel is expected to last.

comments - string(500)
Free text limited to 500 characters. Any comments can be added as required.
OverwriteLayout - Boolean

Determines whether the existing layout gets replaced or updated by the new layout. When there is an existing layout:

            TRUE - all existing records for that area be will deleted and a new layout created.   

            FALSE - the existing layout will be edited. Existing records will remain unless the entity is removed from the layout.
Default value is false. 

Object: dxf_file: 

This is the file containing the layout to be imported. File should be a dxf format and Entities (liners/ screenpanels) should be created as Polyline or LWPolyline.

Text can be added as a non clickable entity.

Polyline and LWPolyline entities can be added as non-clickable (so they can be used for flow direction, arrow pointers, etc) by adding a custom property "non-clickable".

When downloading the DXF from PDS (previously uploaded), the DXF file will contain a PDS number for each entity. The value should be unique when editing it or adding new entities. A duplicate number will cause the upload to fail.

 

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
- Missing API Key
-   Invalid DXF File
- Business is required
- Group is required
- Department is required
- Area is required
- EquipmentType is required

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:
- Successfully Created /Update Complex Equipment Screen Panel
- Missing API Key
- Invalid/Incorrect API Key
- Non “API User” role.
- Invalid DXF File
- Business is required
- Group is required
- Department is required
- Area is required
- EquipmentType is required
- The layout being uploaded is either new or was not downloaded from PDS. To edit, use the downloaded file from API GET or web app. To proceed, set OverwriteLayout=true and try again.

Examples

Example URL:
https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1?api_key=xxx123

Request Example Body

Example Form-Data Request Body:

screenpanel 

 

{"Thickness" :45, 

    "Width":100, 

    "Length":200, 

    "Comments":"Extra information can be added", 

    "WireProfile":"Test", 

    "PartNumber":"EG1234", 

    "ScreenPanelManufacturer":"MFG", 

    "ScreenPanelMaterialType":"MAT", 

    "ScreenPanelType":"SideLiner", 

    "ScreenPanelFixingType":"Snap fit", 

    "MPN":"12234", 

    "ApertureLength":34, 

    "ApertureWidth":55, 

    "ApertureStyle":"cut edge", 

    "Orientation":"Portrait", 

    "ApertureSize":44, 

    "SurfaceTreatment":"treatment", 

    "Deflector":"test deflector", 

    "Feature":"test feature", 

    "backColour":"#FBE870", 

    "fontColour":"#8359A3", 

    “OverwriteLayout” : false, 

    "Description":"Upload test", 

    "OpenArea":23.2} 

   dxf_file: dxf file 

 

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

Articles in this section

prev next

Related sections