(GET) Area Details

Description

This API Endpoint will allow a customer to get the details of their Business, Group, Department and Area within the PDS software.

URL

https://apiprod.pdsglobal.com/V2/api/area/areaDetails/V1

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

Request

Mandatory Fields are denoted by *

Type

GET

Headers

Content-Type = Application/Json

Parameters

api_key*
This is required for authentication. If you do not have your API key please contact PDS Support (support@pdsglobal.com).

Body

No body is required for this API Endpoint.

Response

After calling this endpoint, the API call will return a response entity with a body and a status. The response entity will display the data for Business, Group, Department and Area if successful.

Status

200 - HTTP Response OK
400 - HTTP Response Bad Request
403 - HTTP Response Forbidden
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:
- Error Locating Equipment
- Invalid/Incorrect API Key
- Missing Content-Type header
- Error connecting to PDS Server
- A response entity with data for that Business, Group, Department and Area.

Examples

Example URL:
https://apiprod.pdsglobal.com/V2/api/area/areaDetails/V1?api_key=xxx123

Example of Successful Response Entity:

[

  {

    "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