(POST) DXF file for Liners 

Description

This API Endpoint will allow the user to create or overwrite a complex layout for liners 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 liner settings, meaning all liners in the layout will have the same attributes (thickness, dimensions, part number, etc). The attributes for the individual liners 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 attempted.

URL

https://apiprod.pdsglobal.com/V2/api/common/equipmentlinertype/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. 

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: liner

materialTypeName* - string(50)
Describes the material from which the liner is manufactured.  This is configured by going to Complex Administration>Liner Material Types.

thickness* – int 
Thickness of the liner in mm.

width – int
Width of the liner in mm.

height – int 
Height of the liner in mm.

backingMaterialName – string(50) 
A description of the backing material used on the liner. These are configured by going to Complex Administration>Liner Backings.

backingThickness– int 
Thickness in mm of the backing material described above.

fixingTypeName - string(50)
The method by which the liner is fixed to the chute. These are configured by going to Complex Administration>Liner Fixing Types.

fixingName - string(50)
These are configured by going to Complex Administration>Liner Fixings.

manufacturerName - string(50)
Can be added if required. Manufacturers are configured by going to Complex Administration>Liner Manufacturers.

wearPackName - string(50)
A wear pack can be added if configured. A wear pack is generally a group of liners located together of the same specification. Packs are configured by going to Complex Administration>Liner Wear Packs.

partNumber - string(50)
A part number can be added for the liner to assist with managing replacements. Free text.

documentLink - string(50)
Allows a link to be added for a reference document. Free text.

markingPlan - string(50)
Allows a reference (number or other reference) to added for a marking plan relevant to the chute depicted in the DXF. Free text.
detailDrawing - string(50)
Allows a reference (number or other reference) to added for a detailed technical drawing relevant to the chute depicted in the DXF. 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.

installationWorkOrder - string(50)
Allows the addition of a workorder number if required. Free text.

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. 

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

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

removalWorkOrder
Allows users to add a workorder number for the expected removal of the product.

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
- Thickness is required
- MaterialType is required
403 - HTTP Response Forbidden
- Invalid/Incorrect API Key
- Non “API User” role
415 - HTTP Response Unsupported Media Type
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 Wear Measurement and Wear Measurement Results
- Successfully Created /Updated Complex Equipment Liner
- 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
- MaterialType is required
- Thickness 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/equipmentlinertype/dxf/V1?api_key=xxx123

Request Example Body

{"materialTypeName":"Ceramic", 

    "thickness" :50, 

    "width":300, 

    "height":300, 

    "backingMaterialName":"Rubber", 

    "backingThicknesss":12, 

    "fixingTypeName":"Bolt", 

    "fixingName":"M20",

    "partNumber ":"110451", 

    "manufacturerName":"Imatech", 

    "wearPackName":"Wear Pack D", 

    "documentLink ":"https://support.pdsglobal.com", 

    "markingPlan":"000-L-102433", 

    "detailDrawing":"000-D-26754", 

    “overwriteLayout” : false, 

"comments":"Default liner for all chutes."} 

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

Articles in this section

prev next

Related sections