Description
Provides a facility to create a new group in the hierarchy under an existing business.
URL
https://apiprod.pdsglobal.com/V2/api/group/V1
Note: There are two non-production environments that can be used for testing.
Request
Type
POST
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).
*
businessId: integer
This is the unique identifier (primary key) for the business. This can be obtained from the hierarchy or the Area Details API.
Body
|
Object: CreateGroup |
|
|
name* - string(50) |
|
|
functionalLocation - string(50) A functional location can be added to reference the group to external software like SAP. This is just free text, not a link. |
Response
Body
|
Object: ResponseEntity<string> |
|
|
groupId: integer The Id (primary key) value of the newly created group. |
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/group/V1?api_key=ABC123&businessId=1
Request Body:
{
"name":"Test 1 Group",
"functionalLocation":"Test 1 Group functional location"
}
Response Body:
{
"groupId": 21
}