Group Communication Barring Profile¶

Retrieve communication barring settings for a group¶

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

Retrieve communication barring settings for a group

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/comm_barring/ HTTP/1.1
Host: example.com

Example response:

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

{
    "useDefaultTenantProfile": false,
    "profile": "Test profile 1"
}

Response JSON Object:

useDefaultTenantProfile (boolean) – If enabled use default profile.
profile (string) – The name of the profile.

Status Codes:

200 OK – no error

Update the Communication Barring settings for a group¶

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

Update the Communication Barring settings for a group.

Authorization rights: minimum Group Admin.

Example request:

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

{
        "useDefaultTenantProfile": false,
        "profile": "Test profile 2"
}

Response JSON Object:

useDefaultTenantProfile (boolean) – Specify if to use the default profile at Tenant level.
profile (string) – The profile name. It is required when useDefaultTenantProfile is set to False.

Status Codes:

200 OK – no error

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request – invalid data

Retrieve the list of all communication barring profiles that will be available to assign to an End User of the group¶

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

Retrieve the list of all communication barring profiles that will be available to assign to an End User of the group Only suitable for enterprises.

Authorization rights: minimum (Enterprise) Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/comm_barring/profiles_for_users/ HTTP/1.1
Host: example.com

Example response:

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

{
  "profiles": [
      {
          "name": "Test profile 1"
      },
      {
          "name": "Test profile 2"
      }
  ]
}

Response JSON Object:

profiles (array) – a list of objects as defined as Group communication barring profile list attributes.

Status Codes:

200 OK – no error
400 Bad Request –
invalid data, with possible sub-error codes:
- 42: “This transaction is for groups in an enterprise, not for groups in a service provider”

Modify the list of all communication barring profiles that will be available to assign to an End User of the group¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/comm_barring/profiles_for_users/¶

Modify the list of all communication barring profiles that will be available to assign to an End User of the group Only suitable for enterprises.

Authorization rights: minimum Tenant (Enterprise) Admin.

Example request:

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

{
  "profiles": [
     {
        "name": "Test profile 1"
     },
     {
        "name": "Test profile 2"
     }
  ]
}

Request JSON Object:

profiles (array) – a replacement list of objects as defined as Group communication barring profile list attributes. The valid profiles that can be assigned are retrievable from: Display tenant’s communication barring profile list.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request –
invalid data, with possible sub-error codes:
- 8: “Communication Barring Profile: not found for Service Provider: missing Valid Barring Profile”
- 18: “Cannot unassign Communication Barring Profile. It is assigned to a user in the group”
- 42: “This transaction is for groups in an enterprise, not for groups in a service provider”