Hoteling Guest Service

Display user’s hoteling guest

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

Retrieve the settings of the Hoteling Guest service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/hoteling/guest/ HTTP/1.1
Host: example.com

Example response:

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

{
   "active": true,
   "enableAssociationLimit": false,
   "associationLimitHours": 12
}

Response JSON Object:

• active (boolean) – active.

• enableAssociationLimit (boolean) – enableAssociationLimit.

• associationLimitHours (integer) – associationLimitHours.

• hostUserId (string) – hostUserId.

• hostLastName (string) – hostLastName.

• hostFirstName (string) – hostFirstName.

• hostAssociationDateTime (datetime) – hostAssociationDateTime. See Datetime

• hostEnforcesAssociationLimit (boolean) – hostEnforcesAssociationLimit.

• hostAssociationLimitHours (integer) – hostAssociationLimitHours.

Note:

When an host is associated, host related fields are reported.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

Update user’s hoteling guest

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

Update the settings of the Hoteling Guest service of the user.

Example request:

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

{
   "active": true,
   "enableAssociationLimit": true,
   "associationLimitHours": 24,
   "hostUserId": "foogroup_z001@sip.netaxis.be"
}

Request JSON Object:

• active (boolean) – active.

• enableAssociationLimit (boolean) – enableAssociationLimit.

• associationLimitHours (integer) – associationLimitHours.

• hostUserId (string) – hostUserId.

Example response:

Response:

Similar to GET instance method response. When an host is associated, host related fields are reported.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

• 400 Bad Request – error during the update

Display user’s hoteling guest available users for assignement

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/hoteling/guest/available_users/

Retrieve the list of available users to be used for the Hoteling Guest service of the user.

Supports search criteria:

• sensitiveUserLastNameStarts

• sensitiveUserLastNameContains

• sensitiveUserLastNameEquals

• insensitiveUserLastNameStarts

• insensitiveUserLastNameContains

• insensitiveUserLastNameEquals

• sensitiveUserFirstNameStarts

• sensitiveUserFirstNameContains

• sensitiveUserFirstNameEquals

• insensitiveUserFirstNameStarts

• insensitiveUserFirstNameContains

• insensitiveUserFirstNameEquals

• sensitiveUserDepartmentEquals

• sensitiveUserIdStarts

• sensitiveUserIdContains

• sensitiveUserIdEquals

• insensitiveUserIdStarts

• insensitiveUserIdContains

• insensitiveUserIdEquals

• insensitivePhoneNumberStarts

• insensitivePhoneNumberContains

• insensitivePhoneNumberEquals

• insensitiveExtensionStarts

• insensitiveExtensionContains

• insensitiveExtensionEquals

and:

• responseSizeLimit

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/hoteling/guest/available_users/ HTTP/1.1
Host: example.com

Example response:

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

{
     "available_users": [
         {
             "userId": "foogroup_z001@sip.netaxis.be",
             "firstName": "Test2",
             "lastName": "Test2",
             "associationLimitHours": "",
             "enableAssociationLimit": "",
             "extension": "",
             "phoneNumber": "",
             "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": ""
         }
     ]
}

Response JSON Object:

• users (array) – a list of available users as defined in User Hoteling Guest Available User List Item.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

User Hoteling Guest Available User List Item

Name	Type	Methods	Description
		GET
userId	String	A	Unique name for the agent assigned to a call center.
firstName	String	A	User’s first name.
lastName	String	A	User’s last name.
associationLimitHours	Integer	A	associationLimitHours.
enableAssociationLimit	Boolean	A	enableAssociationLimit.
phoneNumber	String	A	Phone number.
extension	String	A	The extension.
department	Object	A	An object as defined as Group department key attributes.
emailAddress	String	A	User’s email address.