(GET) Idler Fault API

Description

Supplies all open Idler faults, along with details on the Idler type and configuration. 

 

URL

https://apiprod.pdsglobal.com/V2/api/idler/idlerfailures/V8

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 Idler Fault.

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

 

idlerPosition[]

idlerPositionId: integer

This is the unique identifier (primary key) for the Idler Position.

idlerPosition: string(50)

The name of the Idler Position for each individual idler, within the Idler Position Set. E.g. if the Set is '4 Roll Trough' then the Idler on the left will be in the position '4 Roll Trough - LHS'.

idlerPositionSet: string(50)

Used to group various Idler Positions within the Idler Position Groups. For example all 4 roll troughs on the Carry side will belong to the Set named 'Carry4Roll'.

idlerPositionGroup: string(50)

The name of the group the Idler resides in. E.g. 'Carry', or 'Return'.

idlerPositionGroupId: integer

This is the unique identifier (primary key) for the Idler Position Group.

 

 

idlerType[]

idlerTypeId: integer

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

name: string(50)

The name of the Idler Type.

businessId: integer

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

sortOrder: integer

Determines the sequence of the Idler Type.

isActive: boolean

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. 

 

 

idlerLocation[]

idlerLocationId: integer

This is the unique identifier (primary key) for the Idler Location.

name: string(50)

The name of the Idler Location.

businessId: integer

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

sortOrder: integer

Determines the sequence of the Idler Location.

isActive: boolean

Indicates whether the Idler Location 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. 

 

 

idlerManufacturer[]

idlerManufacturerId: integer

This is the unique identifier (primary key) for the Idler Manufacturer.

name: string(50)

The name of the Idler Manufacturer.

businessId: integer

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

sortOrder: integer

Determines the sequence of the Idler Manufacturer.

isActive: boolean

Indicates whether the Idler Manufacturer 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.

 

idlerFailureType[]

idlerFailureTypeId: integer

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

name: string(50)

The name of the Idler Failure Type.

isFramed: boolean

Indicates that surrounding Idlers are to also be replaced.

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 Idler Failure Type.

isActive: boolean

Indicates whether the Idler 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. 

priority: string(50)

The name of the priority level selected.

priorityId: integer

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

 

idlerFailureTypePriority[]

priorityId: integer

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

name: string(50)

The name of the Idler Failure Type Priority.

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 Idler Failure Type Priority.

isActive: boolean

Indicates whether the Idler 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.

idlerMaintenanceActivity: string(50)

The activity underway when the fault was found (e.g. Weekly Maintenance).

comment: string(250)

Free text for comments on the fault.

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

changedByUserGroup: string(50)

The user group of the person who changed the Idler.

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

woNumber: string(50)

The Work Order number for the repair. Free text.

gpsLatitude: decimal

GPS latitude coordinate of the Idler.

gpsLongitude: decimal

GPS longitude coordinate of the Idler.

lastSavedBy: string(50)

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

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

lastSavedByUserGroup: string(50)

The user group of the last person who saved the record.

createdBy: string(50)

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

createdDate: DateTime

Indicates the date and time the record was created. 

createdByUserGroup: string(50)

The user group of the last person who saved the record.

 

Response Status Code

See HTTP Response Codes and Errors

 

 


Examples

URL:

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

 

 

Response Body: 

{
    "changedRecords": [
        {
            "tagId"6941,
            "tagNo""Android",
            "areaId"51,
            "frame"3,
            "ct"null,
            "other1"null,
            "other2"null,
            "idlerPosition": [
                {
                    "idlerPositionId"11,
                    "idlerPosition""3 Roll Trough - Centre",
                    "idlerPositionSet""Carry3Roll",
                    "idlerPositionGroup""Carry",
                    "idlerPositionGroupId"4
                }
            ],
            "idlerType": [
                {
                    "idlerTypeId"124,
                    "name""Poly",
                    "businessId"1,
                    "sortOrder"3,
                    "isActive"true,
                    "lastSavedBy""ricks@pdsonline.com.au",
                    "lastSavedDateTime""2017-02-07T03:55:16.850Z",
                    "createdBy""ricks@pdsonline.com.au",
                    "createdDateTime""2017-02-07T03:54:38.143Z"
                }
            ],
            "idlerLocation": [
                {
                    "idlerLocationId"4,
                    "name""Weightometer",
                    "businessId"1,
                    "sortOrder"4,
                    "isActive"true,
                    "lastSavedBy""peterm@pdsonline.com.au",
                    "lastSavedDateTime""2017-01-22T07:59:22.037Z",
                    "createdBy"null,
                    "createdDateTime"null
                }
            ],
            "idlerManufacturer": [
                {
                    "idlerManufacturerId"6,
                    "name""CPS",
                    "businessId"1,
                    "sortOrder"1,
                    "isActive"true,
                    "lastSavedBy""peterm@pdsonline.com.au",
                    "lastSavedDateTime""2017-01-22T18:59:55.797+11:00",
                    "createdBy"null,
                    "createdDateTime"null
                }
            ],
            "idlerFailureType": [
                {
                    "idlerFailureTypeId"13,
                    "name""Framed",
                    "priorityId"3,
                    "idlerFailureTypePriority": [
                        {
                            "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",
                    "isFramed"true,
                    "businessId"1,
                    "sortOrder"13,
                    "isActive"true,
                    "lastSavedBy""TestProd2@pdsglobal.com",
                    "lastSavedDateTime""2019-04-09T23:03:26.810Z",
                    "createdBy""TestProd2@pdsglobal.com",
                    "createdDateTime""2019-02-27T04:13:41.000Z"
                }
            ],
            "accessIssue"null,
            "idlerMaintenanceActivity": [],
            "comment""This Idler Type does not match the configured Type/s for this Selection, or is un-configured.\n fff",
            "laidOut"false,
            "taggedBy""Test2@pdsglobal.com",
            "taggedByUserGroup"null,
            "dateTagged""2021-10-29T17:26:00.000Z",
            "monthTagged""10/2021",
            "changedBy"null,
            "changedByUserGroup"null,
            "dateChanged"null,
            "monthChanged"null,
            "closedBy"null,
            "closedByUserGroup"null,
            "isReplaced"false,
            "isDeleted"false,
            "daysInFailure"81,
            "partNumber"null,
            "woNumber"null,
            "gpsLatitude"null,
            "gpsLongitude"null,
            "lastSavedBy""Test1@pdsglobal.com",
            "lastSavedByUserGroup"null,
            "lastSavedDateTime""2021-11-01T22:44:51.740Z",
            "createdBy""Test2@pdsglobal.com",
            "createdByUserGroup"null,
            "createdDateTime""2021-10-29T17:27:06.550Z"
        },
    ],
    "lastPage"0
}

 

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

Articles in this section

prev next

Related sections