Services Management¶

In order to be usable the services at Group level must be assigned to the Group.

Add group services¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/¶

Add services to the group.

If the service is already assigned to the group, it will be considered as a success.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/services/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "services" : [
      {"name": "Call Pickup"},
      {"name": "Hunt group"}
   ]
}

Request JSON Object:

services (array) – a list of services at group level that must be assigned. See Service Management List Item

Example response:

HTTP/1.1 201 OK
Content-Type: "application/json"

Status Codes:

201 Created – request was processed without error
400 Bad Request – request was processed and fully in error

Remove group services¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/¶

Remove services from the group.

If the service was not assigned to the group, it will be considered as a success.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "services" : [
      {"name": "Call Pickup"}
   ]
}

Request JSON Object:

services (array) – a list of services at group level that must be assigned. See Service Management List Item

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

Status Codes:

200 OK – request was processed without error
400 Bad Request – request was processed and fully in error

Get Group Services¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/¶

Get the group services of the group with their assignment status.

Only the auhtoreized servcies are reported.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

Example response:

HTTP/1.1 201 OK
Content-Type: "application/json"

{
   "services" : [
      {"name": "Call Pickup", "assigned": true},
      {"name": "Hunt group", "assigned": false}
   ]
}

Response JSON Object:

services (array) – a list of services at group level with their assignment status. See Service Management List Item

Status Codes:

200 OK – request was processed without error