Mews

From HSYCO
Revision as of 11:04, 13 February 2023 by Christian (talk | contribs) (→‎Resources)
Jump to navigation Jump to search

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

Options

  • clienttoken: Mews client token.
  • accesstocken: Mews access token.
  • startupevents: Turn on/off the startup events.
  • useidasdatapoints: If set to false the resources data points will use the name as identifier instead of the id
  • pollingtime: Time in milliseconds that hsyco will wait before the next api check, leave blank or set it o 0 to use default polling time 10000

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 true if the service is active, false if the service is not active
false R true if the service is active, false if 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 true if the departmentis active, false if the department is not active
false R true if the departmentis active, false if 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 true if the resource active, false if the resource is not active
false R true if the resource active, false if the resource is not active
resource.<resourceId>.state Dirty R The resource state
Clean R The resource state
Inspected R The resource state
OutOfService R The resource state
OutOfOrder R The resource state
resource.<resourceId>.checkedin true R true if the resource owner is currently in checked-in in that specific resource
false R true if the resource owner is currently in 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 Shows if the resource is reserved for the current day
false R Shows if the resource is reserved for the current day
resource.<resourceId>.reserved.tomorrow true/false R Shows if the resource is reserved for the next day
false R Shows if the resource is reserved for the next day

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.8.0

  • initial release


Mews is a registered trademark of Mews Systems