Group Paging Originators

The Originators are the users who may originate calls to a paging group.

Retrieve list of available originators

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

Retrieve the list of users who could be assigned as originator. It is important to notice that this API is not linked to an instance of paging group but a global one at Group level.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/group_paging_originators/available/ HTTP/1.1
Host: example.com
Request JSON Object:

  • sensitiveDepartmentEquals (object) – See sensitiveDepartmentEquals from Search criteria.

  • sensitiveUserGroupEquals (object) – See sensitiveUserGroupEquals from Search criteria.

  • sameGroupOnly (boolean) – to filter the list to the same Group only.

  • sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.

  • sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.

  • sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.

  • insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.

  • insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.

  • insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.

  • sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.

  • sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.

  • sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.

  • insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.

  • insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.

  • insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.

  • sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.

  • sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.

  • sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.

  • insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.

  • insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.

  • insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.

  • insensitivePhoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.

  • insensitivePhoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.

  • insensitivePhoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.

  • insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.

  • insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.

  • insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

Example response:

HTTP/1.1 200 OK

{
   "available_users": [
      {
          "userId": "ApioUserTest@sip.netaxis.be",
          "lastName": "Test",
          "firstName": "Test",
          "phoneNumber": "",
          "extension": "4000",
          "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
          },
          "emailAddress": "test_mail@test.netaxis.be"
      },
      {
          "userId": "foouser@sip.netaxis.be",
          "lastName": "Test",
          "firstName": "Test",
          "phoneNumber": "",
          "extension": "4004",
          "emailAddress": "test_foomail@test.netaxis.be"
      }
   ]
}
Response JSON Object:
Status Codes:

Retrieve list of originators of an instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/originators/

Retrieve the list of users assigned as originators for a paging group.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/originators/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "originatorUsers": [
      {
          "userId": "ApioUserTest@sip.netaxis.be",
          "lastName": "Test",
          "firstName": "Test",
          "phoneNumber": "",
          "extension": "4000",
          "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
          },
          "emailAddress": "test_mail@test.netaxis.be"
      }
   ]
}
Response JSON Object:

  • originatorUsers (array) – The list of originators, the structure is similar to the Available API. See Available User List Item.

Status Codes:

Add originators to an instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/originators/

Add new originators to a paging group.

Authorization rights: minimum Group Admin.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/originators/ HTTP/1.1
Host: example.com

{

   "originatorUserIds": ["ApioUserTest@sip.netaxis.be", "ApioUserTest2@sip.netaxis.be"],
}
Request JSON Object:

  • originatorUserIds (array) – the user ids of the users to be added as originator.

Example response:

Response:

Similar to GET originators method response: this is the new full list of originators.

Status Codes:

Remove originators from an instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/originators/

Remove originators from a paging group.

Authorization rights: minimum Group Admin.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/originators/ HTTP/1.1
Host: example.com

{

   "originatorUserIds": ["ApioUserTest@sip.netaxis.be", "ApioUserTest2@sip.netaxis.be"],
}
Request JSON Object:

  • originatorUserIds (array) – the user ids of the users to be removed from the list originators.

Example response:

Response:

Similar to GET originators method response: this is the new full list of originators.

Status Codes:

Replace the list originators of an instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_pagings/(string: serviceUserId)/originators/

Replace the current list of originators of a paging group by a new list.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/group_pagings/APIOTestGP@sip.netaxis.be/originators/ HTTP/1.1
Host: example.com

{

   "originatorUserIds": ["ApioUserTest@sip.netaxis.be", "ApioUserTest2@sip.netaxis.be"],
}
Request JSON Object:

  • originatorUserIds (array) – the user ids of the users who will be the new list originators.

Example response:

Response:

Similar to GET originators method response: this is the new full list of originators.

Status Codes: