JSON API » hotels » hotels/update
Updates an existing hotel gateway.
Input parameters
Requires authentication and the hotels role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | Integer | ID of hotel gateway to update. | Yes | |
| cos_all | Integer | ID of COS when user is allowed all calls. | No | Current value. |
| cos_free | Integer | ID of COS when user is allowed free calls. | No | Current value. |
| cos_internal | Integer | ID of COS when user is allowed internal calls. | No | Current value. |
| cos_national | Integer | ID of COS when user is allowed national calls. | No | Current value. |
| customer | Integer | ID of hotel customer. | No | Current value. |
| gateway | String | IP address of PMS gateway. | Yes | |
| description | String | Description. | No | Current value. |
| name | String | Name. | No | Current value. |
| property | String | Identifier of property sent by PMS gateway. Normally empty string. | No | Empty string./td> |
| validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
| Code | Description |
|---|---|
| 201 | Input passed validation. Only returned if validation=1. |
| 204 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The hotel gateway does not exist. |
Data returned
No data is returned.
Example: Changing the name
http://enswitch.example.com/api/json/hotels/update/?auth_username=user;auth_password=password;id=123;name=example{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |
