Search for Service User(s) in a Tenant

Request the list of Service Users of a tenant. It is possible to search by various criteria to restrict the number of results returned.

List service users

GET /api/v1/tenants/(string: tenant_id)/search/service_users/

List all service users of a Tenant matching some filter criteria.

Several criteria can be used in the same request (AND mode), but each criterium can only be used once on a request.

Authorization rights: minimum Tenant Admin.

Example request:

GET /api/v1/tenants/foo/search/service_users/ HTTP/1.1
Host: example.com

{
   "exactServiceType": "Hunt Group"
}
Request JSON Object:

  • 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

  • responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

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

{
   "serviceUsers": [
      {
          "userId": "APIOTestHuntGroup@sip.netaxis.be",
          "groupId": "ApioGrpTest",
          "serviceType": "Hunt Group",
          "name": "APIO Test Hunt Group",
          "phoneNumber": "+3225126777",
          "extension": "6777"
      }
   ]
}
Response JSON Object:
Status Codes:

Configuration Information for Search for Service User(s) in a Tenant

The APIO behaviour is controlled by the following settings:

"MAP_BW_SERVICE_NAMES": false,
With following parameters:

  • MAP_BW_SERVICE_NAMES: If enabled (true- APIO will only accept APIO names in the exactServiceType criterium, else Broadsoft specific names will be allowed too.

In addition to this the translation in answers of Broadsoft sepcific names into APIO names in controlled by a setting of the Broadsoft Network Adaptor (PROQ lib).

In PROQ config file (not yet in Backend object):

[Misc]
map_bw_names=0
With following parameters:

  • map_bw_names: if enabled (1) some BW service names (‘Auto Attendant’, ‘Auto Attendant - Standard’, ‘BroadWorks Anywhere Portal’) will be adapted into APIO generic names (‘IVR - Basic’, ‘IVR - Standard’, ‘Anywhere Portal’)