Communication Barring for a user

Retrieve communication barring settings for a user

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

Gets the Communication Barring settings for a user. Only suitable for enterprises.

Authorization rights: minimum (Enterprise) Group Admin.

Example request:

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

Example response:

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

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

Response JSON Object:

• useGroupSetting (boolean) – Specify if to use the group settings.

• profile (string) – (conditional) The name of the profile.

Status Codes:

• 200 OK – no error

• 400 Bad Request –

  invalid data. Failed to update due to bad request, with possible sub-error codes:

  • 42: INVALID_PARAMETERS, ‘This transaction is for users in an enterprise, not for users in a service provider.’

Modify communication Barring settings for a user

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

Modify the Communication Barring settings for a user Only suitable for enterprises.

Authorization rights: minimum (Enterprise) Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foo_group_ad/users/foouser_it/services/comm_barring/ HTTP/1.1

Host: example.com
Content-Type: "application/json"

{
   "useGroupSetting": false,
   "profileName": "Test profile 1"
}

Request JSON Object:

• useGroupSetting (boolean) – Specify if to use the group settings.

• profile (string) – (conditional) The name of the profile, it is mandatory only when useDefaultTenantProfile is False.

Example response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – no error

• 400 Bad Request –

  invalid data. Failed to update due to bad request, with possible sub-error codes:

  • 42: INVALID_PARAMETERS, ‘This transaction is for users in an enterprise, not for users in a service provider.’