Profile Management

Retrieve group details

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

Retrieve the group details.

Example request:

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

Example response:

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

{
   "defaultDomain": "sip.netaxis.be",
   "userLimit": 10,
   "userCount": 10,
   "groupName": "Foo Group",
   "cliName": "Foo Group Test",
   "cliPhoneNumber" : "",
   "locationDialingCode": "",
   "timeZone": "Europe/Brussels",
   "contactInformation": {
       "name": "Pippo Nouveau",
       "phoneNumber": "+32369857450",
       "emailAddress": "pippo.n@netaxis.be"
   },
   "addressInformation": {
       "addressLine1": "Rue Wiertz, 33",
       "city": "Brussels",
       "stateDisplayName": "Belgium",
       "postalCode": "1050",
       "country": "Belgium"
   }
}
Response JSON Object:
Status Codes:

Update group details

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

Update the group details.

Example request:

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

{
   "groupName": "foogroup_2",
   "userLimit": 45
}
Request JSON Object:

  • groupName (string) – See groupName from Group attributes.

  • userLimit (integer) – See userLimit from Group attributes.

  • defaultDomain (string) – See defaultDomain from Group attributes.

  • cliName (string) – See cliName from Group attributes.

  • cliPhoneNumber (string) – See cliPhoneNumber from Group attributes.

  • locationDialingCode (string) – See locationDialingCode from Group attributes.

  • timeZone (string) – See timeZone from Group attributes.

  • contactInformation (object) – See contactInformation from Group attributes.

  • addressInformation (object) – See addressInformation from Group attributes.

  • resellerId (string) – See resellerId from Group attributes.

  • templateName (optional) (string) – The name of the template to be used during the Group modification.

  • autoCreateDomain (boolean) – If the defaultDomain provided does not exist, will be created at System and Tenant level and assigned to the Group.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Delete a group

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

Delete a group from the tenant.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/ HTTP/1.1
Host: example.com
Request JSON Object:

  • _excludedAppIds (array) – (Optional) The delete will delete all EndUserAppData of the End Users of this Group, but it could occur that the caller still needs some of them and will take the responsibility to delete them afterwards. The format is an array of Application Ids (string). (from 1.11.1)

Example response:

HTTP/1.1 200 OK
Status Codes:

  • 200 OK – no error

  • 400 Bad Request – with error code 29 CAN_NOT_DELETE_NON_EMPTY in case the protection against deletion of non-empty Group is enabled and the Group is not empty (see below).

Configuration Information for Group Update

In the PUT API, the APIO can create a GroupData object and can also auto-create a Reseller object with as name the resellerId if not existing.

The following settings is to instruct the APIO how to manage this:

"APIO_OBJECT_CREATION": {
    "GROUP_DATA": true,
    "RESELLER": true
}
"AUTO_CREATE": {
    "GROUP_DEFAULT_DOMAIN": true
}
Settings description:

  • APIO_OBJECT_CREATION: is a set of settings for controlling the auto-creation of different objects in APIO DB.

  • RESELLER if true, if a resellerId is received and the corresponding Reseller does not exist it will be created; if false in same conditions it will be rejected. Default is False.

  • GROUP_DATA if true, a GroupData object will be created if it was not existing. Note that if a resellerId is provided, a GroupData object will always be created if it was not existing. Default is False.

  • AUTO_CREATE.GROUP_DEFAULT_DOMAIN: If true, if the defaultDomain provided does not exist, will be created at System and Tenant level and assigned to the Group. The behaviour can be overriden by the autoCreateDomain parameter within the input data. Default is False.

Configuration Information for Group Delete

In the DELETE API, the APIO can check if a Group can be deleted based on specific settings.

The following settings is to instruct the APIO how to manage this:

"CHECK_GROUP": {
   "CHECK_USERS": false,
   "CHECK_TRUNK_USERS": false,
   "CHECK_SERVICE_USERS": false,
   "CHECK_TRUNK_GROUPS": false
}
Settings description:

  • CHECK_GROUP.CHECK_USERS: If true and if there are users in the group, it cannot be deleted.

  • CHECK_GROUP.CHECK_TRUNK_USERS: If true and if there are trunk users in the group, it cannot be deleted.

  • CHECK_GROUP.CHECK_SERVICE_USERS: If true and if there are service users (IVRs, CCs, HGs) in the group, it cannot be deleted.

  • CHECK_GROUP.CHECK_TRUNK_GROUPS: If true and if there are trunk groups in the group, it cannot be deleted.

Template Information for Group

The template category is group