Tenant Phone Directory Services

Display Tenant’s phone directory list entries

GET /api/v1/tenants/(string: tenant_id)/services/phone_directory/

Retrieve the entry list from the Phone Directory List service of the Tenant.

Authorization rights: minimum EndUser.

Example request:

GET /api/v1/tenants/foo/services/phone_directory/ HTTP/1.1
Host: example.com

{
   "extendedInfo": true,
   "sensitiveUserIdStarts": "Test"
}

GET /api/v1/tenants/foo/services/phone_directory/ HTTP/1.1
Host: example.com

{
   "sensitiveUserIdStarts": "Test",
   "pagingControl" : {
      "startIndex" : 1,
      "pageSize" : 2
   },
   "sortOrders": ["sensitiveAscendingUserFirstName"]
}
Response JSON Object:

  • extendedInfo (boolean) – Show or not extended informations (all the Conditional field of Tenant Phone Directory List attributes). Default true.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Request JSON Object:

  • pagingControl (object) – (Optional) See pagingControl from Paging Control elements. If pagingControl is provided, responseSizeLimit will be ignored.

  • sortOrders (array) – (Optional) See sortOrders from Paging Control elements, only relevant if pagingControl is provided. Maximum 3 element in the list. Possible field names are : “UserLastName”, “UserFirstName”, “MobileNumber”, “EmailAddress”, “DepartmentName”, “GroupName”, “YahooId” and “UserId”. Default is “insensitiveAscendingUserLastName”.

Example response:

HTTP/1.1 200 OK

{
   "directory": [
      {
         "firstName": "Test",
         "city": "",
         "emailAddress": "test_mail@test.netaxis.be",
         "zip": "",
         "name": "Test,Test",
         "extension": "4000",
         "title": "",
         "lastName": "Test",
         "addressLine1": "",
         "userId": "ApioUserTest@sip.netaxis.be",
         "state": "",
         "phoneNumber": "",
         "location": "",
         "country": "",
         "department": {
              "tenantId": "ApioSpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
         },
         "timeZone": "Europe/Brussels",
         "addressLine2": "",
         "virtualOnNet": false,
         "mobilePhoneNumber": "+3209876543",
         "groupId": "ApioGrpTest",
         "pager": ""
      }
   ]
}
Response JSON Object:
Status Codes: