Description
Supplies information on the Businesses which are configured in the system. This information can also be viewed in the hierarchy.
URL
https://apiprod.pdsglobal.com/V2/api/business/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).
Body
No body is required for this API Endpoint.
Response
Body
|
Object: ResponseEntity<string>
|
|
|
business[]
The list of returned businesses.
|
|
businessId: integer
This is the unique identifier (primary key) for the business.
|
|
name: string(50)
The name of the business.
|
|
sortOrder: integer
All items have a sort order number assigned to them. It determines the sequence of the item.
|
|
isActive: boolean
Indicates whether the business 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. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).
|
|
createdBy: string(50)
Identifies the user who created the record (email address).
|
|
createdDate: DateTime
Indicates the date and time the record was created.
|
|
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/business/V1?api_key=ABC123
Response Body:
[
{
"businessId": 1,
"name": "Mine Operations",
"sortOrder": 1,
"isActive": true,
"lastSavedBy": null,
"lastSavedDateTime": null,
"createdBy": null,
"createdDateTime": null
},
{
"businessId": 2,
"name": "Port Operations",
"sortOrder": 2,
"isActive": true,
"lastSavedBy": null,
"lastSavedDateTime": null,
"createdBy": null,
"createdDateTime": null
}
]
