Hoteling Host Service

Display group’s hoteling hosts list

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

Retrieve the list of the Hoteling Host of a group.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/hotelings/ HTTP/1.1
Host: example.com

Example response:

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

{
   "hoteling_hosts": [
      {
         "hotelingHostId": "foogroup_z001",
         "lastName": "APIO Test",
         "firstName": "Hoteling 1",
         "deviceType": "Generic SIP Phone",
         "macAddress": "ABCDEF000001",
         "description": "",
         "transportProtocol": "Unspecified",
         "active": true,
         "enforceAssociationLimit": true,
         "associationLimitHours": 24,
         "is_associated": false
      },
      {
         "hotelingHostId": "foogroup_z002",
         "lastName": "APIO Test",
         "firstName": "Hoteling 2",
         "deviceType": "Generic SIP Phone",
         "macAddress": "ABCDEF000002",
         "description": "",
         "transportProtocol": "Unspecified",
         "active": true,
         "enforceAssociationLimit": true,
         "associationLimitHours": 24,
         "is_associated": true,
         "guestAssociationDateTime": "2019-04-02 12:34:28",
         "guestLastName": "Test",
         "guestFirstName": "Test",
         "guestExtension": "4000"
      }
   ]
}
Response JSON Object:
Note:

When a guest is associated, guest related fields are reported.

Status Codes:

Display group’s hoteling host instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hotelings/(string: instance_name)/

Retrieve the settings of the Hoteling Host service of a group. These are “hidden” End Users dedicated to be Hoteling Hosts only.

Example request:

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

Example response:

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

{
   "lastName": "APIO Test",
   "firstName": "Hoteling 2",
   "deviceType": "Generic SIP Phone",
   "macAddress": "ABCDEF000002",
   "description": "",
   "transportProtocol": "Unspecified",
   "active": true,
   "enforceAssociationLimit": true,
   "associationLimitHours": 24,
   "is_associated": true
}
Response JSON Object:
Note:

When a guest is associated, guest related fields are reported.

Status Codes:

Create group’s hoteling host instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hotelings/

Create a new Hoteling Host of a group.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/services/hotelings/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "lastName": "APIO Test",
   "firstName": "Hoteling 2",
   "deviceType": "Generic SIP Phone",
   "macAddress": "ABCDEF000002"
}
Request JSON Object:

Example response:

Response:

Similar to GET instance method response. In addition, the hotelingHostId field. When a guest is associated, guest related fields are reported.

Status Codes:

Configuration Information for the Password

The Password of the “hidden” End User acting as Hoteling Host is generated according to the same settings as for the regular End Users.

It means the following parameters:

"NEW_PASSWORD_RESET_GEN": true,
"MINIMUM_PASSWORD_RULES": {
     "END_USER" : {
         "PASSWORD_MIN_SPECIAL_CHARACTERS": 1,
         "PASSWORD_MIN_UPPERCASE_LETTERS": 1,
         "PASSWORD_MIN_LOWERCASE_LETTERS": 1,
         "PASSWORD_MIN_DIGITS": 1,
         "PASSWORD_MIN_LENGTH": 8
     }
},
Settings description:

  • NEW_PASSWORD_RESET_GEN: If true the new logic based on rules will be used for the random passwords generation. Else the legacy hardcoded config will be used. Default is true. Note that this is a global parameter.

  • MINIMUM_PASSWORD_RULES.**END_USER**: (from 1.11.0) minium password rules for End Users. Default are the ones in the example. Please note that this settings will also be used when creating hidden users for APIO features.

Update group’s hoteling host instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hotelings/(string: instance_name)/

Update the settings of the Hoteling Host service of a group.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/hotelings/foogroup_z002@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "firstName": "Hoteling Test 2",
   "macAddress": "ABCDEF000004"
   "active": true,
   "enforceAssociationLimit": true,
   "associationLimitHours": 24
}
Request JSON Object:

Example response:

Response:

Similar to GET instance method response. When a guest is associated, guest related fields are reported.

Status Codes:

Delete group’s hoteling hosts list

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hotelings/

Delete a list of Hoteling Hosts of a group.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/hotelings/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "hoteling_hosts": [
      "foogroup_z001@sip.netaxis.be",
      "foogroup_z002@sip.netaxis.be"
   ]
}
Request JSON Object:

  • hoteling_hosts (array) – a list of hoteling_hosts ids only.

Example response:

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

{}
Status Codes:

Delete group’s hoteling host instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/hotelings/(string: instance_name)/

Delete an Hoteling Hosts of a group.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/hotelings/foogroup_z002@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

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

{}
Status Codes:

Group Hoteling Host List Item

Name

Type

Methods

Description

GET

POST

PUT

hotelingHostId

String

C

F

F

The host’s generated ID. Returned only after POST and GET list.

firstName

String

A

R

O

The host’s first name.

lastName

String

A

R

O

The host’s last name.

deviceType

String

A

R

O

The host’s device type.

macAddress

String

A

R

O

The host’s mac address of the device.

description

String

A

O

O

The host’s description of the device.

transportProtocol

String

A

O

O

The host’s transport protocol of the device.

active

Boolean

A

O

O

The host’s active status. Default True.

associationLimitHours

Integer

A

O

O

The host’s association limit hours.

enforceAssociationLimit

Boolean

A

O

O

The host’s enforce association limit status.

removeGuestAssociation

Boolean

N

F

O

Removes any host association to guests.

is_associated

Boolean

A

F

F

The host association status.

guestAssociationDateTime

DateTime

C

F

F

The guest association date time. See Datetime.

guestLastName

String

C

F

F

The guest last name.

guestFirstName

String

C

F

F

The guest first name.

guestPhoneNumber

String

C

F

F

The guest phone number.

guestExtension

String

C

F

F

The guest extension.

guestLocationDialingCode

String

C

F

F

The guest location dialing code Groups that are part of a Enterprise.