Hoteling Host Service¶
Display user’s hoteling host¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/hoteling/host/
¶ Retrieve the settings of the Hoteling Host service of the user.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/hoteling/host/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "active": true, "enforceAssociationLimit": false, "associationLimitHours": 12 }
- Response JSON Object:
active (boolean) – active.
enforceAssociationLimit (boolean) – enforceAssociationLimit.
associationLimitHours (integer) – associationLimitHours.
guestLastName (string) – guestLastName.
guestFirstName (string) – guestFirstName.
guestPhoneNumber (string) – guestPhoneNumber.
guestExtension (string) – guestExtension.
guestLocationDialingCode (string) – Group location dialing code for groups that are part of a enterprise.
guestAssociationDateTime (datetime) – guestAssociationDateTime. See Datetime
- Note:
When a guest is associated, guest 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 host¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/hoteling/host/
¶ Update the settings of the Hoteling Host service of the user.
Example request:
PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/hoteling/host/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "active": true, "enforceAssociationLimit": true, "associationLimitHours": 24 }
- Request JSON Object:
active (boolean) – active.
enforceAssociationLimit (boolean) – enforceAssociationLimit.
associationLimitHours (integer) – associationLimitHours.
removeGuestAssociation (boolean) – removeGuestAssociation.
Example response:
- Response:
Similar to GET instance method response. When a guest is associated, guest 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