1- Get all hierarchy entity
GET {{baseUrl}}/hierarchy/children
Get details for organisation structure entitity with given id
.
Different set of attributes is returned for different entity types. Supported item types are:
CUSTOMER
DEBTOR
COST_CENTER
CUSTOM_GROUP
BUSINESS_LOCATION
SUBSCRIBER
are not supported. subscribers/{id}
should be used instead.
Possible exceptions: | HTTP code | Error code | Description | |-----------|------------------------------------|--------------------------------------------------------------| |
400
| WRONG_GROUP_TYPE
| Item of unsupported type |
| 404
| VIRTUAL_HIERARCHY_ITEM_NOT_FOUND
| Information for item with the given id
cannot be found |
Required privileges (one of the following):- privilegesun-authorizedorderscreation
- privilegesordersauthorization
- privilegesvirtualhierarchyview
- privilegesvirtualhierarchymanagement
- privilegesbulkuploaddataofend_user
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
includeGroups | boolean | ||
includeCustomer | boolean |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
"{\n \"result\": [\n {\n \"path\": [\n {\n \"id\": 3456,\n \"name\": \"Customer1\",\n \"type\": \"CUSTOMER\",\n \"email\": null\n }\n ],\n \"id\": 4567,\n \"name\": \"Debtor1\",\n \"type\": \"DEBTOR\",\n \"email\": null\n },\n ],\n \"total\": 1\n}"