Mews
Mews is an Hotel management software that can be integrated in HSYCO with an API connection. The current release of the I/O Server has been tested with the Mews Web API.
HSYCO Configuration
Add a MEWS I/O Server in the I/O Servers section of the Settings and set its parameters:
High Availability
- Shutdown when inactive: defaults to true.
Options
ID | Default | Values | Description |
---|---|---|---|
clienttoken | <key> | mews client token | |
accesstoken | <key> | mews access token | |
startupevents | false | true | generate IO events also during the driver’s start-up phase |
false | start generating events only after HSYCO is aligned with the current status of the system | ||
useidasdatapoints | false | true | use the ID as the resources datapoint name |
false | use the name as the resources datapoint name | ||
pollingtime | 10000 | >= 0 | time in milliseconds that Hsyco will wait before the next API check. If not set or set to 0 default is used |
retryafterinterrupt | 10 | >= 0 | if the number of 429 error codes is equal to the value set the driver will restart |
demoenv | false | true | the driver will connect to the Mews demo sandbox. It should be used for testing purposes |
false | if true, the driver will connect to the client’s instance specified by the access and client tokens | ||
booleanvalueformatlegacymode | false | true | all boolean datapoint values will be written as 1 or 0 as "true" or "false" |
false | all boolean datapoint values will be written as 1 or 0 |
Datapoints
Basic infos
ID | Value | R/W | Description |
---|---|---|---|
connection | online | R | HSYCO connection socket is open |
offline | R | HSYCO cannot create the connection socket | |
info.name | String | R | The hotel name |
info.legalenviromentcode | String | R | The hotel legal env code |
info.location.city | String | R | The hotel city |
info.location.postalcode | String | R | The hotel city postal code |
info.location.countrycode | String | R | The hotel country code |
Customers
ID | Value | R/W | Description |
---|---|---|---|
customer.<customerId>.name | String | R | The name of the user |
customer.<customerId>.lastname | String | R | The lastname of the user |
customer.<customerId>.reservation | Json | R | This datapoint contains all the reservation for given customerId, if no reservation is present an empty Json array will be given. |
Services
ID | Value | R/W | Description |
---|---|---|---|
service.<serviceId>.id | String | R | The service id |
service.<serviceId>.name | String | R | The service name |
service.<serviceId>.isactive | true | R | The service is active |
false | R | The service is NOT active | |
service.<serviceId>.isactive.alt | 1 | R | The service is active |
0 | R | The service is NOT active |
Departments
ID | Value | R/W | Description |
---|---|---|---|
department.<departmentId>.id | String | R | The department id |
department.<departmentId>.name | String | R | The department name |
department.<departmentId>.isactive | true | R | The department is active |
false | R | The department is NOT active | |
department.<departmentId>.isactive.alt | 1 | R | The department is active |
0 | R | The department is NOT active |
Resources
ID | Value | R/W | Description |
---|---|---|---|
resource.<resourceId>.id | String | R | The resource id |
resource.<resourceId>.name | String | R | The resource name |
resource.<resourceId>.isactive | true | R | the resource is active |
false | R | the resource is NOT active | |
resource.<resourceId>.isactive.alt | 1 | R | the resource is active |
0 | R | the resource is NOT active | |
resource.<resourceId>.state | Dirty | R | The resource is dirty |
Clean | R | The resource is clean | |
Inspected | R | The resource is inspected | |
OutOfService | R | The resource is Out Of Service | |
OutOfOrder | R | The resource is Out Of Order | |
resource.<resourceId>.checkedin | true | R | The resource owner is currently checked-in in that specific resource |
false | R | The resource owner is NOT currently checked-in in that specific resource | |
resource.<resourceId>.checkedin.alt | 1 | R | The resource owner is currently checked-in in that specific resource |
0 | R | The resource owner is NOT currently checked-in in that specific resource | |
resource.<resourceId>.checkedinby | String | R | If the checkedin is true, this datapoints shows the owner name and lastname |
resource.<resourceId>.checkedinbyid | String | R | If the checkedin is true, this datapoints shows the owner id |
resource.<resourceId>.reserved.today | true | R | The resource is reserved for the current day |
false | R | The resource is NOT reserved for the current day | |
resource.<resourceId>.reserved.today.alt | 1 | R | The resource is reserved for the current day |
0 | R | The resource is NOT reserved for the current day | |
resource.<resourceId>.reserved.tomorrow | true | R | The resource is reserved for the next day |
false | R | The resource is NOT reserved for the next day | |
resource.<resourceId>.reserved.tomorrow.alt | 1 | R | The resource is reserved for the next day |
0 | R | The resource is NOT reserved for the next day |
Tasks
ID | Value | R/W | Description |
---|---|---|---|
task.new | Json | W | Json that contains data for creating a new task (Read example below) |
New Task Example
In this example HSYCO is using the following format to create a new task:
INIT : {
var obj = new Object();
obj.Name = "Clean room 101";
obj.Description = "Start cleaning the room 101 asap";
obj.DeadlineUtc = "2023-02-06T18:00:00Z";
obj.DepartmentId = "915fbb82-de35-48a0-9e9b-f4a7eac711bb";
var jsonString = JSON.stringify(obj);
ioSet("mews.task.new", jsonString);
}
Where "DepartmentId" is the id of the department with the task is assignd to, you can get this id reading the "mews.department" datapoints in HSYCO and "mews." is the name of the mews I/O Server in HSYCO
Release Notes
3.10.0
- added
booleanvalueformatlegacymode
option
3.8.0
- initial release
Mews is a registered trademark of Mews Systems