(GET) Structure Failures API

Description

Supplies all open structure failures, along with details on the structure type and configuration. 

 

URL

https://apiprod.pdsglobal.com/V2/api/idler/structurefailures/V9

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

 


Request

Type

GET

Headers

No header is required for this API Endpoint.

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

*

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.

businessName: string(50) The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

businessFunctionalLocation: string(50) Unique code used to identify the business. Can be obtained from the business edit dialog in the software, 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.

groupFunctionalLocation: string(50) Unique code used to identify the group. Can be obtained from the group edit dialog in the software, 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.

departmentFunctionalLocation: string(50) Unique code used to identify the department. Can be obtained from the department edit dialog in the software, 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.

areaFunctionalLocation: string(50) Unique code used to identify the area. Can be obtained from the area edit dialog, or the Area Details API.

page: integer Large datasets are broken down into pages with 2000 records per page. Use the page parameter to specify which page of the paged dataset to retrieve. Note that this number cannot be greater than the lastPage value returned by the first call to the endpoint.

lastPage: integer When a paged endpoint is called, it calculates the number of records it will return, then calculates the number of pages required.

This is an intensive operation which affects the performance of the endpoint. After calling the endpoint the first time the lastPage value is returned in the result. By passing that value in to the lastPage parameter on subsequent calls the service will know not to recalculate the number of pages.

Body

No body is required for this API Endpoint.

 

 


Response

Body

Object: ResponseEntity<string>

changedRecords[]

List of records returned by the call.

tagId: integer
This is the unique identifier (primary key) for the Structure Failure.

tagNo: string(50)
Used to allocate a reference to the tag. Free text.

areaId: integer
This is the unique identifier (primary key) for the area. It can be referenced using the Area Details API

frame: decimal
The frame number where the fault is located.

ct: string(20)
Indicates the cut-through. Free text.

other1: string(20)
Additional field.

other2: string(20)
Additional field.

 

structureType[]

structureTypeId: integer

This is the unique identifier (primary key) for the Structure Type.

name: string(50)

The name of the Structure Type. For example 'Return Tracking Frame'.

businessId: string(50)

This is the unique identifier (primary key) for the business where the equipment is located.

sortOrder: string(50)

Determines the sequence of the Structure Type.

isActive: integer

Indicates whether the Idler Type is currently active/enabled.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

createdBy: string(50)

Identifies the user who created the record (email address). 

createdDate: DateTime

Indicates the date and time the record was created. 

 

 

structureFailureType[]

structureFailureTypeId: integer

This is the unique identifier (primary key) for the Structure Failure Type.

name: string(50)

The name of the Structure Failure Type. For example 'Corroded'.

priorityId: integer

This is the unique identifier (primary key) for the Structure Failure Type Priority.

priority: string(50)

The name of the priority level selected.

businessId: integer

This is the unique identifier (primary key) for the business where the Failure Type is configured.

sortOrder: integer

Determines the sequence of the Failure Type.

isActive: boolean

Indicates whether the Failure Type is currently active/enabled.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

createdBy: string(50)

Identifies the user who created the record (email address).

createdDate: DateTime

Indicates the date and time the record was created. 

 

structureFailureTypePriority[]

priorityId: integer

This is the unique identifier (primary key) for the Failure Type Priority.

name: string(50)

The name of the Failure Type Priority. For example 'MONITOR - Ongoing'.

backColour: string(50)

The back colour which should show for this type.

fontColour: string(50)

The front colour which should show for this type.

businessId: integer

This is the unique identifier (primary key) for the business where the Failure Type Priority is configured.

sortOrder: integer

Determines the sequence of the Failure Type Priority.

isActive: boolean

Indicates whether the Failure Type Priority is currently active/enabled.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

createdBy: string(50)

Identifies the user who created the record (email address). 

createdDate: DateTime

Indicates the date and time the record was created. 

 

 

accessIssue: string(50)

Notes on any issues accessing the equipment.

structureMaintenanceActivity[]

Displays the maintenance activity the failure has been changed within. 

comment: string(250)

Free text comments for the failure.

laidOut: boolean

Indicates that the new replacement is at location ready to install.

taggedBy: string(50)

The person who recorded the fault.

taggedByUserGroup: string(50)

The user group of the person who recorded the fault.

dateTagged: DateTime

The time when the fault was recorded.

monthTagged: string(20)

The month from dateTagged.

changedBy: string(50)

The person who replaced the equipment.

changedByUserGroup: string(50)

The user group of the person who changed the equipment.

dateChanged: DateTime

The date when the Idler was changed.

monthChanged: string(20)

The month from dateChanged.

closedBy: string(50)

The person who closed the fault.

closedByUserGroup: string(50)

The user group of the person who closed the fault.

isReplaced: boolean

Indicates the equipment was replaced.

isDeleted: boolean

Indicates the record was deleted, and so should be ignored.

daysInFailure: integer

The difference between dateTagged and dateChanged in days.

partNumber: string(50)

The part number of the equipment.

woNumber: string(50)

The Work Order number for the repair. Free text.

gpsLatitude: decimal

GPS latitude coordinate of the equipment.

gpsLongitude: decimal

GPS longitude coordinate of the equipment.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

lastSavedByUserGroup: DateTime

Indicates the last time the record was updated.

createdBy: string(50)

Identifies the user who created the record (email address). 

createdDate: DateTime

Indicates the date and time the record was created. 

createdByUserGroup: DateTime

Indicates the last time the record was updated.

lastPage: integer

Indicates the page number of the last page when a paged endpoint is called. 

 

Response Status Code

See HTTP Response Codes and Errors

 

 


Examples

URL: 

https://apiprod.pdsglobal.com/V2/api/idler/structurefailures/V9?api_key=ABC123&lastSynced=2022-01-01 00:00:00.000

 

Response Body: xxx

{
    "changedRecords": [
        {
            "tagId"6982,
            "tagNo""Android",
            "areaId"56,
            "frame"5556,
            "ct"null,
            "other1"null,
            "other2"null,
            "structureType": [
                {
                    "structureTypeId"126,
                    "name""Return Tracking Frame",
                    "businessId"1,
                    "sortOrder"5,
                    "isActive"true,
                    "lastSavedBy""ricks@pdsonline.com.au",
                    "lastSavedDateTime""2017-02-07T03:56:25.227Z",
                    "createdBy""ricks@pdsonline.com.au",
                    "createdDateTime""2017-02-07T03:56:25.227Z"
                }
            ],
            "structureFailureType": [
                {
                    "structureFailureTypeId"4,
                    "name""Corroded",
                    "priorityId"3,
                    "structureFailureTypePriority": [
                        {
                            "priorityId"3,
                            "name""MONITOR - Ongoing",
                            "backColour""#fff200",
                            "fontColour""#000000",
                            "businessId"1,
                            "sortOrder"3,
                            "isActive"true,
                            "lastSavedBy""peterm@pdsonline.com.au",
                            "lastSavedDateTime""2017-01-22T07:53:49.823Z",
                            "createdBy""peterm@pdsonline.com.au",
                            "createdDateTime""2017-01-22T07:53:49.823Z"
                        }
                    ],
                    "priority""MONITOR - Ongoing",
                    "businessId"1,
                    "sortOrder"4,
                    "isActive"true,
                    "lastSavedBy""ricks@pdsonline.com.au",
                    "lastSavedDateTime""2018-04-12T23:41:10.520Z",
                    "createdBy""ricks@pdsonline.com.au",
                    "createdDateTime""2018-04-12T23:41:10.520Z"
                }
            ],
            "accessIssue"null,
            "structureMaintenanceActivity": [],
            "comment"null,
            "laidOut"false,
            "taggedBy""Test1@pdsglobal.com",
            "taggedByUserGroup"null,
            "dateTagged""2021-11-01T22:46:00.000Z",
            "monthTagged""11/2021",
            "changedBy"null,
            "changedByUserGroup"null,
            "dateChanged"null,
            "monthChanged"null,
            "closedBy"null,
            "closedByUserGroup"null,
            "isReplaced"false,
            "isDeleted"false,
            "daysInFailure"78,
            "partNumber"null,
            "woNumber"null,
            "gpsLatitude"null,
            "gpsLongitude"null,
            "lastSavedBy""Test1@pdsglobal.com",
            "lastSavedByUserGroup"null,
            "lastSavedDateTime""2021-11-01T22:45:42.613Z",
            "createdBy""Test1@pdsglobal.com",
            "createdByUserGroup"null,
            "createdDateTime""2021-11-01T22:45:42.613Z"
        }
    ],
    "lastPage"0
}

 

 

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

Articles in this section

prev next

Related sections