JSON API » hotels » hotels/update

Updates an existing hotel gateway.

Input parameters

Requires authentication and the hotels role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of hotel gateway to update.Yes
cos_allIntegerID of COS when user is allowed all calls.NoCurrent value.
cos_freeIntegerID of COS when user is allowed free calls.NoCurrent value.
cos_internalIntegerID of COS when user is allowed internal calls.NoCurrent value.
cos_nationalIntegerID of COS when user is allowed national calls.NoCurrent value.
customerIntegerID of hotel customer.NoCurrent value.
gatewayStringIP address of PMS gateway.Yes
descriptionStringDescription.NoCurrent value.
nameStringName.NoCurrent value.
propertyStringIdentifier of property sent by PMS gateway. Normally empty string.NoEmpty string./td>
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.