(GET) Area Details

Description

Supplies the hierarchy data, such as Business, Group, Department and Area. This is generally used for retrieving reference data, such as businessId for example. 

 

URL

https://apiprod.pdsglobal.com/V2/api/area/areaDetails/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).

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.

Body

No body is required for this API Endpoint.

 


Response

Body

Object: ResponseEntity<string>[]

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.

businessId: integer

This is the unique identifier (primary key) for the business. This 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.

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.

groupId: integer

This is the unique identifier (primary key) for the group. This 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.

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.

departmentId: integer

This is the unique identifier (primary key) for the department. This 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.

areaFunctionalLocation: string(50)

Unique code used to identify the area. Can be obtained from the area edit dialog, or the Area Details API.

areaId: integer

This is the unique identifier (primary key) for the area. This can be obtained from the hierarchy or the Area Details API.

 

Response Status Code

See HTTP Response Codes and Errors

 


Examples

URL:

https://apiprod.pdsglobal.com/V2/api/area/areaDetails/V1?api_key=ABC123

 

 

Response Body

[

  {

    "businessName": "Mine Operations",

    "businessFunctionalLocation": null,

    "businessId": 1,

    "groupName": "Raw Coal",

    "groupFunctionalLocation": null,

    "groupId": 1,

    "departmentName": "Apron Feeder Chains",

    "departmentFunctionalLocation": null,

    "departmentId": 16,

    "areaName": "AF01",

    "areaFunctionalLocation": null,

    "areaId": 28

  },

  {

    "businessName": "Mine Operations",

    "businessFunctionalLocation": null,

    "businessId": 1,

    "groupName": "Raw Coal",

    "groupFunctionalLocation": null,

    "groupId": 1,

    "departmentName": "Apron Feeder Pan (Multi Point)",

    "departmentFunctionalLocation": null,

    "departmentId": 19,

    "areaName": "AF12 Centre Points",

    "areaFunctionalLocation": null,

    "areaId": 47

  }

]

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

Articles in this section

prev next

Related sections