{
"swagger": "2.0",
"info": {
"title": "Rezlynx API",
"version": "1.0",
"description": "The Rezlynx API is the Public API for the Rezlynx PMS, by which external parties (customers, partners and collaborators) can interact and share data with the system. It can be used for posting charges to rooms and guest folios, getting information on guests checking in to the property, and much more besides."
},
"host": "developers.azure-api.net",
"basePath": "/rezlynx-web-service",
"schemes": [
"https"
],
"paths": {
"/": {
"post": {
"description": "
Create a new event or update information about an existing event.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n EventRef | \n string | \n Event reference (if updating an existing event) | \n
\n \n ProfileRef | \n string | \n Profile reference for contact, if applicable | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n AgentRef | \n string | \n Agent reference | \n
\n \n StartDate | \n dateTime | \n Event start date-time | \n
\n \n EndDate | \n dateTime | \n Event end date-time | \n
\n \n EventStatus | \n int | \n Event status code (see below) | \n
\n \n Delegates | \n int | \n Number of delegates | \n
\n \n EventName | \n string | \n Event name | \n
\n \n Coordinator | \n string | \n Name of co-ordinator | \n
\n \n EventType | \n string | \n Event type | \n
\n \n MarketSegment | \n string | \n Market segment | \n
\n \n MediaSource | \n string | \n Media source | \n
\n \n PORef | \n string | \n Purchase Order reference | \n
\n \n InternalNotes | \n string | \n Notes (internal) | \n
\n \n EventNotes | \n string | \n Notes (event) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom 1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom 2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom 3) | \n
\n \n Token | \n string | \n Token | \n
\n \n TokenSource | \n (see below) | \n Payment token source | \n
\n \n BillingNotes | \n string | \n Notes (billing) | \n
\n \n
\nEvent status codes are as follows:
\n\n - 1 = Provisional
\n - 2 = Tentative
\n - 3 = Confirmed
\n - 4 = Guaranteed
\n - 102 = Cancelled
\n - 103 = Resident
\n - 104 = Checked out
\n
\nToken source can be one of the following:
\n\n - \"Auric\"
\n - \"Worldpay\"
\n - \"PayDollar\"
\n - \"SecureTrading\"
\n - \"PaymentExpress\"
\n
\nReturned data
\n\n - The method returns the Event reference
\n
",
"operationId": "5b6bfd0223b474139449841b",
"summary": "cnb_SaveEvent",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n \r\n PF00000001\r\n \r\n \r\n 2019-06-01T00:00:00\r\n 2019-06-01T00:00:00\r\n 1\r\n 100\r\n Windsor wedding\r\n \r\n WED\r\n Wedding\r\n BROCHURE\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Auric\r\n \r\n \r\n"
},
"description": "cnb_SaveEventSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_SaveEventSoapOut",
"examples": {
"text/xml": "\r\n \r\n EVNT00027\r\n \r\n"
}
}
}
}
}
},
"tags": [],
"x-ms-paths": {
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_GetEvent": {
"post": {
"description": "Get all the details about a specific event.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n eventRef | \n string | \n Event reference | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n EventRef | \n string | \n Event reference | \n
\n \n ProfileRef | \n string | \n Profile reference, if linked to a profile | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n AgentRef | \n string | \n Agent reference | \n
\n \n StartDate | \n dateTime | \n Event start date-time | \n
\n \n EndDate | \n dateTime | \n Event end date-time | \n
\n \n EventStatus | \n int | \n Event status code (see below) | \n
\n \n Delegates | \n int | \n Number of delegates | \n
\n \n EventName | \n string | \n Name of the event | \n
\n \n Coordinator | \n string | \n Name of the co-ordinator | \n
\n \n EventType | \n string | \n Event type | \n
\n \n MarketSegment | \n string | \n Market segment | \n
\n \n MediaSource | \n string | \n Media source | \n
\n \n PORef | \n string | \n Purchase Order reference | \n
\n \n InternalNotes | \n string | \n Notes (internal) | \n
\n \n EventNotes | \n string | \n Notes (event) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom 1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom 2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom 3) | \n
\n \n Token | \n string | \n Payment token | \n
\n \n TokenSource | \n (see below) | \n Payment token type | \n
\n \n BillingNotes | \n string | \n Notes (billing) | \n
\n \n
\nEvent status codes are as follows:
\n\n - 1 = Provisional
\n - 2 = Tentative
\n - 3 = Confirmed
\n - 4 = Guaranteed
\n - 102 = Cancelled
\n - 103 = Resident
\n - 104 = Checked out
\n
\nToken source can be one of the following:
\n\n - \"Auric\"
\n - \"Worldpay\"
\n - \"PayDollar\"
\n - \"SecureTrading\"
\n - \"PaymentExpress\"
\n
",
"operationId": "5b6bfd0223b474139449841c",
"summary": "cnb_GetEvent",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n EVNT00022\r\n"
},
"description": "cnb_GetEventSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_GetEventSoapOut",
"examples": {
"text/xml": "\r\n \r\n EVNT00022\r\n \r\n \r\n \r\n 2019-06-01T00:00:00\r\n 2019-06-02T23:59:00\r\n 1\r\n 100\r\n Indoor caber tossing finals\r\n \r\n CON\r\n CORPORATE\r\n \r\n \r\n \r\n \r\n \r\n \r\n Auric\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_CancelEvent": {
"post": {
"description": "Provides the ability to cancel an entire event, specifying a reason and notes if required.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n eventRef | \n string | \n Event reference | \n
\n \n cancelReason | \n string | \n Reason for the cancellation | \n
\n \n cancelNotes | \n string | \n Additional notes, if required | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n cnb_CancelEventResult | \n (see below) | \n indicates if the process was successful or not | \n
\n \n
\nCancel event result can be one of the following:
\n\n - \"Success\"
\n - \"EventNotFound\"
\n - \"CancellationReasonRequired\"
\n
",
"operationId": "5b6bfd0223b474139449841e",
"summary": "cnb_CancelEvent",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n EVNT00000022\r\n zombie apocalypse\r\n (not really)\r\n"
},
"description": "cnb_CancelEventSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_CancelEventSoapOut",
"examples": {
"text/xml": "\r\n Success\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_GetAllCancellationReasons": {
"post": {
"description": "Get all cancellation reasons configured for the site.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\nReturned data
\n\n - A set of event cancellation reasons
\n
\nReturned data (cancellation reason)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n CancellationPenaltiesCode | \n string | \n Cancellation code | \n
\n \n Description | \n string | \n Cancellation description | \n
\n \n Cancellation | \n boolean | \n Cancellation flag | \n
\n \n Lost | \n boolean | \n Lost flag | \n
\n \n Reinstate | \n boolean | \n Reinstate flag | \n
\n \n Inactive | \n boolean | \n Active or inactive flag | \n
\n \n RFlag | \n int | \n Flag to indicate if marked as 'deleted' | \n
\n \n
",
"operationId": "5b6bfd0223b474139449841f",
"summary": "cnb_GetAllCancellationReasons",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": ""
},
"description": "cnb_GetAllCancellationReasonsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_GetAllCancellationReasonsSoapOut",
"examples": {
"text/xml": "\r\n \r\n \r\n \r\n BER\r\n Bereavement\r\n true\r\n false\r\n false\r\n false\r\n 0\r\n \r\n \r\n COD\r\n Change Of Date\r\n true\r\n true\r\n false\r\n false\r\n 0\r\n \r\n \r\n ERR\r\n User Error\r\n true\r\n true\r\n false\r\n false\r\n 0\r\n \r\n \r\n NOS\r\n Insufficient Numbers\r\n true\r\n true\r\n false\r\n false\r\n 0\r\n \r\n \r\n WEA\r\n Weather\r\n true\r\n false\r\n false\r\n false\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_SaveFunctionBooking": {
"post": {
"description": "Save a new function booking or update an existing function booking.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters (function booking)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference (if updating an existing function booking) | \n
\n \n EventRef | \n string | \n Event reference | \n
\n \n FunctionType | \n string | \n Function type | \n
\n \n FunctionName | \n string | \n Function name | \n
\n \n FunctionStatus | \n (see below) | \n Function status | \n
\n \n StartDate | \n dateTime | \n Function start date | \n
\n \n EndDate | \n dateTime | \n Function end date | \n
\n \n Delegates | \n int | \n Number of delegates | \n
\n \n FunctionRoom | \n string | \n Function room reference | \n
\n \n FunctionLayout | \n string | \n Function layout | \n
\n \n FunctionRate | \n string | \n Function rate | \n
\n \n FunctionNotes | \n string | \n Any applicable notes | \n
\n \n FunRoomLayoutsForFunRoomID | \n (object) | \n Details of function room layouts | \n
\n \n > FunctionRoomLayoutsForFunRoomDTO | \n (object) | \n Detail of function room layout | \n
\n \n >> FunctionRoomLayoutId | \n int | \n Layout reference | \n
\n \n >> LayoutCode | \n string | \n Layout code | \n
\n \n >> FunctionRoomId | \n int | \n Function room reference | \n
\n \n >> MinCapacity | \n int | \n Minimum capacity | \n
\n \n >> MaxCapacity | \n int | \n Maximum capacity | \n
\n \n >> SetupTime | \n int | \n Set-up time | \n
\n \n >> BreakdownTime | \n int | \n Break-down time | \n
\n \n >> PictureId | \n int | \n Image reference | \n
\n \n >> LayoutDescription | \n string | \n Layout description | \n
\n \n >> DefaultLayout | \n boolean | \n Flag to indicate if this is the default layout | \n
\n \n
\nFunction status can be one of the following:
\n\n - \"ude_UserDefined1\"
\n - \"ude_UserDefined2\"
\n - \"ude_UserDefined3\"
\n - \"ude_UserDefined4\"
\n - \"ude_UserDefined5\"
\n - \"ude_UserDefined6\"
\n - \"ude_UserDefined7\"
\n - \"ude_UserDefined9\"
\n - \"ude_UserDefined10\"
\n - \"ude_UserDefined11\"
\n - \"ude_UserDefined12\"
\n - \"ude_WaitList\"
\n - \"ude_Cancelled\"
\n - \"ude_Resident\"
\n - \"ude_CheckedOut\"
\n - \"ude_NoShow\"
\n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference for this function booking | \n
\n \n
",
"operationId": "5b6bfd0223b4741394498420",
"summary": "cnb_SaveFunctionBooking",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n \r\n EVNT00027\r\n WEBF\r\n Wedding breakfast\r\n ude_UserDefined3\r\n 2019-06-01T14:00:00\r\n 2019-06-01T17:00:00\r\n 100\r\n Ballroom\r\n ROOM_HIRE\r\n VIP wedding\r\n \r\n"
},
"description": "cnb_SaveFunctionBookingSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_SaveFunctionBookingSoapOut",
"examples": {
"text/xml": "\r\n \r\n BK00000044\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_GetFunRoomLayoutsForFunRoomID": {
"post": {
"description": "Get all the available layouts for a given function room.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n roomID | \n string | \n Function room reference (room name or number) | \n
\n \n
\nReturned data
\n\n - Set of function room layouts
\n
\nReturned data (function room layout)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRoomLayoutId | \n int | \n Layout ID | \n
\n \n LayoutCode | \n string | \n Layout code | \n
\n \n FunctionRoomId | \n int | \n Function room ID | \n
\n \n MinCapacity | \n int | \n Minimum room capacity with this layout | \n
\n \n MaxCapacity | \n int | \n Maximum room capacity with this layout | \n
\n \n SetupTime | \n int | \n Layout set-up time | \n
\n \n BreakdownTime | \n int | \n Layout breakdown time | \n
\n \n PictureId | \n int | \n Picture ID, if applicable | \n
\n \n LayoutDescription | \n string | \n Layout description | \n
\n \n DefaultLayout | \n Boolean | \n Is this the default layout? | \n
\n \n
",
"operationId": "5b6bfd0223b4741394498421",
"summary": "cnb_GetFunRoomLayoutsForFunRoomID",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 1004\r\n"
},
"description": "cnb_GetFunRoomLayoutsForFunRoomIDSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_GetFunRoomLayoutsForFunRoomIDSoapOut",
"examples": {
"text/xml": "\r\n \r\n \r\n \r\n 3\r\n CABERET\r\n 4\r\n 50\r\n 200\r\n 60\r\n 60\r\n 0\r\n Caberet\r\n true\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_GetFunctionBooking": {
"post": {
"description": "Fetch all the details about a specific function booking.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Function booking reference | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function booking reference | \n
\n \n EventRef | \n string | \n Event reference | \n
\n \n FunctionType | \n string | \n Function type | \n
\n \n FunctionName | \n string | \n Function name | \n
\n \n FunctionStatus | \n string | \n Function status (see below) | \n
\n \n StartDate | \n dateTime | \n Function start date-time | \n
\n \n EndDate | \n dateTime | \n Function end date-time | \n
\n \n Delegates | \n int | \n Number of delegates | \n
\n \n FunctionRoom | \n string | \n Function room reference | \n
\n \n FunctionLayout | \n string | \n Function layout code | \n
\n \n FunctionRate | \n string | \n Function rate | \n
\n \n FunctionNotes | \n string | \n Applicable notes | \n
\n \n FunRoomLayoutsForFunRoomID | \n (object) | \n Function room layouts, if applicable | \n
\n \n
\nReturned data (function room layout)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRoomLayoutId | \n int | \n Layout ID | \n
\n \n LayoutCode | \n string | \n Layout code | \n
\n \n FunctionRoomId | \n int | \n Function room ID | \n
\n \n MinCapacity | \n int | \n Minimum room capacity with this layout | \n
\n \n MaxCapacity | \n int | \n Maximum room capacity with this layout | \n
\n \n SetupTime | \n int | \n Layout set-up time | \n
\n \n BreakdownTime | \n int | \n Layout breakdown time | \n
\n \n PictureId | \n int | \n Picture ID, if applicable | \n
\n \n LayoutDescription | \n string | \n Layout description | \n
\n \n DefaultLayout | \n Boolean | \n Is this the default layout? | \n
\n \n
\nFunction status is one of the following:
\n\n - \"ude_UserDefined1\"
\n - \"ude_UserDefined2\"
\n - \"ude_UserDefined3\"
\n - \"ude_UserDefined4\"
\n - \"ude_UserDefined5\"
\n - \"ude_UserDefined6\"
\n - \"ude_UserDefined7\"
\n - \"ude_UserDefined8\"
\n - \"ude_UserDefined9\"
\n - \"ude_UserDefined10\"
\n - \"ude_UserDefined11\"
\n - \"ude_UserDefined12\"
\n - \"ude_WaitList\"
\n - \"ude_Cancelled\"
\n - \"ude_Resident\"
\n - \"ude_CheckedOut\"
\n - \"ude_NoShow\"
\n
",
"operationId": "5b6bfd0223b4741394498422",
"summary": "cnb_GetFunctionBooking",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK00000043\r\n"
},
"description": "cnb_GetFunctionBookingSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_GetFunctionBookingSoapOut",
"examples": {
"text/xml": "\r\n \r\n BK00000043\r\n EVNT00022\r\n FDM\r\n Full Day Meeting\r\n ude_UserDefined1\r\n 2019-06-01T09:00:00\r\n 2019-06-01T17:00:00\r\n 100\r\n 1004\r\n CABERET\r\n ROOM_HIRE\r\n \r\n \r\n \r\n 3\r\n CABERET\r\n 4\r\n 50\r\n 200\r\n 60\r\n 60\r\n 0\r\n Caberet\r\n true\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_CancelFunctionBooking": {
"post": {
"description": "Cancels a function booking which is part of an event.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n eventRef | \n string | \n Event reference | \n
\n \n bookRef | \n string | \n Function booking reference | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n cnb_CancelFunctionBookingResult | \n (see below) | \n indicates if the process was successful or not | \n
\n \n
\nFunction booking result can be one of the following:
\n\n - \"Success\"
\n - \"HasDeposit\"
\n - \"NotValidForCancel\"
\n - \"BookingNotFound\"
\n - \"AlreadyCancelled
\n
",
"operationId": "5b6bfd0223b4741394498423",
"summary": "cnb_CancelFunctionBooking",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n EVNT00022\r\n BK00000043\r\n"
},
"description": "cnb_CancelFunctionBookingSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_CancelFunctionBookingSoapOut",
"examples": {
"text/xml": "\r\n Success\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_SaveDelegate": {
"post": {
"description": "This method provides the ability to save or update information about an event delegate.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference (required) | \n
\n \n RoomPickID | \n int | \n Multi-room reference (1,2,3,...) | \n
\n \n FolioID | \n int | \n Delegate folio reference (1,2,3,...) | \n
\n \n Surname | \n string | \n Delegate surname (party representative) | \n
\n \n ProfileRef | \n string | \n Profile reference, if applicable | \n
\n \n CompanyRef | \n string | \n Company reference, if applicable | \n
\n \n NoOfGuests | \n int | \n Number of guests in party | \n
\n \n Table | \n string | \n Table name, if applicable | \n
\n \n TableTime | \n string | \n Table time | \n
\n \n Token | \n string | \n Token | \n
\n \n TokenSource | \n (see below) | \n Payment token source | \n
\n \n Notes | \n string | \n Optional notes | \n
\n \n DepositPayType | \n string | \n Deposit pay type | \n
\n \n DepositAmount | \n decimal | \n Deposit amount | \n
\n \n DepositComments | \n string | \n Deposit comments | \n
\n \n
\nReturned data
\n\nToken source can be one of the following:
\n\n - \"Auric\"
\n - \"Worldpay\"
\n - \"PayDollar\"
\n - \"SecureTrading\"
\n - \"PaymentExpress\"
\n
",
"operationId": "5b6bfd0223b4741394498424",
"summary": "cnb_SaveDelegate",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n BK00000016\r\n \r\n \r\n Hart\r\n \r\n \r\n 1\r\n \r\n 12:51:21\r\n \r\n \r\n \r\n \r\n"
},
"description": "cnb_SaveDelegateSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_SaveDelegateSoapOut",
"examples": {
"text/xml": "\r\n Success\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_GetDelegate": {
"post": {
"description": "Get all the details about a given delegate.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference (required) | \n
\n \n RoomPickID | \n int | \n Multi-room reference (required) | \n
\n \n FolioID | \n int | \n Delegate folio reference (required) | \n
\n \n Surname | \n string | \n Delegate surname | \n
\n \n ProfileRef | \n string | \n Delegate profile reference | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n NoOfGuests | \n int | \n Number of guests | \n
\n \n Table | \n string | \n Table name or number | \n
\n \n TableTime | \n string | \n Table reservation time | \n
\n \n Token | \n string | \n Payment token | \n
\n \n TokenSource | \n (see below) | \n Payment token source | \n
\n \n Notes | \n string | \n Custom notes | \n
\n \n DepositPayType | \n string | \n Payment type | \n
\n \n DepositAmount | \n decimal | \n Amount | \n
\n \n DepositComments | \n string | \n Comments | \n
\n \n
\nNote only the function reference, multi-room reference and delegate reference need to be supplied.
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference | \n
\n \n RoomPickID | \n int | \n Multi-room reference | \n
\n \n FolioID | \n int | \n Delegate folio reference | \n
\n \n Surname | \n string | \n Delegate surname | \n
\n \n ProfileRef | \n string | \n Delegate profile reference | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n NoOfGuests | \n int | \n Number of guests | \n
\n \n Table | \n string | \n Table name or number | \n
\n \n TableTime | \n string | \n Table reservation time | \n
\n \n Token | \n string | \n Payment token | \n
\n \n TokenSource | \n (see below) | \n Payment token source | \n
\n \n Notes | \n string | \n Custom notes | \n
\n \n DepositPayType | \n string | \n Payment type | \n
\n \n DepositAmount | \n decimal | \n Amount | \n
\n \n DepositComments | \n string | \n Comments | \n
\n \n
\nToken source can be one of the following:
\n\n - \"Auric\"
\n - \"Worldpay\"
\n - \"PayDollar\"
\n - \"SecureTrading\"
\n - \"PaymentExpress\"
\n
",
"operationId": "5b6bfd0223b4741394498425",
"summary": "cnb_GetDelegate",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n BK00000016\r\n 1\r\n 2\r\n \r\n \r\n \r\n \r\n"
},
"description": "cnb_GetDelegateSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_GetDelegateSoapOut",
"examples": {
"text/xml": "\r\n \r\n BK00000016\r\n 1\r\n 2\r\n Jenks\r\n PF00000002\r\n \r\n 1\r\n \r\n 15:00:00\r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnb_CancelDelegate": {
"post": {
"description": "Used to remove a delegate from a function booking.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n FunctionRef | \n string | \n Function reference (required) | \n
\n \n RoomPickID | \n int | \n Multi-room reference (required) | \n
\n \n FolioID | \n int | \n Delegate folio reference (required) | \n
\n \n Surname | \n string | \n Delegate surname (party representative) | \n
\n \n ProfileRef | \n string | \n Delegate profile reference, if applicable | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n NoOfGuests | \n int | \n Number of guests | \n
\n \n Table | \n string | \n Table name or number | \n
\n \n TableTime | \n string | \n Table reservation time | \n
\n \n Token | \n string | \n Payment token | \n
\n \n TokenSource | \n (see below) | \n Payment token source | \n
\n \n Notes | \n string | \n Custom notes | \n
\n \n DepositPayType | \n string | \n Payment type | \n
\n \n DepositAmount | \n decimal | \n Amount | \n
\n \n DepositComments | \n string | \n Comments | \n
\n \n
\nNote only the function reference, multi-room reference and delegate reference need to be supplied.
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n cnb_CancelDelegateResult | \n (see below) | \n indicates if the process was successful or not | \n
\n \n
\nCancel delegate result can be one of the following:
\n\n - \"Success\"
\n - \"DelegateNotFound\"
\n - \"HasDeposits\"
\n - \"CancelFailed\"
\n
",
"operationId": "5b6bfd0223b4741394498427",
"summary": "cnb_CancelDelegate",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n BK00000016\r\n 1\r\n 3\r\n \r\n \r\n \r\n \r\n"
},
"description": "cnb_CancelDelegateSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnb_CancelDelegateSoapOut",
"examples": {
"text/xml": "\r\n Success\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_GetProfileSummaryV2": {
"post": {
"description": "This method retrieves a guest profile.
Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them. |
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
ProfileRequestor | (object) | |
> ProfileUniqueId | string | Unique profile ID, must be either a profile reference, unique email address or loyalty ID |
> ProfileUniqueIdAuthenticatorValue | string | The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below |
> AuthenticationMethod | \"PD\" | \"PD\" stands for \"Person Details\" and should always be set to this |
> AuthenticationCode | string | The method of second line authentication to be used i.e. \"Forename\", \"Surname\" or \"PostCode\" |
> AuthenticationValue | string | The authentication value, e.g. if the method is \"Surname\" and the profile is under the name of \"Jones\" then the value will be \"Jones\", if the method is \"PostCode\" then the value will be \"SY26LG\" |
Filters | \"Checked Out\", \"Resident\" or \"Future\" | Optional filter to filter results according to the reservation status |
ProfileSearchMode | \"Contact\", \"Guest\" or \"Both\" | Used to indicate whether searching for a reservation contact, reservation guest or both |
Returned data (profile)
Name | Type | Description |
---|
ProfileRef | string | Profile reference |
Salutation | string | Title |
Forename | string | Forename |
Surname | string | Surname |
EMailAddress | string | E-mail address |
Gender | string | Gender |
Street | string | Address street |
Area | string | Address area |
Town | string | Address town or city |
County | string | Address county or state |
PostCode | string | Address postcode or zip code |
Country | string | Address country |
TelephoneNo | string | Telephone number |
FaxNo | string | Fax number |
MobileNo | string | Mobile telephone number |
Nationality | string | Nationality |
Language | string | Language |
CompanyRef | string | Company reference, if applicable |
Vip | int | Integer VIP level (e.g. 1,2,3...) |
DateOfBirth | dateTime | Date of birth |
StudentID | string | Student ID, if applicable |
TypeOfPerson | \"Adult\", \"Child\" or \"Infant\" | Adult status |
PassportNumber | string | Passport number |
PreferredRoomType | string | Preferred room type |
MarketingOptIn | int | Opt-in to receive marketing information |
Smoker | int | Smoker or not |
BlackListed | int | Blacklisted or not |
LoyaltyID | string | Loyalty ID |
ProfileType | \"Private\", \"Agents\", \"Corporate\", \"TourGroup\" or \"TourSeries\" | Profile type |
ExcludeFromThirdPartyMailings | Boolean | Indicates if person chose to be excluded from third-party mailings |
Suffix | string | Name suffix |
MiddleName | string | Middle name |
AddressLine1 | string | Address line 1 |
AddressLine2 | string | Address line 2 |
State | string | Address state |
PublicNotes | string | Notes (public) |
PrivateNotes | string | Notes (private) |
CustomNotes1 | string | Notes (custom 1) |
CustomNotes2 | string | Notes (custom 2) |
CustomNotes3 | string | Notes (custom 3) |
",
"operationId": "5b6bfd0223b4741394498433",
"summary": "pmsprf_GetProfileSummaryV2",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n a6a70a2d-1ac0-4da0-815a-98cd825a822e\r\n \r\n PF000024\r\n \r\n PD\r\n Surname\r\n Valli\r\n \r\n"
},
"description": "pmsprf_GetProfileSummaryV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_GetProfileSummaryV2SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n PF000024\r\n Mr\r\n Zen\r\n Valli\r\n zunaid.valli@guestline.com\r\n U\r\n Guestline House Shrewsbury Business Park\r\n Sitka Drive\r\n Shrewsbury\r\n Shropshire\r\n SY2 6LG\r\n United Kingdom\r\n 0123456789\r\n \r\n \r\n British\r\n English\r\n \r\n 0\r\n 1754-01-01T00:00:00\r\n \r\n Adult\r\n \r\n \r\n 0\r\n 0\r\n 0\r\n \r\n Private\r\n true\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Gluten\r\n No Duvet\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_UpdateProfileSummaryV2": {
"post": {
"description": "pmsprf_UpdateProfileSummaryV2",
"operationId": "5b6bfd0223b4741394498435",
"summary": "pmsprf_UpdateProfileSummaryV2",
"parameters": [
{
"name": "pmsprf_UpdateProfileSummaryV2",
"in": "body",
"schema": {
"example": "\r\n\r\n \r\n \r\n SessionId1\r\n \r\n ProfileUniqueId1\r\n ProfileUniqueIdAuthenticatorValue1\r\n AuthenticationMethod1\r\n AuthenticationCode1\r\n AuthenticationValue1\r\n \r\n StreetAddress1\r\n AreaAddress1\r\n Town1\r\n County1\r\n Country1\r\n Postcode1\r\n TelNumber1\r\n FaxNumber1\r\n MobileNo1\r\n Email1\r\n 1\r\n Password1\r\n CompanyRef1\r\n Salutation1\r\n Forename1\r\n Surname1\r\n Greeting1\r\n 1\r\n 1\r\n 1\r\n Nationality1\r\n Language1\r\n 1900-01-01T01:01:01\r\n 1\r\n 1\r\n LoyaltyID1\r\n StudentID1\r\n Gender1\r\n PassportNumber1\r\n PreferredRoomType1\r\n true\r\n PublicNotes1\r\n PrivateNotes1\r\n CustomNotes11\r\n CustomNotes21\r\n CustomNotes31\r\n \r\n \r\n"
},
"description": "pmsprf_UpdateProfileSummaryV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_UpdateProfileSummaryV2SoapOut",
"examples": {
"text/xml": "\r\n\r\n \r\n \r\n \r\n 1\r\n ExceptionDescription1\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscom_CreateCompanyProfile": {
"post": {
"description": "Create a new Company Account / Company Profile.
Parameters
Name | Type | Description |
---|
SessionId | string | Session ID, obtained at log-in |
CompanyRef | string | Company account reference (leave blank) |
CompanyType | \"Agent\", \"Corporate\", \"TourGroup\" or \"TourSeries\" | Company type |
MarketSegment | string | Market segment |
Name | string | Company name |
Address1 | string | Company address line 1 |
Area | string | Company address area |
Town | string | Company address town or city |
County | string | Company address county or state |
Country | string | Company address country |
PostCode | string | Company address post code or zip code |
Telephone | string | Telephone number |
Fax1 | string | Fax number #1 |
Fax2 | string | Fax number #2 |
Email | string | Email address |
RegistrationNumber | string | Company registration number |
ContactProfileRef | string | Contact person profile reference |
CreditFacility | int | Credit facility ('1' for yes and '0' for no) |
CreditLimit | decimal | Amount of any credit limit |
Hold | int | Hold option ('1' for yes and '0' for no) |
ABTA | string | ABTA reference, if applicable |
ATOL | string | ATOL reference, if applicable |
IATA | string | IATA reference, if applicable |
Notes | string | Notes |
Returned data
Name | Type | Description |
---|
CompanyRef | string | Company account reference for newly created account |
",
"operationId": "5b6bfd0223b4741394498436",
"summary": "pmscom_CreateCompanyProfile",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 7ce4a576-86e0-494c-ad1c-f4de37a7017a\r\n \r\n Agent\r\n Free lunch\r\n Acme Travel Agent\r\n Guestline House\r\n Shrewsbury Business Park\r\n Shrewsbury\r\n Shropshire\r\n England\r\n SY26LG\r\n 01743282300\r\n 01743232213\r\n \r\n terri.tandy@guestline.com\r\n 123456\r\n \r\n 1\r\n 10000\r\n 0\r\n \r\n A67676\r\n \r\n \r\n"
},
"description": "pmscom_CreateCompanyProfileSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscom_CreateCompanyProfileSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n ACME00000001\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscom_UpdateCompanyProfile": {
"post": {
"description": "Update the details of an existing Company Account / Company Profile.
Parameters
Name | Type | Description |
---|
SessionId | string | Session ID, obtained at log-in |
CompanyRef | string | Company account reference |
CompanyType | \"Agent\", \"Corporate\", \"TourGroup\" or \"TourSeries\" | Company type |
MarketSegment | string | Market segment |
Name | string | Company name |
Address1 | string | Company address line 1 |
Area | string | Company address area |
Town | string | Company address town or city |
County | string | Company address county or state |
Country | string | Company address country |
PostCode | string | Company address post code or zip code |
Telephone | string | Telephone number |
Fax1 | string | Fax number #1 |
Fax2 | string | Fax number #2 |
Email | string | Email address |
RegistrationNumber | string | Company registration number |
ContactProfileRef | string | Contact person profile reference |
CreditFacility | int | Credit facility ('1' for yes and '0' for no) |
CreditLimit | decimal | Amount of any credit limit |
Hold | int | Hold option ('1' for yes and '0' for no) |
ABTA | string | ABTA reference, if applicable |
ATOL | string | ATOL reference, if applicable |
IATA | string | IATA reference, if applicable |
Notes | string | Notes |
",
"operationId": "5b6bfd0223b4741394498437",
"summary": "pmscom_UpdateCompanyProfile",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 7ce4a576-86e0-494c-ad1c-f4de37a7017a\r\n \r\n Agent\r\n Free lunch\r\n Acme Travel Agent\r\n Guestline House\r\n Shrewsbury Business Park\r\n Shrewsbury\r\n Shropshire\r\n England\r\n SY26LG\r\n 01743282300\r\n 01743232213\r\n \r\n terri.tandy@guestline.com\r\n 123456\r\n \r\n 1\r\n 10000\r\n 0\r\n \r\n A67676\r\n \r\n \r\n"
},
"description": "pmscom_UpdateCompanyProfileSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscom_UpdateCompanyProfileSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_RoomTypeList": {
"post": {
"description": "Fetch the list of all room types for the given Site ID.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
SiteID | string | Site ID |
Returned data (room type)
Name | Type | Description |
---|
RoomTypeCode | string | Room type |
RoomTypeGroupCode | string | Room type group |
Description | string | Room type description |
RoomTypeClass | \"Bedroom\", \"FunctionRoom\" or \"Other\" | Room type class |
Pax | int | Maximum capacity of room (number of people) |
SystemSource | (see below) | (internal flag) |
RFlag | int | (internal flag - indicates \"marked for deletion\") |
SystemSource can be one of the following:
- Unknown
- Rezlynx
- PublicPortal
- AgentPortal
- CorporatePortal
- Roomlynx
- CRS
- BWCRS
- WebService
",
"operationId": "5b6bfd0223b4741394498439",
"summary": "pmscfg_RoomTypeList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n VENDORCITY\r\n"
},
"description": "pmscfg_RoomTypeListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_RoomTypeListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n COTTAGE_1\r\n BEDROOMS\r\n 1 Bed Cottage\r\n Bedroom\r\n 2\r\n Rezlynx\r\n 0\r\n \r\n \r\n COTTAGE_2\r\n BEDROOMS\r\n 2 Bed Cottage\r\n Bedroom\r\n 4\r\n Rezlynx\r\n 0\r\n \r\n \r\n COTTAGE_3\r\n BEDROOMS\r\n 3 Bed Cottage\r\n Bedroom\r\n 6\r\n Rezlynx\r\n 0\r\n \r\n \r\n DBL_STANDARD\r\n BEDROOMS\r\n Standard Double\r\n Bedroom\r\n 2\r\n Rezlynx\r\n 0\r\n \r\n \r\n DBL_SUPERIOR\r\n BEDROOMS\r\n Superior Double\r\n Bedroom\r\n 2\r\n Rezlynx\r\n 0\r\n \r\n \r\n FAMILY\r\n BEDROOMS\r\n Family Room\r\n Bedroom\r\n 6\r\n Rezlynx\r\n 0\r\n \r\n \r\n FUNCTION\r\n FUNCTION\r\n General function room\r\n FunctionRoom\r\n 999\r\n Rezlynx\r\n 0\r\n \r\n \r\n MEETING_ROOM\r\n FUNCTION\r\n Meeting Room\r\n Bedroom\r\n 500\r\n Rezlynx\r\n 0\r\n \r\n \r\n PENTHOUSE\r\n BEDROOMS\r\n Penthouse Suite\r\n Bedroom\r\n 4\r\n Rezlynx\r\n 0\r\n \r\n \r\n PUBLIC\r\n PUBLIC\r\n Public Rooms\r\n Other\r\n 0\r\n Rezlynx\r\n 0\r\n \r\n \r\n SUITE\r\n BEDROOMS\r\n Suite\r\n Bedroom\r\n 4\r\n Rezlynx\r\n 0\r\n \r\n \r\n TREATMENT\r\n SPA\r\n Treatment Room\r\n Other\r\n 2\r\n Rezlynx\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_BookingSearch": {
"post": {
"description": "This is a general method for fetching bookings or reservations from the PMS. Filter parameters are used to refine\n the search, e.g. you can filter for residents-only or for a reservation with a specific booking reference, or\n search for a reservation against a specific guest name. You can use the ReturnAllGuestsInNameSearches\n parameter to determine if the method returns information on every individual guest in the room or only the\n principal guest in the room.
\n\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID | \n
\n \n Filters | \n - | \n (see below) | \n
\n \n
\nNote - we recommend to send across all parameters in the request (even the ones that are\n 'MinOccurs=0' in the WSDL) and only populate the\n ones you want to update.
\nParameters (Filters)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n BookRef | \n string | \n Booking or reservation reference | \n
\n \n RoomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n Forename | \n string | \n Guest first name | \n
\n \n Surname | \n string | \n Guest surname | \n
\n \n ForenameOrSurname | \n string | \n Used to search for a name which exists in either the forename field or the surname field | \n
\n \n ProfileRef | \n string | \n Guest profile reference | \n
\n \n LoyaltyID | \n string | \n Loyalty ID | \n
\n \n BookingStatus | \n (object) | \n Set of booking statuses to search against, see Booking status | \n
\n \n > BookingSearchBookingStatus | \n string | \n \"PreArrival\", \"Resident\", \"Cancelled\", \"CheckedOut\" or \"NoShow\", see Booking status | \n
\n \n GroupAllotmentRef | \n string | \n Group Allotment reference | \n
\n \n MultiRoomReference | \n string | \n Free text description field used as a heading for multi-room reservations | \n
\n \n RoomID | \n string | \n Room number or name | \n
\n \n ArrivalDate | \n dateTime | \n Guest planned arrival date | \n
\n \n DepartureDate | \n dateTime | \n Guest planned departure date | \n
\n \n CreationDate | \n dateTime | \n Reservation creation date | \n
\n \n BookingType | \n string | \n Booking or reservation type (see below) | \n
\n \n ShiftAllowances | \n string | \n Option to search against guest Shift\n allowances, if used: \"All\" or \"CurrentDay\" | \n
\n \n Limit | \n int | \n Limits the number of records returned, default 200 | \n
\n \n CRSRef | \n string | \n External Central Reservation System reference | \n
\n \n ReturnAllGuestsInNameSearches | \n boolean | \n Flag to indicate if all guests in the reservation should be returned or just the principal\n guest | \n
\n \n LastEditFrom | \n dateTime | \n Option to search against the date-time when the reservation was last edited ('from'\n date-time) | \n
\n \n LastEditTo | \n dateTime | \n Option to search against the date-time when the reservation was last edited ('to'\n date-time) | \n
\n \n CreatedFrom | \n dateTime | \n Option to search against the date-time when the reservation was created ('from' date-time) | \n
\n \n CreatedTo | \n dateTime | \n Option to search against the date-time when the reservation was created ('to' date-time) | \n
\n \n SystemSource | \n string | \n System origin of this reservation (see below) | \n
\n \n DistributionChannelID | \n int | \n Distribution Channel ID for reservation (if applicable) | \n
\n \n PreCheckIn | \n boolean | \n Flag to indicate if pre-checked-in or not (if applicable) | \n
\n \n RezlynxCRS | \n string | \n Rezlynx Central Reservation System reference | \n
\n \n IncludeMasterBookings | \n Boolean | \n Indicates if master bookings should be included or excluded from the returned set of reservations (see Booking Type below) !new in 1.500! | \n
\n \n
\nReturned data
\n\n - Search results consisting of a set of reservations, depending on the search filters used
\n
\nReturned data (Reservation)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n RoomId | \n string | \n Room ID (room number or name) | \n
\n \n BookRef | \n string | \n Booking or reservation reference | \n
\n \n RoomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n BookingType | \n string | \n Booking or reservation type (see below) | \n
\n \n BookingStatus | \n string | \n \"PreArrival\", \"Resident\", \"Cancelled\", \"CheckedOut\" or \"NoShow\", see Booking status | \n
\n \n RoomTypeCode | \n string | \n Room type code | \n
\n \n PackageCode | \n string | \n Package code, if part of a package | \n
\n \n Arrival | \n dateTime | \n Guest planned arrival date (reservation start) | \n
\n \n Departure | \n dateTime | \n Guest planned departure date (reservation finish) | \n
\n \n Creation | \n dateTime | \n Reservation creation date | \n
\n \n GroupAllotmentRef | \n string | \n Group Allotment reference | \n
\n \n MultiRoomReference | \n string | \n Free text description field used as a heading for multi-room reservations | \n
\n \n Contact | \n (object) | \n Contact person details, see Booking\n search objects | \n
\n \n Guests | \n (object) | \n Guest details, see Booking\n search objects | \n
\n \n Company | \n (object) | \n Name and reference for company through which reservation made, if applicable, see Booking search objects | \n
\n \n Agent | \n (object) | \n Name and reference for agent through which reservation made, if applicable, see Booking search objects | \n
\n \n Source | \n (object) | \n Name and reference for reservation source, if applicable, see Booking search objects | \n
\n \n Ledger | \n (object) | \n Name and reference for ledger, if applicable, see Booking search objects | \n
\n \n PostsAllowed | \n string | \n Indicates any posting restrictions for the reservation: either \"All\" (all postings\n allowed), \"None\" (no postings allowed) or \"CallsOnly\" (only phone postings allowed) | \n
\n \n ShiftAllowances | \n (object) | \n Set of all Shift\n allowances for the reservation, see Booking\n search objects | \n
\n \n AlarmCall | \n string | \n Alarm call time, if set | \n
\n \n MovieAccess | \n string | \n Movie Access\n code, if used | \n
\n \n FunctionBookingDescription | \n string | \n Description if function room reservation | \n
\n \n BookRefRoomPickID | \n string | \n Long-form booking reference, including Room Pick ID, e.g. \"BK000034/1\" | \n
\n \n AllowRoomMoves | \n Boolean | \n Flag to indicate if room moves are allowed | \n
\n \n EventName | \n string | \n Name, if reservation is part of a C&B event | \n
\n \n MarketSegment | \n string | \n Market segment, for marketing purposes | \n
\n \n TotalCostNett | \n decimal | \n Total cost of the booking (nett of tax) | \n
\n \n TotalCostGross | \n decimal | \n Total cost of the booking (gross, including tax) | \n
\n \n LastEdited | \n dateTime | \n Date-time the reservation was last edited or changed (not including changes made at a room\n block, group or multi-room level) | \n
\n \n GDSRef | \n string | \n GDS reference, if booking came via an external GDS | \n
\n \n CRSRef1 | \n string | \n Rezlynx CRS reference | \n
\n \n CRSRes2 | \n string | \n - | \n
\n \n CRSRef2 | \n string | \n External CRS reference, if reservation came via an external CRS | \n
\n \n SystemSource | \n string | \n System origin of this reservation (see below) | \n
\n \n DistributionChannelId | \n int | \n Distribution Channel ID, if the reservation came via a distribution channel | \n
\n \n PreCheckIn | \n boolean | \n Flag to indicate if pre-checked-in or not (if applicable) | \n
\n \n RezlynxCRS | \n string | \n Rezlynx CRS reference | \n
\n \n
\nBooking type must be one of the following:
\n\n - \"Bedroom\" = normal bedroom reservation
\n - \"Function\" = function room reservation
\n - \"Nra\" = non-resident account, i.e. not linked to a room
\n - \"Master\" = master booking
!new in 1.500!
\n
\n\n \n \n Note Master bookings are dummy room reservations, similar to an NRA but\n linked to a group or multi-room reservation. Both master bookings and NRAs can be useful for managing\n accounts. | \n
\n \n
\nSystemSource must be one of the following:
\n\n - \"Unknown\"
\n - \"Rezlynx\"
\n - \"PublicPortal\"
\n - \"AgentPortal\"
\n - \"CorporatePortal\"
\n - \"Roomlynx\"
\n - \"CRS\"
\n - \"BWCRS\"
\n - \"WebService\"
\n - \"CentralInvoicing\"
\n - \"SalesAndCatering\"
\n
",
"operationId": "5b6bfd0223b4741394498449",
"summary": "pmsbkg_BookingSearch",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n dda11037-65f5-4bf1-acb9-4fb187176e5c\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 200\r\n \r\n true\r\n \r\n \r\n 2017-08-29T09:17:45.235262\r\n 2017-09-19T09:17:45.2317592\r\n \r\n \r\n false\r\n \r\n false\r\n \r\n"
},
"description": "pmsbkg_BookingSearchSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_BookingSearchSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n \r\n BK000018\r\n 1\r\n Bedroom\r\n PreArrival\r\n DBL_STANDARD\r\n BAR_BB\r\n 2017-09-04T00:00:00\r\n 2017-09-05T00:00:00\r\n 2017-08-29T11:09:35\r\n \r\n Mr Paul Smith\r\n Mr\r\n Paul\r\n Smith\r\n Adult\r\n Male\r\n PF000066\r\n \r\n \r\n \r\n \r\n Mr Paul Smith\r\n Mr\r\n Paul\r\n Smith\r\n Adult\r\n Male\r\n PF000066\r\n \r\n 1\r\n \r\n \r\n All\r\n BK000018/1\r\n true\r\n BAR\r\n 66.6600\r\n 80.0000\r\n 2017-08-29T14:04:11\r\n \r\n \r\n \r\n Unknown\r\n 0\r\n false\r\n \r\n \r\n \r\n 112\r\n BK000019\r\n 1\r\n Bedroom\r\n PreArrival\r\n DBL_STANDARD\r\n BAR_BB\r\n 2017-09-06T00:00:00\r\n 2017-09-07T00:00:00\r\n 2017-08-29T11:12:08\r\n \r\n Mr Tom Jones\r\n Mr\r\n Tom\r\n Jones\r\n Adult\r\n Male\r\n PF000068\r\n \r\n \r\n \r\n \r\n Mr Tom Jones\r\n Mr\r\n Tom\r\n Jones\r\n Adult\r\n Male\r\n PF000068\r\n \r\n 1\r\n \r\n \r\n All\r\n BK000019/1\r\n false\r\n BAR\r\n 66.6600\r\n 80.0000\r\n 2017-08-29T11:12:08\r\n \r\n \r\n \r\n Unknown\r\n 0\r\n false\r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmschg_PostPaymentToRoom": {
"post": {
"description": "Allows the posting of payments or credits to a room bill for a resident booking.\nParameters
\nName | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
BookRef | string | Booking or reservation reference |
PaymentCode | string | Payment type code (the set of all codes can be obtained using pmscfg_PayTypeList) |
Value | decimal | Amount of payment |
Description | string | Description of payment |
FolioID | int | Folio ID, if required |
BillSplitID | int | Bill split ID, if required |
\nReturned data
\nNone",
"operationId": "5b6bfd0223b474139449844e",
"summary": "pmschg_PostPaymentToRoom",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n BK00005\r\n CASH\r\n 6.00\r\n Cash\r\n 1\r\n 0\r\n"
},
"description": "pmschg_PostPaymentToRoomSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmschg_PostPaymentToRoomSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_PreCheckIn": {
"post": {
"description": "Perform a pre-check-in of the specified reservation. Currently this does nothing except set a pre-check-in flag against the reservation, indicating that some process or event has occurred, the details of which are dependent on the operational procedures for the given customer site.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
BookRef | string | Long-format booking or reservation reference, e.g. 'BK000052/1' |
Returned data
",
"operationId": "5b6bfd0223b474139449844f",
"summary": "pmsbkg_PreCheckIn",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n BK000052/1\r\n"
},
"description": "pmsbkg_PreCheckInSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_PreCheckInSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_RoomUpgrade": {
"post": {
"description": "Request to upgrade a reservation room type and/or apply a product upsell.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
BookRef | string | Reservation reference |
RoomPickID | int | Room integer (1,2,...) |
Surname | string | Guest surname (required) |
ArrivalDate | dateTime | Arrival due date (required) |
RoomTypeCode | string | New room type |
UpsellCode | string | Upsell product code |
Value | decimal | Value of upsell |
Notes | string | Optional notes to support upgrade request |
Returned data
",
"operationId": "5b6bfd0223b4741394498450",
"summary": "pmsres_RoomUpgrade",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n BK000052\r\n 1\r\n Adams\r\n 2018-05-09T10:25:37\r\n COTTAGE_2\r\n GUARDIAN\r\n 99.00\r\n \r\n"
},
"description": "pmsres_RoomUpgradeSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_RoomUpgradeSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_GetAccounts": {
"post": {
"description": "This method provides a way of retrieving accounts from the Central Invoicing Module by providing various search criteria as parameters.\n\n
\n Parameters\n
\n
\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID | \n
\n \n likeAccountRef | \n string | \n Account reference | \n
\n \n likeAccountName | \n string | \n Account name | \n
\n \n likeStreet | \n string | \n Street | \n
\n \n likeArea | \n string | \n Area | \n
\n \n likeTown | \n string | \n Town | \n
\n \n likeCounty | \n string | \n County | \n
\n \n likeCountry | \n string | \n Country | \n
\n \n likePostcode | \n string | \n Postcode | \n
\n \n likeTelNo | \n string | \n Telephone number | \n
\n \n likeEmail | \n string | \n Email address | \n
\n \n limit | \n int | \n Maximum number of results returned | \n
\n \n likeStudentID | \n string | \n Student ID | \n
\n \n LinkedToCompany | \n string | \n Company reference, if linked to company | \n
\n \n LinkedToProfile | \n string | \n Profile reference, if linked to profile | \n
\n \n
\n
Returned data
\n
\n - A set of CIM accounts
\n
\n
Returned data (CIM account)
\n
\n \n \n Name | \n Type | \n Description | \n
\n \n Reference | \n string | \n Account reference | \n
\n \n Name | \n string | \n Account name | \n
\n \n LinkedToProfileRef | \n string | \n Profile reference linked to this account | \n
\n \n LinkedToCompanyRef | \n string | \n Company reference linked to this account | \n
\n \n DefaultAddressType | \n \"LinkedAddress\" or \"CustomAddress\" | \n Address type | \n
\n \n Street | \n string | \n Address street name | \n
\n \n Area | \n string | \n Address area | \n
\n \n Town | \n string | \n Address town or city | \n
\n \n County | \n string | \n Address county or state | \n
\n \n Country | \n string | \n Address country | \n
\n \n Postcode | \n string | \n Address post code or zip code | \n
\n \n AccountRegistrationNumber | \n string | \n Account registration number | \n
\n \n TelNo | \n string | \n Telephone number | \n
\n \n FaxNo1 | \n string | \n Fax number 1 | \n
\n \n FaxNo2 | \n string | \n Fax number 2 | \n
\n \n Email | \n string | \n Email address | \n
\n \n PaymentDays | \n int | \n Number of payment days | \n
\n \n Notes | \n string | \n Custom notes | \n
\n \n IsCreditAccount | \n boolean | \n Is this a credit account | \n
\n \n IsOnHold | \n boolean | \n Is this account on hold | \n
\n \n CreditLimit | \n decimal | \n Credit limit | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n
\n
",
"operationId": "5b6bfd0223b4741394498451",
"summary": "cim_GetAccounts",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n int\r\n string\r\n \r\n \r\n string\r\n string\r\n"
},
"description": "cim_GetAccountsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_GetAccountsSoapOut",
"examples": {
"text/xml": "\r\n \r\n int\r\n string\r\n \r\n \r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n LinkedAddress or CustomAddress\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n int\r\n string\r\n boolean\r\n boolean\r\n decimal\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n LinkedAddress or CustomAddress\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n int\r\n string\r\n boolean\r\n boolean\r\n decimal\r\n string\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_CreateAccount": {
"post": {
"description": "This method creates a new company account for the Central Invoicing Module.\n\n
\n Parameters\n
\n
\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID | \n
\n \n AccountRef | \n string | \n Account reference | \n
\n \n Name | \n string | \n Account name | \n
\n \n LinkedProfileType | \n \"NotLinked\", \"Profile\" or \"Company\" | \n Type of linked profile | \n
\n \n LinkedToProfileValue | \n string | \n Profile reference of linked profile | \n
\n \n AddressType | \n \"LinkedAddress\" or \"CustomAddress\" | \n Address type | \n
\n \n Street | \n string | \n Street | \n
\n \n AddressLine1 | \n string | \n First address line | \n
\n \n AddressLine2 | \n string | \n Second address line | \n
\n \n Area | \n string | \n Area | \n
\n \n Town | \n string | \n Town | \n
\n \n County | \n string | \n County | \n
\n \n Country | \n string | \n Country | \n
\n \n Postcode | \n string | \n Postcode | \n
\n \n AccountRegistrationNumber | \n string | \n Account registration number | \n
\n \n TelNo | \n string | \n Telephone number | \n
\n \n FaxNo1 | \n string | \n First fax number | \n
\n \n FaxNo2 | \n string | \n Second fax number | \n
\n \n Email | \n string | \n Email address | \n
\n \n PaymentDays | \n int | \n Payment days | \n
\n \n Notes | \n string | \n Account notes | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n
\n
Returned data
\n
\n
",
"operationId": "5b6bfd0223b4741394498452",
"summary": "cim_CreateAccount",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 16460170-51b1-452f-b40a-50be4492d496\r\n 12345\r\n Acme Consulting\r\n NotLinked\r\n \r\n CustomAddress\r\n Champions Avenue\r\n 27 Champions Avenue\r\n \r\n \r\n Marchess-on-Sea\r\n Worcestershire\r\n England\r\n WO45 2LX\r\n A8787373\r\n 01383500333\r\n \r\n \r\n info@acmeconsulting.com\r\n 60\r\n \r\n \r\n"
},
"description": "cim_CreateAccountSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_CreateAccountSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_UpdateAccount": {
"post": {
"description": "This method provides the ability to update account details, e.g. address, for a CIM account.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID |
AccountRef | string | Account reference |
Name | string | Account name |
LinkedProfileType | \"NotLinked\", \"Profile\" or \"Company\" | Type of linked profile |
LinkedToProfileValue | string | Linked to profile value |
AddressType | \"LinkedAddress\" or \"CustomAddress\" | Address type |
Street | string | Street |
AddressLine1 | string | First address line |
AddressLine2 | string | Second address line |
Area | string | Area |
Town | string | Town |
County | string | County |
Country | string | Country |
Postcode | string | Postcode |
AccountRegistrationNumber | string | Account registration number |
TelNo | string | Telephone number |
FaxNo1 | string | First Fax number |
FaxNo2 | string | Second Fax number |
Email | string | Email address |
PaymentDays | int | Payment days |
Notes | string | Account notes |
StudentID | string | Student ID |
Returned data
",
"operationId": "5b6bfd0223b4741394498453",
"summary": "cim_UpdateAccount",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n string\r\n string\r\n string\r\n NotLinked or Profile or Company\r\n string\r\n LinkedAddress or CustomAddress\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n int\r\n string\r\n string\r\n"
},
"description": "cim_UpdateAccountSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_UpdateAccountSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_GetTransactions": {
"post": {
"description": "This method retrieves outstanding transactions for a given CIM account.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID |
AccountRef | string | Account reference |
DocumentRef | string | Document reference |
Returned data
- A set of CIM transactions
Returned data (CIM transaction)
Name | Type | Description |
---|
AccountRef | string | Account reference |
Status | (see below) | Account status |
TimeStamp | dateTime | Transaction date-time stamp |
DocumentRef | string | Document reference |
Description | string | Account description |
GrossValue | decimal | Transaction gross value |
Balance | decimal | Current balance |
SiteID | string | Relevant Site ID |
BookRef | string | Relevant booking reference |
PaymentDue | dateTime | Date-time payment is due |
Status is one of the following:
- \"Unknown\"
- \"PendingIssue\"
- \"DebitUnPaid\"
- \"DebitPartPaid\"
- \"DebitFullyPaid\"
- \"CreditPartUsed\"
- \"CreditFullyUsed\"
- \"CreditUnused\"
",
"operationId": "5b6bfd0223b4741394498454",
"summary": "cim_GetTransactions",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 16460170-51b1-452f-b40a-50be4492d496\r\n 123455\r\n GG8883\r\n \r\n \r\n"
},
"description": "cim_GetTransactionsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_GetTransactionsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n string\r\n Unknown\r\n dateTime\r\n string\r\n string\r\n decimal\r\n decimal\r\n string\r\n string\r\n dateTime\r\n \r\n \r\n string\r\n Unknown\r\n dateTime\r\n string\r\n string\r\n decimal\r\n decimal\r\n string\r\n string\r\n dateTime\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_AddPayment": {
"post": {
"description": "This method provides the ability to add a payment onto a CIM account, if the Central Invoicing Module is enabled for the site.\nThe method also provides the option to allocate the payment to given invoices.\n\n
Parameters
\n
\n \n \n Name | \n Type | \n Description | \n
\n \n SessionId | \n string | \n Session ID | \n
\n \n AccountRef | \n string | \n Account reference | \n
\n \n PaymentCode | \n string | \n Payment code | \n
\n \n Value | \n decimal | \n Payment value | \n
\n \n Description | \n string | \n Description of payment | \n
\n \n ForDate | \n dateTime | \n Date of payment | \n
\n\t\t\t\n Allocate | \n bool | \n Flag to determine if the newly added payment would be allocated to any invoice | \n
\n\t\t\t\n Invoices | \n (AllocateInvoiceDetails, see below) | \n List of AllocateInvoiceDetails | \n
\n \n
\n\t
Parameters (AllocateInvoiceDetails)
\n\t
\n \n \n Name | \n Type | \n Description | \n
\n \n DocumentRef | \n string | \n Invoice unique identifier | \n
\n \n Value | \n decimal | \n Invoice amount | \n
\n \n
\n
Returned data
\n
\n
",
"operationId": "5b6bfd0223b4741394498455",
"summary": "cim_AddPayment",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 16460170-51b1-452f-b40a-50be4492d496\r\n 12345\r\n VISA\r\n 120.00\r\n balance due\r\n 2018-03-29T12:30:14.6042212+01:00\r\n true\r\n \r\n\t\r\n\t\tINV00001\r\n\t\t100\r\n\t\r\n \r\n\t\tINV00002\r\n\t\t200\r\n\t\r\n \r\n"
},
"description": "cim_AddPaymentSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_AddPaymentSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_GetMediaCodes": {
"post": {
"description": "Get the list of configured Media Source codes.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
Returned data (Media Codes)
Name | Type | Description |
---|
MediaSourceCode | string | Media Source code |
MediaSourceGroupCode | string | Media Source group code to which it belongs |
StartDate | dateTime | Effective start date |
EndDate | dateTime | Effective end date |
Description | string | Description |
",
"operationId": "5b6bfd0223b4741394498456",
"summary": "pmscfg_GetMediaCodes",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 655a013f-920f-4f8e-94dc-befe690370dd\r\n"
},
"description": "pmscfg_GetMediaCodesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_GetMediaCodesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n AUTUMN_2013\r\n CAMPAIGNS\r\n 2013-09-01T00:00:00\r\n 2013-11-30T00:00:00\r\n Autumn 2013 Newsletter\r\n \r\n \r\n BOOKINGCOM\r\n ONLINE\r\n 2013-08-14T00:00:00\r\n 2023-12-31T00:00:00\r\n Booking.com\r\n \r\n \r\n BROCHURE\r\n GENERAL\r\n 2002-02-02T00:00:00\r\n 2020-02-02T00:00:00\r\n Brochure\r\n \r\n \r\n FLOWER_SHOW\r\n CAMPAIGNS\r\n 2013-01-01T00:00:00\r\n 2014-12-31T00:00:00\r\n Flower Show\r\n \r\n \r\n LATEROOMS\r\n ONLINE\r\n 2013-08-14T00:00:00\r\n 2023-12-31T00:00:00\r\n Laterooms\r\n \r\n \r\n RECOMMEND\r\n GENERAL\r\n 2002-02-02T00:00:00\r\n 2020-02-02T00:00:00\r\n Recommendation\r\n \r\n \r\n REPEAT\r\n GENERAL\r\n 2002-02-02T00:00:00\r\n 2020-02-02T00:00:00\r\n Regular and Repeat Business\r\n \r\n \r\n SUMMER_2013\r\n CAMPAIGNS\r\n 2013-06-01T00:00:00\r\n 2013-08-31T00:00:00\r\n Summer 2013 Newsletter\r\n \r\n \r\n TRINITY\r\n CONF_AGENTS\r\n 2013-08-14T00:00:00\r\n 2023-12-31T00:00:00\r\n Trinity Conferences\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_CreateResDiaryBooking": {
"post": {
"description": "!restricted!
This method is not for general use.
Creates a link between a ResDairy restaurant table booking and a Rezlynx PMS reservation.
Note This method is only applicable to sites where ResDiary is enabled. |
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
BookingList | (object) | |
> Booking | (object) | |
>> ResDiaryBooking | (object) | |
>>> BookRef | string | Rezlynx reservation reference |
>>> RoomPickID | int | Rezlynx reservation room integer (1,2,...) |
>>> FolioID | int | Rezlynx reservation folio integer (1,2,...) |
>>> ResDiaryReference | string | ResDiary reference |
>>> ProfileRef | string | Rezlynx guest profile reference |
>>> MicrositeName | string | ResDiary microsite name |
Returned data
",
"operationId": "5b6bfd0223b474139449845a",
"summary": "pmsres_CreateResDiaryBooking",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n \r\n \r\n \r\n BK000052\r\n 1\r\n 1\r\n ABCD1234\r\n PF000024\r\n \r\n \r\n \r\n BK000048\r\n 1\r\n 1\r\n ABCD5678\r\n PF000025\r\n \r\n \r\n \r\n \r\n"
},
"description": "pmsres_CreateResDiaryBookingSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_CreateResDiaryBookingSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_AddReservationUpsell": {
"post": {
"description": "Provides the ability to add a reservation product to an existing booking. You can either use the value that has been configured for that product in the PMS or specify a value that will overwrite the normal price.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
UpsellItem | (object) | |
> BookRef | string | Reservation reference |
> RoomPickID | int | Room integer (1,2,...) |
> ProductCode | string | Upsell product code |
> Value | decimal | Upsell value |
> Quantity | int | Quantity, if applicable |
Returned data
",
"operationId": "5b6bfd0223b474139449845c",
"summary": "pmsres_AddReservationUpsell",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n \r\n BK000052\r\n 1\r\n PAMPER1\r\n 99.00\r\n 1\r\n \r\n"
},
"description": "pmsres_AddReservationUpsellSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_AddReservationUpsellSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_CreateProfileFeedBack": {
"post": {
"description": "Create a guest feedback entry for a given guest profile. The feedback entry can be linked to a reservation (PMS bedroom booking, function booking, conference event or CRS reservation) and can be tagged with parameters such as type, severity and priority.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
ProfileRef | string | Profile reference |
LinkedTo | \"None\", \"Bedroom\", \"EntryLevelCNB\", \"AdvCNB\" or \"CRS\" | Type of reservation this feedback entry is linked to |
LinkRef | string | Reservation reference |
LinkSubRef | int | Reservation sub-reference, if applicable |
Type | \"Complaint\", \"Positive\" or \"Suggestion\" | Type of feedback (optional) |
Priority | int | Priority number 1 to 10 (optional) |
Description | string | Free text description of the feedback comment |
Severity | \"None\", \"VerySerious\", \"Serious\", \"Reasonable\" or \"UnActionable\" | Severity rating (optional) |
Returned data
",
"operationId": "5b6bfd0223b474139449845d",
"summary": "pmsprf_CreateProfileFeedBack",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n e3acd937-568a-4276-8552-7a064207fc7c\r\n PF000079\r\n Bedroom\r\n BK000001\r\n 1\r\n Suggestion\r\n 5\r\n Lovely stay, but we would prefer running water in the bathroom\r\n None\r\n"
},
"description": "pmsprf_CreateProfileFeedBackSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_CreateProfileFeedBackSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_LinkProfile": {
"post": {
"description": "This method can be used to link a pre-existing guest profile to a reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
BookRef | string | Booking or reservation reference |
RoomPickID | int | Integer indicating which of a multi-room reservation this is (1,2,3,...) |
ProfileRef | string | Profile reference |
FolioID | int | Integer indicating which guest of a multi-folio reservation this is (1,2,3,...) |
Returned data
",
"operationId": "5b6bfd0223b4741394498461",
"summary": "pmsres_LinkProfile",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n BK000039\r\n 1\r\n PF000024\r\n 1\r\n"
},
"description": "pmsres_LinkProfileSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_LinkProfileSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No errors\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/LogIn": {
"post": {
"description": "This is the authentication method used to log in to create an API session. All subsequent methods require the SessionID
parameter which is obtained in response to this LogIn method, if successful.
Authentication
Authentication is on the basis of Site ID
, OperatorCode
, InterfaceID
and Password
. These credentials will be supplied by your Guestline representative. Note that as a further security measure, only certain API methods will be available, based on your InterfaceID.
Session management
The session expires after a period of inactivity, in which case it will be necessary to log in again and create a new session. An expired session can be identified by return code 7007 - see List of error codes.
Parameters
Name | Type | Description |
---|
SiteID | string | indicates the customer site to be accessed |
InterfaceID | int | identifies the external system accessing the API |
OperatorCode | string | account username |
Password | string | account password |
Returned data
Name | Type | Description |
---|
SessionID | string | Session ID used for all subsequent methods |
",
"operationId": "5b6bfd0223b4741394498464",
"summary": "LogIn",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n HEADLAMT\r\n 355\r\n CUSTALLIANCE\r\n w%/HUxl0M%xS7Qfv@tTOeX+@f\r\n"
},
"description": "LogInSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "LogInSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/LogOut": {
"post": {
"description": "This method is used to close an API session.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID returned from LogIn |
Returned data
",
"operationId": "5b6bfd0223b4741394498465",
"summary": "LogOut",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n"
},
"description": "LogOutSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "LogOutSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_SendProfilePassword": {
"post": {
"description": "This method instructs the Rezlynx system to send out a profile password email to the owner of the profile, i.e. the person with the given email address. The email is based on a template configured in the PMS.
Note the profile must be unique, i.e. the method will fail if there is more than one profile sharing the same email address. Uniqueness cannot be guaranteed in the system.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
strEmail | string | - |
EmailAddress | string | Person's email address, as stored in the profile |
",
"operationId": "5b6bfd0223b474139449846d",
"summary": "pmsprf_SendProfilePassword",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n george.strange@guestline.com\r\n"
},
"description": "pmsprf_SendProfilePasswordSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_SendProfilePasswordSoapOut",
"examples": {
"text/xml": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n george.strange@guestline.com\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_CancelReservation": {
"post": {
"description": "!restricted!
This method is not for general use.
Cancel a reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
strBookRef | string | Reservation reference |
strProfileRef | string | Profile reference |
strPassword | string | Password |
Returned data
Name | Type | Description |
---|
CancelReference | string | |
",
"operationId": "5b6bfd0223b474139449846f",
"summary": "pmsres_CancelReservation",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n"
},
"description": "pmsres_CancelReservationSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_CancelReservationSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n string\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_CreateReservationV2": {
"post": {
"description": "!restricted!
This method is not for general use.
Create a new reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
ProfileRef | string | Profile reference |
ArrivalDate | dateTime | Arrival date |
DepartureDate | dateTime | Departue date |
PackageCode | string | Package code, if applicable |
RoomTypeCode | string | Room type code |
NumAdults | int | Number of adults |
NumChildren | int | Number of children |
NumInfants | int | Number of infants |
ECommAuthCode | string | eCommerce authorisation code |
ECommPrePaidDepositValue | decimal | eCommerce pre-paid deposit value |
ECommPrePaidDepositPayType | string | eCommerce pre-paid deposit pay type code |
ConfEmailTemplate | string | Confirmation email template |
BookingStatus | int | Booking status code |
UpSellProducts | (object) | |
> cpmsres_ReservationProduct | (object) | |
>> ProductCode | string | Product code |
>> ForFolioId | int | Folio ID |
>> Quantity | float | Quantity |
>> NettValueEach | decimal | Net value |
>> ChargeModeOverride | \"NoOverride\", \"PerRoom\", \"PerPerson\", \"PerAdult\", \"PerChild\", \"PerInfant\" or \"SingleCharge\" | Charge mode override |
>> PostingModeOverride | \"NoOverride\", \"PostEveryBlock\" or \"PostOnArrivalBlock\" | |
MediaCode | string | Posting mode override |
Returned data
Name | Type | Description |
---|
BookRefRoomRef | string | Full format reservation reference |
",
"operationId": "5b6bfd0223b4741394498471",
"summary": "pmsres_CreateReservationV2",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n string\r\n dateTime\r\n dateTime\r\n string\r\n string\r\n int\r\n int\r\n int\r\n string\r\n decimal\r\n string\r\n string\r\n int\r\n \r\n \r\n string\r\n int\r\n float\r\n decimal\r\n NoOverride or PerRoom or PerPerson or PerAdult or PerChild or PerInfant or SingleCharge\r\n NoOverride or PostEveryBlock or PostOnArrivalBlock\r\n \r\n \r\n string\r\n int\r\n float\r\n decimal\r\n NoOverride or PerRoom or PerPerson or PerAdult or PerChild or PerInfant or SingleCharge\r\n NoOverride or PostEveryBlock or PostOnArrivalBlock\r\n \r\n \r\n string\r\n \r\n string\r\n \r\n"
},
"description": "pmsres_CreateReservationV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_CreateReservationV2SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n BK000052/1\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsfoh_GetAllocationRoomList": {
"post": {
"description": "Returns the list of available and eligible rooms from which to allocate a room to the given reservation.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n BookRef | \n string | \n Booking or reservation reference (long-form) | \n
\n \n
\nReturned data (room item)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n RoomId | \n string | \n Room reference (room name or number) | \n
\n \n RoomTypeCode | \n string | \n Room type code | \n
\n \n RoomDescription | \n string | \n Room description | \n
\n \n SubGroupCode | \n string | \n Room sub-group | \n
\n \n
",
"operationId": "5b6bfd0223b4741394498472",
"summary": "pmsfoh_GetAllocationRoomList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 639c76f8-7280-4858-a8e1-e5b809cf63db\r\n BK000054/1\r\n \r\n"
},
"description": "pmsfoh_GetAllocationRoomListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsfoh_GetAllocationRoomListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 105\r\n DBL_STANDARD\r\n Sunflower Room\r\n SUNFLOWER\r\n \r\n \r\n 106\r\n DBL_STANDARD\r\n Tulip Room\r\n TULIP\r\n \r\n \r\n 110\r\n DBL_STANDARD\r\n Standard Double\r\n DAISY\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_ReservationRoomAddDeposit": {
"post": {
"description": "Add a deposit to an existing reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
BookRefRoomRef | string | Full format reservation reference (e.g. BK000052/1) |
PaymentCode | string | Payment type code |
Value | decimal | Deposit value |
Returned data
",
"operationId": "5b6bfd0223b4741394498473",
"summary": "pmsres_ReservationRoomAddDeposit",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n BK000052/1\r\n VISA\r\n 99.00\r\n"
},
"description": "pmsres_ReservationRoomAddDepositSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_ReservationRoomAddDepositSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_GetProfileSummaryWithStays": {
"post": {
"description": "This method will fetch a summary of profile information for a given profile, along with summary information about all reservations relating to that profile. This can be filtered for past, present or future bookings.
Shared profiles Note that in the case of a profile shared at the group level, any reservations related to it when using this endpoint will only be for the site you are logged into on the web service. |
Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them. |
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
ProfileRequestor | (object) | |
> ProfileUniqueId | string | Unique profile ID, must be either a profile reference, unique email address or loyalty ID |
> ProfileUniqueIdAuthenticatorValue | string | The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below |
> AuthenticationMethod | \"PD\" | \"PD\" stands for \"Person Details\" and should always be set to this |
> AuthenticationCode | string | The method of second line authentication to be used i.e. \"Forename\", \"Surname\" or \"PostCode\" |
> AuthenticationValue | string | The authentication value, e.g. if the method is \"Surname\" and the profile is under the name of \"Jones\" then the value will be \"Jones\", if the method is \"PostCode\" then the value will be \"SY26LG\" |
Filters | \"C\", \"R\" or \"F\" | Optional filter to filter results according to the reservation status (C = Checked out, R = Resident, F = Future, i.e. pre-arrival) |
ProfileSearchMode | \"Contact\", \"Guest\" or \"Both\" | Profile search mode |
Returned data (reservation summary)
Name | Type | Description |
---|
BookRef | string | Booking or reservation reference |
RoomPickId | int | Room pick integer, if part of a multi-room reservation (1,2,3,...) |
GroupRef | string | Group reference, if applicable |
PORef | string | PO reference |
BookingStatus | int | Booking status code (see below) |
DateArrive | dateTime | Arrival date-time (start of reservation) |
DateDepart | dateTime | Departure date-time (end of reservation) |
Adults | int | Number of adults |
Children | int | Number of children |
Infants | int | Number of infants |
RoomTypeCode | string | Room type code |
PackageCode | string | Package code |
CompanyRef | string | Company reference, if applicable |
BookerTitle | string | Booker title |
BookerSurname | string | Booker surname |
BookerForename | string | Booker forename |
PrimaryGuestTitle | string | Primary guest title |
PrimaryGuestSurname | string | Primary guest surname |
PrimaryGuestForename | string | Primary guest forename |
PrimaryGuestPackageCode | string | Primary guest package code |
CreatedTimestamp | dateTime | Date-time reservation was created |
EditTimestamp | dateTime | Date-time reservation was last edited |
DepositPaid | decimal | Deposit value (paid) |
DepositDue | decimal | Deposit value (due) |
RoomId | string | Room name or number |
Charge1stNight | decimal | Gross value of charge (first night of stay) |
Charge1stNightNett | decimal | Nett value of charge (first night of stay) |
ChargeTotal | decimal | Gross total charge for stay |
ChargeTotalNett | decimal | Nett total charge for stay |
BookingType | \"Bedroom\", \"Function\" or \"Nra\" | Booking type (bedroom, function room or non-resident acount) |
Booking status codes
Code | Meaning |
---|
1-12 | Pre-arrival |
102 | Cancelled |
103 | Resident |
104 | Checked out |
",
"operationId": "5b6bfd0223b4741394498474",
"summary": "pmsprf_GetProfileSummaryWithStays",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 624337e5-e564-4278-bfbd-d25d234f3a98\r\n \r\n PF00499\r\n \r\n PD\r\n Surname\r\n Williams\r\n \r\n F\r\n"
},
"description": "pmsprf_GetProfileSummaryWithStaysSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_GetProfileSummaryWithStaysSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n Miss\r\n Megan\r\n Williams\r\n megan.williams@guestline.com\r\n \r\n \r\n BK00014\r\n 1\r\n \r\n \r\n 3\r\n 2016-06-30T00:00:00\r\n 2016-07-01T00:00:00\r\n 2\r\n 0\r\n 0\r\n DOUBLE\r\n FLEX_BB\r\n \r\n Miss\r\n Williams\r\n Megan\r\n Miss\r\n Williams\r\n Megan\r\n FLEX_BB\r\n 2016-06-16T16:28:36\r\n 0001-01-01T00:00:00\r\n 0.0000\r\n 0.0000\r\n 18\r\n 120.0000\r\n 0\r\n 120.0000\r\n 0\r\n \r\n \r\n BK00015\r\n 1\r\n \r\n \r\n 3\r\n 2016-06-30T00:00:00\r\n 2016-07-01T00:00:00\r\n 2\r\n 0\r\n 0\r\n DOUBLE\r\n FLEX_BB\r\n \r\n Miss\r\n Williams\r\n Megan\r\n Miss\r\n Williams\r\n Megan\r\n FLEX_BB\r\n 2016-06-16T16:52:32\r\n 0001-01-01T00:00:00\r\n 0.0000\r\n 0.0000\r\n 1\r\n 120.0000\r\n 0\r\n 120.0000\r\n 0\r\n \r\n \r\n BK00016\r\n 1\r\n \r\n \r\n 3\r\n 2016-06-30T00:00:00\r\n 2016-07-01T00:00:00\r\n 1\r\n 0\r\n 0\r\n DOUBLE\r\n FLEX_BB\r\n \r\n Miss\r\n Williams\r\n Megan\r\n Miss\r\n Williams\r\n Megan\r\n FLEX_BB\r\n 2016-06-16T17:00:34\r\n 0001-01-01T00:00:00\r\n 0.0000\r\n 0.0000\r\n 12\r\n 130.0000\r\n 0\r\n 130.0000\r\n 0\r\n \r\n \r\n BK00017\r\n 1\r\n \r\n \r\n 3\r\n 2016-06-30T00:00:00\r\n 2016-07-01T00:00:00\r\n 2\r\n 0\r\n 0\r\n DOUBLE\r\n FLEX_BB\r\n \r\n Miss\r\n Williams\r\n Megan\r\n Miss\r\n Williams\r\n Megan\r\n FLEX_BB\r\n 2016-06-16T17:02:33\r\n 0001-01-01T00:00:00\r\n 0.0000\r\n 0.0000\r\n 15\r\n 120.0000\r\n 0\r\n 120.0000\r\n 0\r\n \r\n \r\n BK00018\r\n 1\r\n \r\n \r\n 1\r\n 2016-08-24T00:00:00\r\n 2016-08-28T00:00:00\r\n 2\r\n 0\r\n 0\r\n DOUBLE\r\n FLEX_BB\r\n \r\n Miss\r\n Williams\r\n Megan\r\n Miss\r\n Williams\r\n Megan\r\n FLEX_BB\r\n 2016-08-24T15:39:21\r\n 0001-01-01T00:00:00\r\n 0.0000\r\n 0.0000\r\n \r\n 120.0000\r\n 0\r\n 480.0000\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_ReservationRoomAllocation": {
"post": {
"description": "Allocate a room to a reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
BookRef | string | Reservation reference |
RoomId | string | Room reference (room number or name) |
Returned data
",
"operationId": "5b6bfd0223b4741394498475",
"summary": "pmsres_ReservationRoomAllocation",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n BK000052\r\n 102\r\n"
},
"description": "pmsres_ReservationRoomAllocationSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_ReservationRoomAllocationSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsres_ReservationRoomUnAllocate": {
"post": {
"description": "Un-allocate the allocated room from a reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
BookRef | string | Reservation reference |
Returned data
",
"operationId": "5b6bfd0223b4741394498476",
"summary": "pmsres_ReservationRoomUnAllocate",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n BK000052\r\n"
},
"description": "pmsres_ReservationRoomUnAllocateSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsres_ReservationRoomUnAllocateSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_CheckIn": {
"post": {
"description": "Check-in a room. Note that a room can only be checked-in if it meets all the necessary criteria, including the current day matching the reservation arrival date and the physical room having been allocated to a reservation.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
BookRef | string | Booking or reservation reference |
AutoAddCheckInProducts | boolean | Flag to indicate if check-in product upgrades should be added automatically |
Returned data
",
"operationId": "5b6bfd0223b4741394498477",
"summary": "pmsbkg_CheckIn",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n BK000052\r\n false\r\n"
},
"description": "pmsbkg_CheckInSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_CheckInSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_CreateNewProfile": {
"post": {
"description": "Creates a new person profile, with the given details.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n Salutation | \n string | \n Title, e.g. \"Mr\" | \n
\n \n Forename | \n string | \n Forename | \n
\n \n Surname | \n string | \n Surname | \n
\n \n DateOfBirth | \n dateTime | \n Date of birth | \n
\n \n Email | \n string | \n Email address | \n
\n \n Gender | \n string | \n Gender and type of person (adult / child / infant), see below | \n
\n \n StreetAddress | \n string | \n Address street | \n
\n \n AreaAddress | \n string | \n Address area | \n
\n \n Town | \n string | \n Address town or city | \n
\n \n Postcode | \n string | \n Address postcode or zipcode | \n
\n \n County | \n string | \n Address county or state | \n
\n \n Country | \n string | \n Address country | \n
\n \n TelNumber | \n string | \n Telephone number | \n
\n \n MobileNumber | \n string | \n Mobile number | \n
\n \n FaxNumber | \n string | \n Fax number | \n
\n \n Nationality | \n string | \n Nationality | \n
\n \n Language | \n string | \n Language | \n
\n \n Password | \n string | \n Password to access the profile | \n
\n \n MarketingOptIn | \n int | \n Marketing mailing preference (0 = false, 1 = true, i.e. yes opt-in to marketing) | \n
\n \n CompanyRef | \n string | \n Company reference, if applicable | \n
\n \n LoyaltyId | \n string | \n Loyalty ID, if applicable | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n PassportNumber | \n string | \n Passport number | \n
\n \n ProfileType | \n int | \n Profile type (see below) | \n
\n \n Greeting | \n string | \n Optional preferred greeting | \n
\n \n PreferredRoomType | \n string | \n Preferred room type | \n
\n \n VipLevel | \n int | \n VIP level | \n
\n \n Smoker | \n int | \n Smoker or not (0 = false, 1 = true) | \n
\n \n BlackListed | \n int | \n Blacklisted or not (0 = false, 1 = true) | \n
\n \n ExcludeFromThirdPartyMailings | \n Boolean | \n Third-party mailing preference | \n
\n \n PublicNotes | \n string | \n Notes (public) | \n
\n \n PrivateNotes | \n string | \n Notes (private) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom #1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom #2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom #3) | \n
\n \n
\nGender can be one of these values:
\n\n - \"U\" = Adult, gender unknown (default)
\n - \"M\" = Adult male
\n - \"F\" = Adult female
\n - \"C\" = Child, gender unknown
\n - \"I\" = Infant, gender unknown
\n
\nProfileType can be one of these values:
\n\n - 0 = Private
\n - 1 = Agents
\n - 2 = Corporate
\n - 3 = TourGroup
\n - 4 = TourSeries
\n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n CreatedProfileRef | \n string | \n The profile reference for the newly created profile | \n
\n \n
",
"operationId": "5b6bfd0223b4741394498479",
"summary": "pmsprf_CreateNewProfile",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 5ba003b7-9a6d-4c4d-bf6a-bf4ccd464f23\r\n David\r\n Holden\r\n 0001-01-01T00:00:00\r\n david@digitalsauce.com\r\n M\r\n 07825887953\r\n b8efb990-4a55-479f-9ced-eeee6a0bbe7d\r\n 0\r\n \r\n \r\n 1\r\n \r\n \r\n true\r\n"
},
"description": "pmsprf_CreateNewProfileSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_CreateNewProfileSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n PF001493\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsavl_AvailAndRateV2": {
"post": {
"description": "pmsavl_AvailAndRateV2",
"operationId": "5b6bfd0223b474139449847b",
"summary": "pmsavl_AvailAndRateV2",
"parameters": [
{
"name": "pmsavl_AvailAndRateV2",
"in": "body",
"schema": {
"example": "\r\n\r\n \r\n \r\n SessionID1\r\n 1900-01-01T01:01:01\r\n 1900-01-01T01:01:01\r\n PromotionalCode1\r\n PackageCode1\r\n RoomTypeCode1\r\n RoomTypeDescriptionLike1\r\n RoomTypeGroup1\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n \r\n \r\n \r\n PackageCode1\r\n PackageNotes1\r\n RoomTypeCode1\r\n 1\r\n 1900-01-01T01:01:01\r\n 1900-01-01T01:01:01\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n \r\n \r\n \r\n PackageCode2\r\n PackageNotes2\r\n RoomTypeCode2\r\n -2147483647\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n \r\n \r\n \r\n PackageCode3\r\n PackageNotes3\r\n RoomTypeCode3\r\n 2147483647\r\n 9999-12-31T23:59:59.9999999\r\n 9999-12-31T23:59:59.9999999\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n \r\n \r\n \r\n \r\n \r\n"
},
"description": "pmsavl_AvailAndRateV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsavl_AvailAndRateV2SoapOut",
"examples": {
"text/xml": "\r\n\r\n \r\n \r\n \r\n 1\r\n ExceptionDescription1\r\n \r\n \r\n \r\n \r\n PackageCode1\r\n PackageNotes1\r\n RoomTypeCode1\r\n 1\r\n 1900-01-01T01:01:01\r\n 1900-01-01T01:01:01\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n 1\r\n \r\n \r\n \r\n PackageCode2\r\n PackageNotes2\r\n RoomTypeCode2\r\n -2147483647\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n -79228162514264337593543950335\r\n \r\n \r\n \r\n PackageCode3\r\n PackageNotes3\r\n RoomTypeCode3\r\n 2147483647\r\n 9999-12-31T23:59:59.9999999\r\n 9999-12-31T23:59:59.9999999\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n 79228162514264337593543950335\r\n \r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetCompanyAccounts": {
"post": {
"description": "Get company ledger information, for a given company.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
AccountCode | string | Company account reference code |
AccountName | string | Company account name |
Returned data (Company Account)
Name | Type | Description |
---|
CompanyRef | string | Company reference |
CompanyName | string | Company name |
HoldStatus | int | Hold status code |
CreditRemaining | decimal | Amount of credit remaining |
",
"operationId": "5b6bfd0223b474139449847d",
"summary": "pmsint_GetCompanyAccounts",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 95f79ba6-73db-4e6a-8be9-7f43d416ee82\r\n BOOTS\r\n \r\n \r\n"
},
"description": "pmsint_GetCompanyAccountsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetCompanyAccountsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n BOOTS\r\n Boots The Chemist\r\n 0\r\n 500000.0000\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmschg_LedgerFreePosting": {
"post": {
"description": "Allows postings to be made direct to a company ledger account.\nParameters
\nName | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
AccountCode | string | Account reference code |
LineItems | (object) | Set of line items (see below) |
\nParameters (line item)
\nName | Type | Description |
---|
ForDate | dateTime | Item date-time stamp |
AnalCode | string | Item sales analysis code |
Description | string | Item description |
Quantity | double | Item quantity |
GrossTotal | decimal | Item gross total amount |
\nReturned data
\nNone
",
"operationId": "5b6bfd0223b474139449847e",
"summary": "pmschg_LedgerFreePosting",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 3909309f-ab2d-4e85-92f3-92a3bfe81ca6\r\n GUESTLINE\r\n \r\n \r\n \r\n 2017-11-01T00:00:00\r\n BEV_EVEN\r\n Pauls Test\r\n 1\r\n 1.50\r\n \r\n \r\n 2017-11-02T00:00:00\r\n EPOS_BAR_PM\r\n Pauls Test\r\n 1\r\n 2.00\r\n \r\n \r\n \r\n"
},
"description": "pmschg_LedgerFreePostingSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmschg_LedgerFreePostingSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_CheckOut": {
"post": {
"description": "Perform room check-out, referenced by Room ID, Telephone extension (for PABX interfaces) or Booking reference. Note that a room can only be checked out if the room balance is zero or the booking has been configured to send the balance to a company account or sales ledger.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
CheckOutMethod | \"CheckOutMethod_RoomID\", \"CheckOutMethod_TelExtNo\" or \"CheckOutMethod_Booking_RoomRef\" | Check-out method, i.e. form of reference, either Room ID (room name or number), Telephone extension or long-form Booking reference |
CheckOutParameter | string | Value of reference parameter (depending on CheckOutMethod) |
EmailFolioBill | boolean | Flag to indicate if bill should be e-mailed |
EmailAddress | string | E-mail destination address, if bill sent out by e-mail |
Returned data
",
"operationId": "5b6bfd0223b4741394498481",
"summary": "pmsbkg_CheckOut",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n CheckOutMethod_RoomID\r\n 109\r\n true\r\n guest@acmemail.com\r\n"
},
"description": "pmsbkg_CheckOutSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_CheckOutSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n "
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsfoh_ClosePeriod": {
"post": {
"description": "Close a current financial period and open a new period.\nParameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
PeriodType | (see below) | Period type to close |
PeriodType can be one of the following:
- \"PeriodType_Shift\"
- \"PeriodType_Day\"
- \"PeriodType_Week\"
- \"PeriodType_Month\"
- \"PeriodType_Year\"
Returned data
Name | Type | Description |
---|
ClosedPeriodID | int | Period ID for closed period |
NewPeriodID | int | Period ID for newly starting period |
",
"operationId": "5b6bfd0223b4741394498482",
"summary": "pmsfoh_ClosePeriod",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n PeriodType_Day\r\n \r\n"
},
"description": "pmsfoh_ClosePeriodSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsfoh_ClosePeriodSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n 2\r\n 3\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsfoh_GetMovements": {
"post": {
"description": "This method can be used to obtain room-related movements or transactions, including check-in events, check-out events, room-moves and changes to alarm calls. If you require near-real-time notification of check-ins and check-outs then this is the method to use.
The method is called with a transaction ID, obtained from the last time the method was called, and it returns all movements or transactions since that transaction ID. The transaction ID starts at 1 and increments for each transaction in the system, indefinitely.
Wondering what value the current transaction ID is set to? You can find out by logging in to Rezlynx and accessing the INI settings. |
Note any filtering of results must be done after the method returns, there are no filter parameters. If you want more information about a room, guest or reservation, you can use pmsbkg_BookingSearch to delve deeper into the data.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID |
TransID | int | Transaction ID of the last transaction or movement from which new data is requested |
IncludeMovieAccess | Boolean | Flag to determine if Movie Access should be included in the response |
Returned data
- Returned data consists of the set of all movement items since the specified transaction ID
Returned data (Movement item)
Name | Type | Description |
---|
TransID | int | Transaction ID for this particular transaction or movement |
EntryType | int | Code for the type of movement (see below) |
EntryTimeStamp | dateTime | Date-time stamp for the transaction or movement |
RoomID | string | Room number or name |
TelNo1 | string | Room telephone extension number 1, if applicable |
TelNo2 | string | Room telephone extension number 2, if applicable |
TelNo3 | string | Room telephone extension number 3, if applicable |
TelNo4 | string | Room telephone extension number 4, if applicable |
BookRef | string | Rezlynx booking reference for the reservation |
RoomPickID | int | Room integer count used for multi-room bookings |
FolioID | int | Folio number, if more than one folio |
Salutation | string | Title for guest |
Forename | string | First name of guest |
Surname | string | Surname of guest |
AlarmTime | string | Alarm call time, if set |
Param1 | string | Optional string parameter, depends on EntryType |
Param2 | int | Optional integer parameter, depends on EntryType |
InterfacePostingMode | int | The posting mode for this room (see below) |
RoomMove | (object) | Further details, in case of a room move |
MovieAccess | string | Movie Access code |
EntryType codes
Code | Description |
---|
10 | room check-in |
20 | room check-out |
30 | room-move |
40 | change to alarm time (i.e. wake-up call) |
50 | guest check-in |
60 | guest check-out |
70 | change to ‘InterfacePostingMode’ |
80 | guest added to room |
90 | guest removed from room reservation |
100 | change to guest details |
110 | change to guest profile details |
120 | guest unlinked |
130 | change to ‘MovieAccess’ |
140 | check-out reversed or undone |
150 | room unallocated from reservation |
160 | room allocated to reservation |
Interface Posting Modes
Code | Description |
---|
0 | All allowed, i.e. all postings allowed for this room |
1 | None allowed, i.e. no postings allowed for this room |
2 | Phone only, i.e. only charges for telephone calls allowed |
",
"operationId": "5b6bfd0223b4741394498483",
"summary": "pmsfoh_GetMovements",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 8e1b1a80-61ae-411e-a8a5-863f9b32d259\r\n 866\r\n false\r\n"
},
"description": "pmsfoh_GetMovementsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsfoh_GetMovementsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 867\r\n 30\r\n 2017-10-19T15:18:07\r\n 110\r\n \r\n \r\n \r\n \r\n BK000938\r\n 1\r\n 1\r\n Mr\r\n James\r\n John\r\n \r\n 118\r\n 0\r\n 0\r\n \r\n \r\n 118\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_GetProfileEvents": {
"post": {
"description": "pmsprf_GetProfileEvents",
"operationId": "5b6bfd0223b4741394498484",
"summary": "pmsprf_GetProfileEvents",
"parameters": [
{
"name": "pmsprf_GetProfileEvents",
"in": "body",
"schema": {
"example": "\r\n\r\n \r\n \r\n SessionId1\r\n 1\r\n \r\n \r\n \r\n 1\r\n FolioCreated\r\n 1900-01-01T01:01:01\r\n AllocatedRoomID1\r\n BookRefRoomRef1\r\n GuestProfileRef1\r\n 1\r\n Forename1\r\n Surname1\r\n Title1\r\n FutureArrival\r\n 1900-01-01T01:01:01\r\n 1900-01-01T01:01:01\r\n PMSPackageCode1\r\n SPAPackageCode1\r\n BedRoom\r\n 1\r\n \r\n \r\n \r\n -9223372036854775807\r\n FolioCancelled\r\n 0001-01-01T00:00:00\r\n AllocatedRoomID2\r\n BookRefRoomRef2\r\n GuestProfileRef2\r\n -2147483647\r\n Forename2\r\n Surname2\r\n Title2\r\n CheckedIn\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n PMSPackageCode2\r\n SPAPackageCode2\r\n FunctionRoom\r\n -2147483647\r\n \r\n \r\n \r\n 9223372036854775807\r\n FolioModified\r\n 9999-12-31T23:59:59.9999999\r\n AllocatedRoomID3\r\n BookRefRoomRef3\r\n GuestProfileRef3\r\n 2147483647\r\n Forename3\r\n Surname3\r\n Title3\r\n CheckedOut\r\n 9999-12-31T23:59:59.9999999\r\n 9999-12-31T23:59:59.9999999\r\n PMSPackageCode3\r\n SPAPackageCode3\r\n NRA\r\n 2147483647\r\n \r\n \r\n \r\n \r\n \r\n"
},
"description": "pmsprf_GetProfileEventsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_GetProfileEventsSoapOut",
"examples": {
"text/xml": "\r\n\r\n \r\n \r\n \r\n 1\r\n ExceptionDescription1\r\n \r\n \r\n \r\n \r\n 1\r\n FolioCreated\r\n 1900-01-01T01:01:01\r\n AllocatedRoomID1\r\n BookRefRoomRef1\r\n GuestProfileRef1\r\n 1\r\n Forename1\r\n Surname1\r\n Title1\r\n FutureArrival\r\n 1900-01-01T01:01:01\r\n 1900-01-01T01:01:01\r\n PMSPackageCode1\r\n SPAPackageCode1\r\n BedRoom\r\n 1\r\n \r\n \r\n \r\n -9223372036854775807\r\n FolioCancelled\r\n 0001-01-01T00:00:00\r\n AllocatedRoomID2\r\n BookRefRoomRef2\r\n GuestProfileRef2\r\n -2147483647\r\n Forename2\r\n Surname2\r\n Title2\r\n CheckedIn\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n PMSPackageCode2\r\n SPAPackageCode2\r\n FunctionRoom\r\n -2147483647\r\n \r\n \r\n \r\n 9223372036854775807\r\n FolioModified\r\n 9999-12-31T23:59:59.9999999\r\n AllocatedRoomID3\r\n BookRefRoomRef3\r\n GuestProfileRef3\r\n 2147483647\r\n Forename3\r\n Surname3\r\n Title3\r\n CheckedOut\r\n 9999-12-31T23:59:59.9999999\r\n 9999-12-31T23:59:59.9999999\r\n PMSPackageCode3\r\n SPAPackageCode3\r\n NRA\r\n 2147483647\r\n \r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscom_UpdateCompanyAttribute": {
"post": {
"description": "Update the value of a custom attribute for a given Company Account.
Parameters
Name | Type | Description |
---|
SessionId | string | Session ID, obtained at log-in |
CompanyRef | string | Company Account reference |
AttributeCode | string | Attribute code (as configured on Rezlynx PMS) |
NewValue | string | New attribute value (must be a valid value for the given attribute) |
Returned data
",
"operationId": "5b6bfd0223b4741394498487",
"summary": "pmscom_UpdateCompanyAttribute",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 7ce4a576-86e0-494c-ad1c-f4de37a7017a\r\n ACME00000002\r\n ACC_STATUS\r\n option 2\r\n"
},
"description": "pmscom_UpdateCompanyAttributeSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscom_UpdateCompanyAttributeSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsfoh_GetAvailability": {
"post": {
"description": "!restricted!
This method is not for general use.
This method returns a table of room availability which mimics the 'Property Availability' screen in Rezlynx PMS. The table includes the number of available rooms for each room type for 60 days from the requested date.
Note the number of available rooms is an integer value which could be negative if the hotel has overbooked. |
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
StartDate | dateTime | Start date for start of availability block |
Returned data (availability)
Name | Type | Description |
---|
Headers | (object) | Table column headers |
> Header | (object) | Indvidual column header |
>> Day | String | Day of week, as displayed in the Rezlynx UI, e.g. \"Thu\" |
>> DisplayDate | String | Date, as displayed in the Rezlynx UI, e.g. \"02/May/2018\" |
Data | (object) | Table rows |
> Item | (object) | Individual row |
>> RoomTypeCode | String | Room type |
>> RoomTypeGroup | String | Room type group |
>> Availability | (object) | Row data |
>>> Item | Integer | Number of rooms available |
",
"operationId": "5b6bfd0223b4741394498489",
"summary": "pmsfoh_GetAvailability",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2a55028f-7680-4215-9b88-324edd2a614a\r\n 2018-05-02T12:18:57+01:00\r\n"
},
"description": "pmsavl_AvailAndRateSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsavl_AvailAndRateSoapOut",
"examples": {
"text/xml": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n Wed\r\n 02/May/2018\r\n \r\n \r\n Thu\r\n 03/May/2018\r\n \r\n \r\n Fri\r\n 04/May/2018\r\n \r\n \r\n Sat\r\n 05/May/2018\r\n \r\n \r\n Sun\r\n 06/May/2018\r\n \r\n \r\n Mon\r\n 07/May/2018\r\n \r\n \r\n Tue\r\n 08/May/2018\r\n \r\n \r\n Wed\r\n 09/May/2018\r\n \r\n \r\n Thu\r\n 10/May/2018\r\n \r\n \r\n Fri\r\n 11/May/2018\r\n \r\n \r\n Sat\r\n 12/May/2018\r\n \r\n \r\n Sun\r\n 13/May/2018\r\n \r\n \r\n Mon\r\n 14/May/2018\r\n \r\n \r\n Tue\r\n 15/May/2018\r\n \r\n \r\n Wed\r\n 16/May/2018\r\n \r\n \r\n Thu\r\n 17/May/2018\r\n \r\n \r\n Fri\r\n 18/May/2018\r\n \r\n \r\n Sat\r\n 19/May/2018\r\n \r\n \r\n Sun\r\n 20/May/2018\r\n \r\n \r\n Mon\r\n 21/May/2018\r\n \r\n \r\n Tue\r\n 22/May/2018\r\n \r\n \r\n Wed\r\n 23/May/2018\r\n \r\n \r\n Thu\r\n 24/May/2018\r\n \r\n \r\n Fri\r\n 25/May/2018\r\n \r\n \r\n Sat\r\n 26/May/2018\r\n \r\n \r\n Sun\r\n 27/May/2018\r\n \r\n \r\n Mon\r\n 28/May/2018\r\n \r\n \r\n Tue\r\n 29/May/2018\r\n \r\n \r\n Wed\r\n 30/May/2018\r\n \r\n \r\n Thu\r\n 31/May/2018\r\n \r\n \r\n Fri\r\n 01/Jun/2018\r\n \r\n \r\n Sat\r\n 02/Jun/2018\r\n \r\n \r\n Sun\r\n 03/Jun/2018\r\n \r\n \r\n Mon\r\n 04/Jun/2018\r\n \r\n \r\n Tue\r\n 05/Jun/2018\r\n \r\n \r\n Wed\r\n 06/Jun/2018\r\n \r\n \r\n Thu\r\n 07/Jun/2018\r\n \r\n \r\n Fri\r\n 08/Jun/2018\r\n \r\n \r\n Sat\r\n 09/Jun/2018\r\n \r\n \r\n Sun\r\n 10/Jun/2018\r\n \r\n \r\n Mon\r\n 11/Jun/2018\r\n \r\n \r\n Tue\r\n 12/Jun/2018\r\n \r\n \r\n Wed\r\n 13/Jun/2018\r\n \r\n \r\n Thu\r\n 14/Jun/2018\r\n \r\n \r\n Fri\r\n 15/Jun/2018\r\n \r\n \r\n Sat\r\n 16/Jun/2018\r\n \r\n \r\n Sun\r\n 17/Jun/2018\r\n \r\n \r\n Mon\r\n 18/Jun/2018\r\n \r\n \r\n Tue\r\n 19/Jun/2018\r\n \r\n \r\n Wed\r\n 20/Jun/2018\r\n \r\n \r\n Thu\r\n 21/Jun/2018\r\n \r\n \r\n Fri\r\n 22/Jun/2018\r\n \r\n \r\n Sat\r\n 23/Jun/2018\r\n \r\n \r\n Sun\r\n 24/Jun/2018\r\n \r\n \r\n Mon\r\n 25/Jun/2018\r\n \r\n \r\n Tue\r\n 26/Jun/2018\r\n \r\n \r\n Wed\r\n 27/Jun/2018\r\n \r\n \r\n Thu\r\n 28/Jun/2018\r\n \r\n \r\n Fri\r\n 29/Jun/2018\r\n \r\n \r\n Sat\r\n 30/Jun/2018\r\n \r\n \r\n \r\n - \r\n COTTAGE_1\r\n BEDROOMS\r\n \r\n
- 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n \r\n \r\n - \r\n COTTAGE_2\r\n BEDROOMS\r\n \r\n
- 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n - 1
\r\n \r\n \r\n - \r\n COTTAGE_3\r\n BEDROOMS\r\n \r\n
- 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n - 2
\r\n \r\n \r\n - \r\n DBL_STANDARD\r\n BEDROOMS\r\n \r\n
- 9
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n - 12
\r\n \r\n \r\n - \r\n DBL_SUPERIOR\r\n BEDROOMS\r\n \r\n
- 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n - 15
\r\n \r\n \r\n - \r\n FAMILY\r\n BEDROOMS\r\n \r\n
- 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 3
\r\n \r\n \r\n - \r\n PENTHOUSE\r\n BEDROOMS\r\n \r\n
- 4
\r\n - 4
\r\n - 4
\r\n - 3
\r\n - 3
\r\n - 3
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n - 4
\r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetRoomsByStatusCode": {
"post": {
"description": "Get a list of all rooms based on their occupancy status, e.g. all occupied rooms or all out-of-service rooms.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n StatusCode | \n int | \n Room status code to search against (numeric code) | \n
\n \n
\nRoom status codes are as follows:
\n\n - 2000 = Out of service
\n - 2001 = Occupied
\n - 2002 = Vacant
\n
\n\nReturned data (per room)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n strRoomID | \n string | \n Room reference (room name or number) | \n
\n \n iRFlag | \n long | \n (internal flag, indicates if record marked for deletion) | \n
\n \n strRoomDescription | \n string | \n Room description | \n
\n \n strSubGroupCode | \n string | \n Sub-group | \n
\n \n strOwnerCode | \n string | \n Owner | \n
\n \n strRoomTypeCode | \n string | \n Room type | \n
\n \n dtAvailableFrom | \n dateTime | \n Date from when room available | \n
\n \n iStatus | \n long | \n Room occupancy status code (numeric) | \n
\n \n iHKStatus | \n long | \n Housekeeping status code (numeric) | \n
\n \n strHKCode | \n string | \n Housekeeping status code (text) | \n
\n \n iAAPriority | \n long | \n Auto-Allocate priority number (highest numbers allocated first) | \n
\n \n strNextToRoomID | \n string | \n Adjacent room reference, if used | \n
\n \n strTelNo1 | \n string | \n Telephone extension number #1 | \n
\n \n strTelNo2 | \n string | \n Telephone extension number #2 | \n
\n \n strTelNo3 | \n string | \n Telephone extension number #3 | \n
\n \n strTelNo4 | \n string | \n Telephone extension number #4 | \n
\n \n strTag1 | \n string | \n Tag #1 | \n
\n \n strTag2 | \n string | \n Tag #2 | \n
\n \n iSmoke | \n long | \n Smoking room flag | \n
\n \n iPAX | \n long | \n Capacity, in number of persons | \n
\n \n iRoomIDClass | \n long | \n Room class | \n
\n \n iParam2 | \n long | \n Parameter #2 (number) | \n
\n \n strNotes | \n string | \n Notes | \n
\n \n iParam1 | \n long | \n Parameter #1 (number) | \n
\n \n
",
"operationId": "5b6bfd0223b474139449848a",
"summary": "pmsint_GetRoomsByStatusCode",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 918d8ea2-0276-4816-9c73-6af50e8de0a4\r\n 2100\r\n"
},
"description": "pmsint_GetRoomsByStatusCodeSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetRoomsByStatusCodeSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 102\r\n 0\r\n Daisy Room\r\n DAISY\r\n \r\n DBL_SUPERIOR\r\n 1899-12-30T00:00:00\r\n 2100\r\n 1300\r\n \r\n 0\r\n 101\r\n \r\n \r\n \r\n \r\n \r\n \r\n 0\r\n 2\r\n 0\r\n 0\r\n \r\n 0\r\n \r\n \r\n 103\r\n 0\r\n Primrose Room\r\n PRIMROSE\r\n \r\n DBL_SUPERIOR\r\n 1899-12-30T00:00:00\r\n 2100\r\n 1300\r\n \r\n 0\r\n 102\r\n \r\n \r\n \r\n \r\n \r\n \r\n 0\r\n 2\r\n 0\r\n 0\r\n \r\n 0\r\n \r\n \r\n 901\r\n 0\r\n The Ballroom\r\n FUNCTIONS\r\n \r\n FUNCTION\r\n 1899-12-30T00:00:00\r\n 2100\r\n 1200\r\n \r\n 0\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 0\r\n 0\r\n 50\r\n 0\r\n \r\n 0\r\n \r\n \r\n BLUEROOM\r\n 0\r\n Blue Room\r\n FIRST_FLOOR\r\n \r\n DBL_SUPERIOR\r\n 1899-12-30T00:00:00\r\n 2100\r\n 1300\r\n \r\n 0\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetRoomStatus": {
"post": {
"description": "Get room status for a given room reference, including both occupancy status and house-keeping status. If the room\n reference is blank, this method will return the room status for every room in the property.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n RoomID | \n string | \n Room reference (room name or number) | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n RoomId | \n string | \n Room reference (room name or number); leave blank to return the room status for all\n rooms | \n
\n \n RoomDescription | \n string | \n Room description | \n
\n \n SubGroupCode | \n string | \n Room sub-group | \n
\n \n RoomtypeCode | \n string | \n Room type | \n
\n \n Status | \n string | \n Room occupancy status (see below) | \n
\n \n HKStatus | \n string | \n Room housekeeping status (see below) | \n
\n \n Smoke | \n int | \n Smoking flag | \n
\n \n RoomStatusDescription | \n string | \n Room occupancy status description | \n
\n \n HKDescription | \n string | \n Room housekeeping status description | \n
\n \n
\nRoom occupancy status can be one of:
\n\n - \"Status_OutOfService\"
\n - \"Status_Occupied\"
\n - \"Status_Vacant\"
\n
\nRoom housekeeping status can be one of:
\n\n - \"HKStatus_DoNothing\"
\n - \"HKStatus_Freshen\"
\n - \"HKStatus_PartialClean\"
\n - \"HKStatus_FullClean\"
\n - \"HKStatus_Custom1\"
\n - \"HKStatus_Custom2\"
\n - \"HKStatus_Custom3\"
\n - \"HKStatus_Custom4\"
\n
\n",
"operationId": "5b6bfd0223b474139449848b",
"summary": "pmsint_GetRoomStatus",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 918d8ea2-0276-4816-9c73-6af50e8de0a4\r\n 107\r\n"
},
"description": "pmsint_GetRoomStatusSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetRoomStatusSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 107\r\n Meadow Cottage\r\n MEADOW\r\n COTTAGE_1\r\n Status_Occupied\r\n HKStatus_FullClean\r\n 0\r\n Occupied\r\n Departure / Dirty Room\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetRooms": {
"post": {
"description": "This method retrieves a list of all rooms configured in the PMS.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID obtained at log-in |
Returned data (rooms)
Name | Type | Description |
---|
RoomID | 101 | Room reference (room name or number) |
",
"operationId": "5b6bfd0223b474139449848c",
"summary": "pmsint_GetRooms",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 2368549e-1c2d-49d5-8230-b1a4a5ce9a6d\r\n"
},
"description": "pmsint_GetRoomsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetRoomsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 101\r\n \r\n \r\n 102\r\n \r\n \r\n 103\r\n \r\n \r\n 104\r\n \r\n \r\n FAMILY_ROOM\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetArrivals": {
"post": {
"description": "Retrieve a list of all arrivals on a specified date, i.e. residents guests scheduled to check-in on that day.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
ArrivalDate | dateTime | Arrival date |
Returned data (arrival)
Name | Type | Description |
---|
DepositPaid | decimal | Amount of any deposit paid |
DepositDue | decimal | Amount of any deposit |
Infants | int | Number of infants |
Children | int | Number of children |
Adults | int | Number of adults |
RoomType | string | Room type |
Package | string | Package code |
Company | string | Company name, if applicable |
Notes | string | Notes |
BookRef | string | Booking or reservation reference, e.g. 'BK000070' |
BookRefRoomRef | string | Long-format booking or reservation reference, e.g. 'BK000070/1' |
ETA | dateTime | Estimated time of arrival |
Salutation | string | Guest form of address or title |
Surname | string | Guest surname |
Forename | string | Guest forename |
RoomID | string | Room reference (room name or number) |
ProfileReference | string | Guest profile reference |
DepositOutstanding | decimal | Amount of deposit outstanding (calculated difference between deposit due and deposit paid) |
TotalNights | int | Total number of nights booked |
PrivateNotes | string | Notes (private) |
PublicNotes | string | Notes (public) |
CustomNotes1 | string | Notes (custom #1) |
CustomNotes2 | string | Notes (custom #2) |
CustomNotes3 | string | Notes (custom #3) |
ExternalNotes | string | Notes (external) |
PreCalcChargesTotalGross | decimal | Total gross amount of booking |
PreCalcChargesTotalNett | decimal | Total net amount of booking |
Master | boolean | Flag set to true if master booking |
",
"operationId": "5b6bfd0223b474139449848d",
"summary": "pmsint_GetArrivals",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n 2018-06-14T15:14:00\r\n \r\n \r\n"
},
"description": "pmsint_GetArrivalsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetArrivalsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n BAR_BB\r\n \r\n \r\n BK000071\r\n BK000071/1\r\n 1899-12-30T00:00:00\r\n Miss\r\n Jenks\r\n Sarah\r\n 111\r\n PF000090\r\n 0.0000\r\n 1\r\n \r\n \r\n \r\n \r\n \r\n \r\n 80.0000\r\n 66.6600\r\n false\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetDepartures": {
"post": {
"description": "Retrieve a list of all departures on a specified date, i.e. resident guests scheduled to check-out on that day.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
DepartureDate | dateTime | Departure date |
Returned data (departure)
Name | Type | Description |
---|
DepositPaid | decimal | Amount of any deposit paid |
DepositDue | decimal | Amount of any deposit |
Infants | int | Number of infants |
Children | int | Number of children |
Adults | int | Number of adults |
RoomType | string | Room type |
Package | string | Package code |
Company | string | Company name, if applicable |
Notes | string | Notes |
BookRef | string | Booking or reservation reference, e.g. 'BK000070' |
BookRefRoomRef | string | Long-format booking or reservation reference, e.g. 'BK000070/1' |
ETA | dateTime | Estimated time of arrival |
Salutation | string | Guest form of address or title |
Surname | string | Guest surname |
Forename | string | Guest forename |
RoomID | string | Room reference (room name or number) |
ETD | dateTime | Estimated time of departure |
PrivateNotes | string | Notes (private) |
PublicNotes | string | Notes (public) |
CustomNotes1 | string | Notes (custom #1) |
CustomNotes2 | string | Notes (custom #2) |
CustomNotes3 | string | Notes (custom #3) |
ExternalNotes | string | Notes (external) |
Master | boolean | Flag set to true if master booking |
RoomBalance | decimal | Amount of balance due |
",
"operationId": "5b6bfd0223b4741394498493",
"summary": "pmsint_GetDepartures",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n 2018-06-14T15:14:00\r\n \r\n \r\n"
},
"description": "pmsint_GetDeparturesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetDeparturesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_2\r\n 24_HOUR\r\n \r\n \r\n BK000063\r\n BK000063/1\r\n 1899-12-30T00:00:00\r\n Mr\r\n Smith\r\n Paul\r\n 108\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 234.0000\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_3\r\n BAR1\r\n \r\n \r\n BK000068\r\n BK000068/1\r\n 1899-12-30T00:00:00\r\n Mr\r\n Olteanu\r\n Mihai\r\n 109\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 201.0000\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_SUPERIOR\r\n 24_HOUR\r\n \r\n \r\n BK000065\r\n BK000065/1\r\n 1899-12-30T00:00:00\r\n Mr\r\n Test\r\n System\r\n 117\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 154.0000\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_SUPERIOR\r\n 24_HOUR\r\n \r\n \r\n BK000066\r\n BK000066/1\r\n 1899-12-30T00:00:00\r\n Mr\r\n Murray\r\n Andy\r\n 118\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 154.0000\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n 24_HOUR\r\n \r\n \r\n BK000064\r\n BK000064/1\r\n 1899-12-30T00:00:00\r\n Miss\r\n Tester\r\n Alison\r\n 120\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 139.0000\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsfoh_GetDeparturesExtended": {
"post": {
"description": "Retrieve a list of all departures on a specified date, i.e. resident guests scheduled to check-out on that day, but also with some additional information such as email address, arrival date, departure date and number of nights. A profile attribute parameter can also be specified to fetch custom attribute values stored against the guest profile.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
DepartureDate | dateTime | Departure date |
ProfileAttribute | string | Name of profile attribute (optional) |
Returned data (departure)
Name | Type | Description |
---|
DepositPaid | decimal | Amount of any deposit paid |
Infants | int | Number of infants |
Children | int | Number of children |
Adults | int | Number of adults |
RoomType | string | Room type |
Package | string | Package code |
Company | string | Company name, if applicable |
Notes | string | Notes |
BookRef | string | Booking or reservation reference, e.g. 'BK000070' |
BookRefRoomRef | string | Long-format booking or reservation reference, e.g. 'BK000070/1' |
ETA | dateTime | Estimated time of arrival |
Salutation | string | Guest form of address or title |
Surname | string | Guest surname |
Forename | string | Guest forename |
RoomID | string | Room reference (room name or number) |
Email | string | E-mail address |
ProfileReference | string | Profile reference |
Arrival | dateTime | Date of arrival |
Departure | dateTime | Date of departure |
TotalNights | int | Total number of nights of stay |
AttributeValue | string | Profile attribute value for specified profile attribute, if requested |
ETD | dateTime | Estimated time of departure |
PrivateNotes | string | Notes (private) |
PublicNotes | string | Notes (public) |
CustomNotes1 | string | Notes (custom #1) |
CustomNotes2 | string | Notes (custom #2) |
CustomNotes3 | string | Notes (custom #3) |
ExternalNotes | string | Notes (external) |
Master | boolean | Flag set to true if master booking |
RoomBalance | decimal | Amount of balance due |
BookingType | \"Bedroom\", \"Function\" or \"Nra\" | Booking type (bedroom, function room or non-resident account) |
",
"operationId": "5b6bfd0223b4741394498494",
"summary": "pmsfoh_GetDeparturesExtended",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n 2018-06-14T15:14:00\r\n ???\r\n \r\n"
},
"description": "pmsfoh_GetDeparturesExtendedSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsfoh_GetDeparturesExtendedSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n 0\r\n 0\r\n 0\r\n 1\r\n COTTAGE_1\r\n 24_HOUR\r\n \r\n \r\n BK000073\r\n BK000073/1\r\n 1899-12-30T00:00:00\r\n Mr\r\n Jones\r\n Chris\r\n \r\n \r\n 2018-06-28T00:00:00\r\n 2018-06-29T00:00:00\r\n 1\r\n 1899-12-30T00:00:00\r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n 0\r\n Bedroom\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetResidents": {
"post": {
"description": "Retrieves a list of resident bookings, either currently resident (if no dates are provided), or over a specified period (if dates are given).
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
FromDate | dateTime | Optional from-date |
ToDate | dateTime | Optional to-date |
BookingType | \"bkt_Bedroom\", \"bkt_FunctionRoom\" or \"bkt_NRA\" | Booking type - either bedroom, function room, NRA (Non Resident Account), or all (if nothing specified) |
Returned data (resident)
Name | Type | Description |
---|
DepositPaid | decimal | Amount of deposit already paid |
DepositDue | decimal | Amount of deposit due |
Infants | int | Number of infants |
Children | int | Number of children |
Adults | int | Number of adults |
RoomType | string | Room type code |
Package | string | Package code |
Company | string | Company name |
Notes | string | Optional notes |
BookRef | string | Reservation or booking reference |
BookRefRoomRef | string | Long-format reservation reference, e.g. \"BK000054/1\" |
ETA | dateTime | Estimated time of arrival |
Arrival | dateTime | Arrival date |
Departure | dateTime | Departure date |
Salutation | string | Guest form of address |
Surname | string | Guest surname |
Forename | string | Guest forename |
RoomID | string | Room reference (room number or name) |
MovieAccess | string | Movie Access code |
PrivateNotes | string | Notes (private) |
PublicNotes | string | Notes (public) |
CustomNotes1 | string | Notes (custom #1) |
CustomNotes2 | string | Notes (custom #2) |
CustomNotes3 | string | Notes (custom #3) |
ExternalNotes | string | Notes (external) |
Master | boolean | Master reservation flag |
",
"operationId": "5b6bfd0223b4741394498495",
"summary": "pmsint_GetResidents",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 918d8ea2-0276-4816-9c73-6af50e8de0a4\r\n 2018-05-01T10:31:59\r\n 2018-05-31T10:31:59\r\n \r\n"
},
"description": "pmsint_GetResidentsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetResidentsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n PENTHOUSE\r\n BAR_BB\r\n \r\n \r\n BK000051\r\n BK000051/1\r\n 1899-12-30T00:00:00\r\n 2018-05-05T00:00:00\r\n 2018-05-08T00:00:00\r\n \r\n Galli\r\n Matteo\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n -7.7700\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_2\r\n BAR_BB\r\n \r\n \r\n BK000052\r\n BK000052/1\r\n 1899-12-30T00:00:00\r\n 2018-05-09T00:00:00\r\n 2018-05-16T00:00:00\r\n Mr\r\n Adams\r\n Mike\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n BAR_RO\r\n \r\n \r\n BK000053\r\n BK000053/1\r\n 1899-12-30T00:00:00\r\n 2018-05-16T00:00:00\r\n 2018-05-19T00:00:00\r\n \r\n Galli\r\n Matteo\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n BAR_RO\r\n \r\n \r\n BK000054\r\n BK000054/1\r\n 1899-12-30T00:00:00\r\n 2018-05-15T00:00:00\r\n 2018-05-18T00:00:00\r\n \r\n Galli\r\n Matteo\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n INC_FULL\r\n \r\n \r\n BK000055\r\n BK000055/1\r\n 1899-12-30T00:00:00\r\n 2018-05-10T00:00:00\r\n 2018-05-11T00:00:00\r\n \r\n Adams\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_STANDARD\r\n INC_FULL\r\n Boots The Chemist\r\n \r\n BK000044\r\n BK000044/3\r\n 1899-12-30T00:00:00\r\n 2018-05-01T00:00:00\r\n 2018-05-03T00:00:00\r\n \r\n Adams Doggie\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_1\r\n FLOWER_SHOW\r\n \r\n \r\n BK000058\r\n BK000058/1\r\n 1899-12-30T00:00:00\r\n 2018-05-23T00:00:00\r\n 2018-05-24T00:00:00\r\n Mr\r\n Smith\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_1\r\n 24_HOUR\r\n \r\n \r\n BK000059\r\n BK000059/1\r\n 1899-12-30T00:00:00\r\n 2018-05-29T00:00:00\r\n 2018-05-30T00:00:00\r\n Mrs\r\n Windsor\r\n Elizabeth\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n DBL_SUPERIOR\r\n INC_FULL\r\n \r\n \r\n BK000050\r\n BK000050/1\r\n 1899-12-30T00:00:00\r\n 2018-05-01T00:00:00\r\n 2018-05-02T00:00:00\r\n Ms\r\n Bobbin\r\n Claire\r\n 104\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n FUNCTION\r\n FUNC_RO_HALF\r\n \r\n \r\n BK000056\r\n BK000056/1\r\n 1899-12-30T00:00:00\r\n 2018-05-10T09:00:00\r\n 2018-05-18T00:00:00\r\n Mr\r\n Adams\r\n Mike\r\n 901\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n 0\r\n 0.0000\r\n 0\r\n 0\r\n 1\r\n COTTAGE_1\r\n 24_HOUR\r\n \r\n guest likes extra pillows\r\n BK000057\r\n BK000057/1\r\n 1899-12-30T00:00:00\r\n 2018-05-17T00:00:00\r\n 2018-05-18T00:00:00\r\n Mr\r\n Agg\r\n James\r\n COTAMARYLLIS\r\n \r\n guest likes extra pillows\r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetRoomBalances": {
"post": {
"description": "Retrieve a list of all room balances across the entire site.\nParameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
Returned data (balance item)
Name | Type | Description |
---|
Balance | decimal | Balance amount |
Package | string | Package code |
BookRef | string | Booking or reservation reference, e.g. \"BK000052\" |
BookRefRoomRef | string | Long-format booking or reservation reference, e.g. \"BK000052/1\" |
Arrival | dateTime | Arrival date |
Departure | dateTime | Departure date |
Surname | string | Guest surname |
RoomID | string | Room reference (room number or name) |
",
"operationId": "5b6bfd0223b4741394498496",
"summary": "pmsint_GetRoomBalances",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n \r\n"
},
"description": "pmsint_GetRoomBalancesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetRoomBalancespOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 5486.5900\r\n BAR_BB\r\n BK000032\r\n BK000032/1\r\n 2018-02-06T00:00:00\r\n 2018-02-07T00:00:00\r\n X\r\n 101\r\n \r\n \r\n 937.7300\r\n 24_HOUR\r\n BK000033\r\n BK000033/1\r\n 2018-02-06T00:00:00\r\n 2018-02-08T00:00:00\r\n Adams\r\n 102\r\n \r\n \r\n 209.0000\r\n 24_HOUR\r\n BK000057\r\n BK000057/1\r\n 2018-05-17T00:00:00\r\n 2018-05-18T00:00:00\r\n Agg\r\n COTAMARYLLIS\r\n \r\n \r\n \r\n "
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetFinancialReport": {
"post": {
"description": "This method is used to get a pre-configured financial report from the Rezlynx system, formatted in XML. The report structure must be pre-configured in Rezlynx (under System > Tools > Financial Report Export).\nParameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
SelectionCriteria | (XmlDocument) | Selection criteria |
PeriodID | int | Period ID |
KepyoReport | Boolean | Kepyo report flag |
KepyoUserDef1 | string | Kepyo user parameter #1 |
KepyoUserDef2 | string | Kepyo user parameter #2 |
Returned data
<Data><DOCUMENT><DEPOSITANALYSIS><DEPOSITANALYSISTOTALS><DEP_BFWD><DESCRIPTION>Deposit Balance Brought Forward</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_BFWD><DEP_RECVD><DESCRIPTION>Deposits Received</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_RECVD><DEP_REFUD><DESCRIPTION>Deposits Refunded</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_REFUD><DEP_RETND><DESCRIPTION>Deposits Retained</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_RETND><DEP_INHOUSE><DESCRIPTION>Deposits InHouse/InUse</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_INHOUSE><DEP_BAL_ACT><DESCRIPTION>Deposit Balance (Actual)</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_BAL_ACT></DEPOSITANALYSISTOTALS><DEPOSITANALYSISTRANS><DEP_RECVD><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_RECVD><DEP_REFUD><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_REFUD><DEP_RETND><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_RETND><DEP_INHOUSE><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_INHOUSE></DEPOSITANALYSISTRANS></DEPOSITANALYSIS></DOCUMENT></Data>
",
"operationId": "5b6bfd0223b4741394498497",
"summary": "pmsint_GetFinancialReport",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n\r\n \r\n \r\n SessionID1\r\n text1900-01-01T01:01:011900-01-01T01:01:01Title1Forename1Surname1Telephone1Mobile1Email11EventName1EnquiryNotes1\r\n 1\r\n \r\n Data1\r\n \r\n true\r\n KepyoUserDef11\r\n KepyoUserDef21\r\n \r\n \r\n"
},
"description": "pmsint_GetFinancialReportSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetFinancialReportSoapOut",
"examples": {
"text/xml": "\r\n 8f8e0e90-a9d6-4f29-b694-5aa1d773288d\r\n \r\n test\r\n \r\n 1\r\n false\r\n STREETNUMBER\r\n BUSINESSTYPE\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_SendEmail": {
"post": {
"description": "Send an e-mail from the logged-on web service user account to an internal recipient within the same site (same Site ID).
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
Recipient | string | Email address of recipient |
Subject | string | Email subject |
Body | string | Email body content |
Returned data
",
"operationId": "5b6bfd0223b4741394498498",
"summary": "pmsint_SendEmail",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 918d8ea2-0276-4816-9c73-6af50e8de0a4 \r\n whoever@acme.com\r\n GDPR compliance\r\n Please confirm compliance with new EU regulation as per previous correspondence.\r\n\r\nKind regards,\r\n\r\nP Panther\r\n"
},
"description": "pmsint_SendEmailSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_SendEmailSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetPeriodList": {
"post": {
"description": "Get financial period information for either a period ID or period type.\n\nParameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
iPeriodID | int | Period ID |
enmPeriodType | short | Period type code |
Returned data (period list item)
Name | Type | Description |
---|
strKey | string | ? |
iPeriodTypeID | long | Period type ID |
strPeriodDescription | string | Period description |
iPeriodType | \"ppt_EndOfShift\", \"ppt_EndOfDay\", \"ppt_EndOfWeek\", \"ppt_EndOfMonth\" or \"ppt_EndOfYear\" | Period type |
iPeriodID | long | Period ID |
dtOpenPeriod | dateTime | Date and time period opened |
dtClosePeriod | dateTime | Date and time period closed |
iStatus | \"psf_Open\", \"psf_Closing\" or \"psf_Closed\" | Period current status (open, closing or closed) |
strOperatorCode | string | Operator |
",
"operationId": "5b6bfd0223b4741394498499",
"summary": "pmsint_GetPeriodList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 639c76f8-7280-4858-a8e1-e5b809cf63db\r\n 1\r\n 2\r\n \r\n"
},
"description": "pmsint_GetPeriodListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsint_GetPeriodListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 3\r\n 999\r\n \r\n ppt_EndOfDay\r\n 3\r\n 1990-01-01T00:00:00\r\n 2017-10-17T14:13:10\r\n psf_Closed\r\n MCCORMICKP\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_HouseKeepingCodes": {
"post": {
"description": "Return the list of configured housekeeping status codes and descriptions, i.e. corresponding to 'Clean', 'Dirty',\n etc.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n
\nReturned data (housekeeping code)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n iRoomStatusID | \n int | \n Housekeeping code (numeric) | \n
\n \n iParameter1 | \n int | \n (internal use only) | \n
\n \n strDescription | \n string | \n Text description, as it appears on the screen | \n
\n \n strDisplayCode | \n string | \n Text abbreviation, as it appears in abbreviated form | \n
\n \n
\n|",
"operationId": "5b6bfd0223b474139449849a",
"summary": "pmscfg_HouseKeepingCodes",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n a6a70a2d-1ac0-4da0-815a-98cd825a822e\r\n"
},
"description": "pmscfg_HouseKeepingCodesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_HouseKeepingCodesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 1000\r\n 0\r\n Room is Clean\r\n CLEAN\r\n \r\n \r\n 1100\r\n 0\r\n Sheet Change\r\n SHEET\r\n \r\n \r\n 1200\r\n 0\r\n Stayover \r\n STAY\r\n \r\n \r\n 1300\r\n 0\r\n Departure / Dirty Room\r\n DIRTY\r\n \r\n \r\n 1400\r\n 0\r\n Unknown1\r\n UserDefined1\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_AnalList": {
"post": {
"description": "This method returns the list of Sales Analysis Codes used by the PMS, e.g. BARFOOD, BARDRINK, PHONE, etc. Charges should be posted against the appropriate code when using a posting method such as pmschg_PostToRoom. Note that the particular codes in use are customisable on the PMS and will vary from site to site.\nParameters
\nName | Type | Description |
---|
SessionID | string | Session ID |
\nReturned data
\nName | Type | Description |
---|
AnalCode | string | Name of the analysis code, e.g. \"BARFOOD\" |
Description | string | Short description of the analysis code, e.g. \"food served in bar room\" |
GroupCode | string | Name of the group to which this code belongs, e.g. \"FOOD\" |
TaxRule | string | Name of the tax rule which applies to this analysis code, e.g. \"VAT_20\" |
Usage | string | \"acr_NoRestrictions\" or \"acr_InternalPostingsOnly\" or \"acr_ExternalPostingsOnly\" |
",
"operationId": "5b6bfd0223b474139449849b",
"summary": "pmscfg_AnalList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 723c4f82-22cc-47a8-ba77-f87bbe53f045\r\n \r\n \r\n"
},
"description": "pmscfg_AnalListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_AnalListSoapOut",
"examples": {
"text/xml": " \r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n ACCOM\r\n Accommodation\r\n ACCOM\r\n VAT_20\r\n acr_NoRestrictions\r\n \r\n \r\n ACCOM_4\r\n Accommodation 4% VAT\r\n ACCOM\r\n VAT_04\r\n acr_NoRestrictions\r\n \r\n \r\n BAR\r\n Bar Items\r\n CATERING\r\n VAT_20\r\n acr_NoRestrictions\r\n \r\n \r\n WEDD_WINE\r\n Wedding Wine\r\n WEDDING\r\n VAT_20\r\n acr_NoRestrictions\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_PayTypeList": {
"post": {
"description": "This method returns the list of Payment Types used by the PMS, e.g. Cash, Visa, Mastercard. Payments which are posted to the room should be posted with the appropriate Payment Type, e.g. using pmschg_PostPaymentToRoom. Note that the particular payment types in use are customisable on the PMS and will vary from site to site.\nParameters
\nName | Type | Description |
---|
SessionID | string | Session ID |
\nReturned Data
\nName | Type | Description |
---|
PayCode | string | Name of payment type |
Description | string | Description of payment type |
LedgerCode | string | Payment type code as appears on ledger accounts |
CreditCardType | string | Credit card type code |
",
"operationId": "5b6bfd0223b474139449849c",
"summary": "pmscfg_PayTypeList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 723c4f82-22cc-47a8-ba77-f87bbe53f045\r\n \r\n \r\n"
},
"description": "pmscfg_PayTypeListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_PayTypeListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No Error\r\n \r\n \r\n \r\n \r\n AMEX\r\n American Express\r\n \r\n 600\r\n \r\n \r\n CASH\r\n Cash\r\n \r\n \r\n \r\n \r\n MASTERCARD\r\n Mastercard\r\n \r\n 700\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsdev_HeartBeat": {
"post": {
"description": "Maintains an active link between the Rezlynx server and client device
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
strDeviceParam | string | ? |
strClientLanIPAddress | string | ? |
strClientLanName | string | ? |
Returned data
",
"operationId": "5b6bfd0223b474139449849f",
"summary": "pmsdev_HeartBeat",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n string\r\n string\r\n string\r\n \r\n"
},
"description": "pmsdev_HeartBeatSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsdev_HeartBeatSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_RoomFolioItemsAndBalance": {
"post": {
"description": "This method returns the current itemised bill or folio for a resident guest.\n\n
\n Parameters\n
\n
\n \n \n Name | \n Type | \n Description | \n
\n \n \n \n SessionID | \n string | \n Session ID | \n
\n \n RoomID | \n String | \n Room name or number | \n
\n \n FolioID | \n int | \n Folio ID, in case of multiple folios for the room | \n
\n \n \n ItemFormat\n | \n \n int\n | \n \n Format for presenting line items (default '0')\n | \n
\n \n
\n
ItemFormat can be one of the following:
- 0 = show all items
- 1 = show only non-ledger items
- 2 = show ledger items as paid
- 3 = show ledger items with zero balance
- 4 = show ledger items as paid with zero balance
\n
\n Returned data\n
\n
\n \n \n \n Name\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n Items\n | \n \n (object)\n | \n \n List of folio line items (see below)\n | \n
\n \n \n Balance\n | \n \n decimal\n | \n \n Total balance for the folio\n | \n
\n \n
\n
\n Returned data (Folio line item)\n
\n
\n \n \n \n Name\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n iTransID\n | \n \n int\n | \n \n Transaction ID for the item\n | \n
\n \n \n strSourceSiteID\n | \n \n string\n | \n \n Site ID\n | \n
\n \n \n dtTimestamp\n | \n \n dateTime\n | \n \n Date-time stamp for the transaction\n | \n
\n \n \n dtForDate\n | \n \n dateTime\n | \n \n Period system date to which transaction applies\n | \n
\n \n \n iForStayResourceBlock\n | \n \n int\n | \n \n ?\n | \n
\n \n \n strSystemArea\n | \n \n string\n | \n \n ?\n | \n
\n \n \n strOperatorCode\n | \n \n string\n | \n \n Operator code of charge item source, e.g. API vendor\n | \n
\n \n \n iEntryType\n | \n \n int\n | \n \n Entry Type code\n | \n
\n \n \n iItemType\n | \n \n int\n | \n \n Item Type code\n | \n
\n \n \n strAnalCode\n | \n \n string\n | \n \n Sales analysis code\n | \n
\n \n \n strBookRef\n | \n \n string\n | \n \n Booking reference\n | \n
\n \n \n strProfileRef\n | \n \n string\n | \n \n Profile reference\n | \n
\n \n \n iRoomPickID\n | \n \n int\n | \n \n Room Pick ID (integer used for multi-room bookings)\n | \n
\n \n \n iFolioID\n | \n \n int\n | \n \n Folio ID, in case of multiple folios per room\n | \n
\n \n \n iSourceTransID\n | \n \n long\n | \n \n ?\n | \n
\n \n \n iFolioSplitID\n | \n \n int\n | \n \n Folio split ID if using 'bill split'\n | \n
\n \n \n strRoomID\n | \n \n string\n | \n \n Room name or number\n | \n
\n \n \n strCompanyRef\n | \n \n string\n | \n \n Company reference\n | \n
\n \n \n strInvoiceID\n | \n \n string\n | \n \n Invoice ID\n | \n
\n \n \n strDescription\n | \n \n string\n | \n \n Item description\n | \n
\n \n \n strPaymentCode\n | \n \n string\n | \n \n Item payment code, if payment\n | \n
\n \n \n iCurrencyConvID\n | \n \n int\n | \n \n ?\n | \n
\n \n \n strTaxRule\n | \n \n string\n | \n \n Applicable Tax Rule\n | \n
\n \n \n cNettPerUnit\n | \n \n decimal\n | \n \n Item individual amount, nett of tax\n | \n
\n \n \n cGrossPerUnit\n | \n \n decimal\n | \n \n Item individual amount, gross including tax\n | \n
\n \n \n dQuantity\n | \n \n double\n | \n \n Item quantity\n | \n
\n \n \n cNettTotal\n | \n \n decimal\n | \n \n Item total amount, nett of tax\n | \n
\n \n \n cTaxTotal\n | \n \n decimal\n | \n \n Total amount of tax due\n | \n
\n \n \n cGrossTotal\n | \n \n decimal\n | \n \n Item total amount, gross including tax\n | \n
\n \n \n strPackageCode\n | \n \n string\n | \n \n Package code, if applicable\n | \n
\n \n \n iPackageTag\n | \n \n int\n | \n \n ?\n | \n
\n \n \n iStatus\n | \n \n int\n | \n \n ?\n | \n
\n \n \n iParam1\n | \n \n int\n | \n \n ?\n | \n
\n \n \n strParam2\n | \n \n string\n | \n \n ?\n | \n
\n \n
\n
\n EntryType can be one of the following:
- 50 = Direct post
- 100 = Folio charge
- 110 = Folio surcharge
- 200 = Folio credit
- 220 = Folio adjustment
- 300 = Folio deposit advance
- 310 = Folio deposit refund
- 320 = Folio deposit in-house
- 330 = Folio deposit used
- 340 = Folio deposit retained (not used)
- 350 = Folio deposit tax refund
- 500 = Invoiced business
- 700 = Ledger debit
- 800 = Ledger credit
ItemType can be one of the following:
- 0 = General
- 50 = Package header
- 100 = Adult accomodation
- 110 = Child SH accomodation
- 120 = Child OR accomodation
- 30 = Function room hire
- 200 = Manual product
- 250 = Auto-inclusive product
- 300 = Supplement
- 400 = Surcharge
- 500 = Deposit
- 550 = Ledger credit card debit
- 560 = Ledger credit card credit
- 700 = Foreign exchange
Financial status can be one of the following:
- 0 = Default
- 50 = Direct post paid off
- 100 = Advance deposit transfer now transferred
- 200 = In-house deposit transfer now used
- 300 = Ledger transfer now transferred
- 350 = Folio deposit tax refund
- 400 = Booking transfer now transferred
- 500 = Folio charge deleted
- 510 = Folio credit deleted
- 600 = Folio charge deleted for adjustment
- 900 = Folio credit transferred
- 1000 = Folio charge paid off
",
"operationId": "5b6bfd0223b47413944984a0",
"summary": "pmsbkg_RoomFolioItemsAndBalance",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n d9de5589-5781-45bd-a5bd-a385f6d19bce\r\n 110\r\n 1\r\n 0\r\n"
},
"description": "pmsbkg_RoomFolioItemsAndBalanceSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_RoomFolioItemsAndBalanceSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n 11653 \r\n VENDORCITY \r\n 2018-03-19T11:42:42 \r\n 2018-03-19T00:00:00 \r\n 0 \r\n 56 \r\n XNPROTEL \r\n 100 \r\n 50 \r\n PTR \r\n BK000039 \r\n \r\n 1 \r\n 1 \r\n 0 \r\n 1 \r\n 110 \r\n \r\n \r\n Dallas Rest:108118 \r\n \r\n 0 \r\n NO_VAT \r\n 19.8200 \r\n 23.9300 \r\n 5 \r\n 19.8200 \r\n 4.1100 \r\n 23.9300 \r\n \r\n 11653 \r\n 0 \r\n 0 \r\n \r\n \r\n \r\n 11686 \r\n VENDORCITY \r\n 2018-03-19T12:18:02 \r\n 2018-03-19T00:00:00 \r\n 0 \r\n 56 \r\n XNPROTEL \r\n 100 \r\n 50 \r\n PTR \r\n BK000039 \r\n \r\n 1 \r\n 1 \r\n 0 \r\n 1 \r\n 110 \r\n \r\n \r\n Dallas Rest:108121 \r\n \r\n 0 \r\n NO_VAT \r\n 26.3300 \r\n 31.6100 \r\n 3 \r\n 26.3300 \r\n 5.2800 \r\n 31.6100 \r\n \r\n 11686 \r\n 0 \r\n 0 \r\n \r\n \r\n \r\n decimal\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_UpdateAlarmCall": {
"post": {
"description": "Updates the alarm call time for any given room. This could be used, for example, to set an alarm call by triggering another interface to implement the call.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
RoomID | string | Room reference (room name or number) |
AlarmCall | dateTime | Alarm call time |
SetAlarmCall | Boolean | 'true' to set an alarm call or 'false' to cancel |
Returned data
",
"operationId": "5b6bfd0223b47413944984a1",
"summary": "pmsbkg_UpdateAlarmCall",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n a6a70a2d-1ac0-4da0-815a-98cd825a822e\r\n 216\r\n 0001-01-01T07:30:00\r\n true\r\n"
},
"description": "pmsbkg_UpdateAlarmCallSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_UpdateAlarmCallSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_SetHouseKeepingCodeV2": {
"post": {
"description": "Set the housekeeping status for a room. The status must be specified by its numeric code. The room may be referenced\n by room ID or telephone extension number.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n enmSetHouseKeepingCodeMethod | \n string | \n Flag to indicate if using room or extension number (see below) | \n
\n \n RoomID | \n string | \n Room reference (room name or number) or extension number, depending on value of\n enmSetHouseKeepingCodeMethod | \n
\n \n HouseKeepingCode | \n int | \n Housekeeping code (numeric). This must be a valid code reference as returned by pmscfg_HouseKeepingCodes (see Room Status\n codes) | \n
\n \n
\nenmSetHouseKeepingCodeMethod can have of two values:
\n\n - \"SetHouseKeepingCodeMethod_RoomID\"
\n - \"SetHouseKeepingCodeMethod_TelExtNo\"
\n
\nReturned data
\n",
"operationId": "5b6bfd0223b47413944984a3",
"summary": "pmsbkg_SetHouseKeepingCodev2",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n a6a70a2d-1ac0-4da0-815a-98cd825a822e\r\n SetHouseKeepingCodeMethod_RoomID\r\n 216\r\n 1300\r\n"
},
"description": "pmsbkg_SetHouseKeepingCodeV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_SetHouseKeepingCodeV2SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsped_PostZRead": {
"post": {
"description": "This allows the posting of an ePOS Z-read, including both Sales and Payments codes within a single method.\n\nA Z-read is a tally of sales and payments put through an ePOS till (often referred to as 'cashing up'). It is common practice to run a z-read report at the end of a shift or work period and clear it down ready for the next shift. This information is posted to the PMS so that the PMS can account for all of the different sales and payment items and pass this information on to the accounting system for the property, for analysis purposes.\n\nIt is possible to post a Z-read after each set of till transactions, however this can generate a lot of data overhead so in general it is preferred to post a Z-read at the end of each shift or work period.\n\nNote the total of Sales and Payments must sum to zero or else the z-read will be rejected with an error code.\n\nParameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
PaymentsList | object | List of ZReadPayments items (see below) |
SalesList | object | List of ZReadSales items (see below) |
Parameters (ZReadPayment)
Name | Type | Description |
---|
PayTypeCode | string | Payment type code (codes can be obtained through the API using pmscfg_PayTypeList) |
Amount | decimal | Financial amount |
Description | string | Text description of item |
UserTag1 | string | Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes) |
UserTag2 | string | Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes) |
Parameters (ZReadSale)
Name | Type | Description |
---|
AnalysisCode | string | Sales analysis code (codes can be obtained through the API using pmscfg_AnalList) |
Amount | decimal | Financial amount |
Description | string | Text description of item |
UserTag1 | string | Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes) |
UserTag2 | string | Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes) |
Returned data
\n",
"operationId": "5b6bfd0223b47413944984a6",
"summary": "pmsped_PostZRead",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 74e9307d-628a-42ae-b166-87f98875ecfe\r\n \r\n \r\n \r\n CASH\r\n 16\r\n \r\n \r\n VISA\r\n 4\r\n \r\n \r\n MC\r\n 2\r\n \r\n \r\n \r\n \r\n \r\n \r\n FOOD\r\n 12\r\n Food Sales\r\n \r\n \r\n BARDRINK\r\n 10\r\n Bar Drinks Sales\r\n \r\n \r\n \r\n"
},
"description": "pmsped_PostZReadSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsped_PostZReadSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsavl_CheckAvailability": {
"post": {
"description": "Check room availability at given sites over given stay dates.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
Sites | (object) | Set of all sites for which availability required |
> string | string | Site ID |
ArrivalDate | dateTime | Arrival date |
Nights | int | Number of nights of stay |
PAXConfigurations | (object) | Set of all persons requirements |
> cPAXConfiguration | (object) | Set of persons requirements |
>> Rooms | int | Number of rooms required |
>> RoomTypeGroup | string | Room type group, if applicable |
>> Adults | int | Number of adults staying |
>> Children | int | Number of children staying |
PromotionalCode | string | Promotional code, if applicable |
Returned data (per-site availability)
Name | Type | Description |
---|
SiteID | string | Site ID |
Available | boolean | Available Yes/No |
Rate | decimal | Room rate |
",
"operationId": "5b6bfd0223b47413944984ab",
"summary": "pmsavl_CheckAvailability",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 9a129b49-75ff-4721-ac28-ba042c74c532\r\n \r\n TESTSITE1\r\n TESTSITE2\r\n \r\n 2018-09-11T09:55:20.3011068+01:00\r\n 1\r\n \r\n \r\n 1\r\n \r\n 1\r\n 0\r\n \r\n \r\n \r\n \r\n"
},
"description": "pmsavl_CheckAvailabilitySoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsavl_CheckAvailabilitySoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n 1\r\n \r\n \r\n \r\n TESTSITE1\r\n false\r\n 0\r\n \r\n \r\n TESTSITE2\r\n false\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsavl_GetDetailedCheapestRateAvailability": {
"post": {
"description": "Get the detailed availability for the given stay details for the best available room rate.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
SiteID | string | Site ID |
ArrivalDate | dateTime | Arrival date |
Nights | int | Number of nights |
PAXConfigurations | (object) | Set of all persons requirements |
> cPAXConfiguration | (object) | Set of persons requirements |
>> Rooms | int | Number of rooms required |
>> RoomTypeGroup | string | Room type group, if applicable |
>> Adults | int | Number of adults |
>> Children | int | Number of children |
PromotionalCode | string | Promotional code, if applicable |
Returned data (detailed availability)
Name | Type | Description |
---|
PAXConfigurations | (object) | Rates matching set of all persons requirements |
> PAXConfiguration | (object) | Rates matching set of persons requirements |
>> Rates | (object) | Rates |
",
"operationId": "5b6bfd0223b47413944984ac",
"summary": "pmsavl_GetDetailedCheapestRateAvailability",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 1dc990af-9e7d-4445-a2cf-59540412b5c8\r\n TESTSITE1\r\n 2018-09-11T09:55:20.3011068+01:00\r\n 1\r\n \r\n \r\n 1\r\n \r\n 1\r\n 0\r\n \r\n \r\n 1\r\n \r\n 1\r\n 0\r\n \r\n \r\n \r\n"
},
"description": "pmsavl_GetDetailedCheapestRateAvailabilitySoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsavl_GetDetailedCheapestRateAvailabilitySoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n 1\r\n \r\n \r\n \r\n 1\r\n \r\n 1\r\n 0\r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_GetProductUpSellList": {
"post": {
"description": "Get a list of configured up-sell product items (e.g. Flowers, Champagne, Breakfast) for the given sites.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
Sites | (object) | Set of Site IDs |
> string | string | Site ID |
PackageCode | string | Optional package code |
Returned data (products)
Name | Type | Description |
---|
ProductCode | string | Product code |
ChargeMode | (see below) | Charge mode, i.e. basis on which upsell charged |
ValueEach | decimal | Upsell price |
ProductType | (see below) | Product type |
ChargeMode can be one of the following:
- \"PerRoom\"
- \"PerPerson\"
- \"PerAdult\"
- \"PerChild\"
- \"PerInfant\"
- \"SingleCharge\"
- \"DailyPerRoom\"
- \"DailyPerDelegate\"
- \"HourlyPerRoom\"
- \"HourlyPerDelegate\"
- \"FunctionSingleCharge\"
ProductType can be one of the following:
- \"Normal\"
- \"NewsPaper\"
- \"CheckInOffer\"
- \"ReservationOffer\"
- \"ReservationAndCheckInOffer\"
- \"InventoryItem\"
- \"Function\"
- \"FunctionCheckInOffer\"
- \"Activity\"
",
"operationId": "5b6bfd0223b47413944984ad",
"summary": "pmscfg_GetProductUpSellList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n f04c05bb-3b06-4669-be34-b166462880c3\r\n \r\n TEST112\r\n TEST112A\r\n \r\n \r\n"
},
"description": "pmscfg_GetProductUpSellListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_GetProductUpSellListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n TEST112\r\n \r\n \r\n FLOWERS\r\n PerRoom\r\n 30.00\r\n Normal\r\n \r\n \r\n BFAST_UPSELL\r\n PerAdult\r\n 7.50\r\n Normal\r\n \r\n \r\n \r\n \r\n TEST112A\r\n \r\n \r\n FLOWERS\r\n PerRoom\r\n 30.00\r\n Normal\r\n \r\n \r\n CHAMPAGNE\r\n PerRoom\r\n 40.00\r\n Normal\r\n \r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprd_GetProductUpSellList": {
"post": {
"description": "Retrieve a list of available upsell items for the given stay dates.
Parameters
Name | Type | Description |
---|
SessionID | string | Session ID, obtained at log-in |
RatePlanCode | string | Rate plan code |
ArrivalDateTime | dateTime | Arrival date |
DepartureDateTime | dateTime | Departure date |
Returned data (product)
Name | Type | Description |
---|
ProductCode | string | Product code |
ProductGroupCode | string | Product group code |
Description | string | Product description |
SalesAnalysisCode | string | Sales analysis code |
ProductChargeMode | (see below) | Product charge mode (basis on which product is charged, e.g. per adult or per room) |
ProductPostingFrequency | (see below) | Product posting frequency (when product charge should be posted) |
ProductUpsellSource | (see below) | Product upsell source (e.g. general or rate-specific) |
ValueEach | decimal | Product value |
RFlag | int | Internal flag to indicate if marked for deletion |
ProductChargeMode can be one of the following:
- PerRoom
- PerPerson
- PerAdult
- PerChild
- PerInfant
- SingleCharge
- DailyPerRoom
- DailyPerDelegate
- HourlyPerRoom
- HourlyPerDelegate
- FunctionSingleCharge
- Unknown
ProductPostingFrequency can be one of the following:
- EveryBlock
- OnArrivalOnly
- OnDepartureOnly
- OnArrivalAndDeparture
- EveryBlockExcludeArrival
- EveryBlockExcludeDeparture
- EveryBlockExcludeArrivalAndDeparture
- Unknown
ProductUpsellSource can be one of the following:
- None
- GeneralUpSell
- RateSpecificUpSell
",
"operationId": "5b6bfd0223b47413944984ae",
"summary": "pmsprd_GetProductUpSellList",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 4e198586-f1fd-4387-aee5-fd3944e81b18\r\n string\r\n dateTime\r\n dateTime\r\n \r\n \r\n"
},
"description": "pmsprd_GetProductUpSellListSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprd_GetProductUpSellListSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n \r\n \r\n BFAST_UPSELL\r\n UPSELLS\r\n Breakfast\r\n BREAKFAST\r\n PerAdult\r\n EveryBlockExcludeDeparture\r\n GeneralUpSell\r\n 7.5000\r\n 0\r\n \r\n \r\n CHAMPAGNE\r\n UPSELLS\r\n Bottle of Champagne\r\n BAR\r\n PerRoom\r\n OnArrivalOnly\r\n GeneralUpSell\r\n 40.0000\r\n 0\r\n \r\n \r\n COT\r\n BEDS\r\n Baby Cot\r\n BED\r\n PerRoom\r\n EveryBlockExcludeDeparture\r\n GeneralUpSell\r\n 0\r\n 0\r\n \r\n \r\n DINNER_UPSEL\r\n UPSELLS\r\n Dinner\r\n DINNER\r\n PerAdult\r\n EveryBlockExcludeDeparture\r\n GeneralUpSell\r\n 25.0000\r\n 0\r\n \r\n \r\n FLOWERS\r\n UPSELLS\r\n Bunch Seasonal Flowers\r\n SUNDRIES\r\n PerRoom\r\n OnArrivalOnly\r\n GeneralUpSell\r\n 30.0000\r\n 0\r\n \r\n \r\n ROOM_UPGRADE\r\n UPSELLS\r\n Room Upgrade\r\n ACCOM\r\n SingleCharge\r\n OnArrivalOnly\r\n GeneralUpSell\r\n 15.0000\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmschg_PostToRoom": {
"post": {
"description": "This method is used to post charges to a resident guest folio. The charges can consist of one or more individual items, which can optionally be grouped under a header.Resident guest folio The charges can be posted against a room reference (room name or number), against a telephone extension number associated a room, or against a reservation number. If posting against a room reference or telephone extension, the system will actually post to the primary guest reservation which is resident in the room. In the vast majority of cases, there would only be one resident reservation associated with a room, but it is technically possible to have more than one. It is generally better to post to a reservation reference to be absolutely clear on this point. Furthermore, if <FolioID> is supplied, it is possible to post to an individual guest folio within a multi-guest reservation, e.g. if splitting a bill between room guests. If no <FolioID> is supplied, the system will post to the primary guest folio in a multi-guest reservation (which will have a Folio ID of '1'). |
Grouped under a header If the <Header> element is excluded, then the items will not be grouped together and each line item will appear on the guest bill as a separate item. However, if the <Header> element is included, the items will be grouped together on the guest bill using the description supplied in the header and the value equal to the total of the individual values. This option is preferred by many hoteliers. Grouping items together like this also makes it easier to view in posting reports and on-screen bills. In all cases the individual items are stored for reporting and financial analysis. |
Sales analysis codes Each charge must be posted with a corresponding sales analysis code used to identify the type of charge, e.g. telephone, bar, spa, and so on. The codes in use for a site are configurable and therefore can be different from site to site. The list of codes in use can be obtained using pmscfg_AnalList. |
Tax codes VAT (Value Added Tax) is calculated by the Rezlynx PMS according to the sales analysis code and is therefore not referenced specifically in the posting method. All values used in the posting method should be gross values. |
\r\nParameters
\r\nName | Type | Description |
---|
SessionId | string | Session ID, obtained at log-in |
PostingMethod | \"PostingMethod_RoomID\", \"PostingMethod_Booking_RoomRef\" or \"PostingMethod_TelExtNo\" | Posting method (room, booking reference or telephone extension) |
PostingParameter | string | This is the value of the parameter defined by PostingMethod, e.g. if using PostingMethod_RoomID then PostingParameter would be the room name or number, e.g. \"200\" |
FolioID | int | Folio ID, if the bill is split by multiple folios |
Header | (Header, see below) | Posting header |
Transactions | (Financial transactions, see below) | List of financial transactions |
\r\nParameters (Header)
\r\nName | Type | Description |
---|
AnalysisCode | string | Sales analysis code |
Description | string | Description |
Quantity | int | Quantity |
ExternalInvoiceNo | string | Optional: if posted transactions are already invoiced in an external system, e.g. POS, the document number of that operation can be passed as a parameter |
\r\nParameters (Financial Transaction)
\r\nName | Type | Description |
---|
AnalysisCode | string | Sales analysis code |
Description | string | Description |
Quantity | int | Quantity |
GrossTotal | decimal | Gross total value |
ShiftNo | int | Shift number (or '-1' if not applicable) |
\r\nReturned data
\r\nNone",
"operationId": "5b6bfd0223b47413944984b0",
"summary": "pmschg_PostToRoom",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n d9de5589-5781-45bd-a5bd-a385f6d19bce\r\n PostingMethod_RoomID\r\n 002\r\n -1\r\n \r\n FOOD\r\n Crystal Room – Beverage – Order No. 12345\r\n 1\r\n INV001\r\n \r\n \r\n \r\n FOOD\r\n Dinner\r\n 1\r\n 35.50\r\n -1\r\n \r\n \r\n BARDRINK\r\n Bar Drinks\r\n 1\r\n 12.75\r\n -1\r\n \r\n \r\n"
},
"description": "pmschg_PostToRoomSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmschg_PostToRoomSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_UpdateProfileAttribute": {
"post": {
"description": "Updates an attribute (custom field) on a profile, e.g. if there is a custom field set up on a profile for 'car registration', then you can use this method to update the car registration on the guest's profile.\nParameters
Name | Type | Description |
---|
SessionId | string | Session ID, obtained at log-in |
ProfileRef | string | Profile reference |
AttributeCode | string | Attribute code |
NewValue | string | New attribute value |
Returned data
",
"operationId": "pmsprf-updateprofileattribute",
"summary": "pmsprf_UpdateProfileAttribute",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n e3acd937-568a-4276-8552-7a064207fc7c\r\n PF000012\r\n CAR_REG\r\n WN56 KHU\r\n"
},
"description": "pmsprf_UpdateProfileAttributeSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_UpdateProfileAttributeSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_AllocateExistingPayment": {
"post": {
"description": "Allocate an existing CIM payment or credit note to one or more invoices. You can specify the amount to be allocated to each invoice. The Central Invoicing Module must be installed for the given site.
Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn like most PMS methods. See Common to all API methods. |
Parameters (transaction)
The transaction parameters define the payment or credit note to be allocated. These values can be obtained from cim_GetUnallocatedCredits.
Name | Type | Description |
---|
AccountRef | string | CIM account reference |
Status | (see below) | Payment or credit status |
TimeStamp | dateTime | Date of payment or credit |
DocumentRef | string | Payment or credit document reference |
Description | string | Payment or credit description |
GrossValue | decimal | Gross value of transaction |
Balance | decimal | Balance remaining on account |
SiteID | string | Site ID |
BookRef | string | Booking reference, if applicable |
PaymentDue | dateTime | Payment due date |
SequenceNo | int | Transaction sequence number |
Id | int | Payment or credit ID |
Status can be one of the following:
- \"Unknown\"
- \"PendingIssue\"
- \"DebitUnPaid\"
- \"DebitPartPaid\"
- \"DebitFullyPaid\"
- \"CreditPartUsed\"
- \"CreditFullyUsed\"
- \"CreditUnused\"
Parameters (invoices)
The invoices parameters define for each invoice the invoice reference and the amount to be allocated to the invoice.
Name | Type | Description |
---|
AllocateInvoiceDetails | (object) | Details of invoice |
>ExtensionData | (object) | Not used |
>DocumentRef | string | Invoice document reference |
>Value | decimal | Value to be allocated to this invoice |
Returned data
Name | Type | Description |
---|
AllocatePaymentResponse | \"Success\" or \"InvalidMatchOrPartialMatch... ValueAndOrInsufficientFunds\" | Success or failure response |
",
"operationId": "cim-allocateexistingpayment",
"summary": "cim_AllocateExistingPayment",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n CIM00001\r\n PendingIssue\r\n 2018-03-29T12:30:14.6042212+01:00\r\n string\r\n string\r\n 120.00\r\n 20000.00\r\n TEST111\r\n string\r\n 2018-03-29T12:30:14.6042212+01:00\r\n 456\r\n 99\r\n \r\n \r\n \r\n \r\n 8787\r\n 10.00\r\n \r\n \r\n \r\n 30400\r\n 90.00\r\n \r\n \r\n"
},
"description": "cim_AllocateExistingPaymentSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_AllocateExistingPaymentSoapOut",
"examples": {
"text/xml": "\r\n \r\n Success\r\n \r\n 0\r\n No error\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_GetUnallocatedCredits": {
"post": {
"description": "For the specified CIM account, get the list of credit notes and payments not allocated to invoices. The Central Invoicing Module must be installed for the given site.
Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn like most PMS methods. See Common to all API methods. |
Parameters
Name | Type | Description |
---|
accountRef | string | CIM account reference |
Returned data (CIM transaction)
Name | Type | Description |
---|
AccountRef | string | CIM account reference |
Status | (see below) | Payment or credit status |
TimeStamp | dateTime | Date |
DocumentRef | string | Payment or credit document reference |
Description | string | Transaction description |
GrossValue | decimal | Gross amount |
Balance | decimal | Balance remaining |
SiteID | string | Site ID |
BookRef | string | Booking reference, if applicable |
PaymentDue | dateTime | Payment due date |
SequenceNo | int | Transaction sequence number |
Id | int | Payment or credit ID |
Status can be one of the following:
- \"Unknown\"
- \"PendingIssue\"
- \"DebitUnPaid\"
- \"DebitPartPaid\"
- \"DebitFullyPaid\"
- \"CreditPartUsed\"
- \"CreditFullyUsed\"
- \"CreditUnused\"
",
"operationId": "cim-getunallocatedcredits",
"summary": "cim_GetUnallocatedCredits",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n string\r\n"
},
"description": "cim_GetUnallocatedCreditsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_GetUnallocatedCreditsSoapOut",
"examples": {
"text/xml": "\r\n \r\n \r\n string\r\n PendingIssue\r\n dateTime\r\n string\r\n string\r\n decimal\r\n decimal\r\n string\r\n string\r\n dateTime\r\n int\r\n int\r\n \r\n \r\n string\r\n PendingIssue\r\n dateTime\r\n string\r\n string\r\n decimal\r\n decimal\r\n string\r\n string\r\n dateTime\r\n int\r\n int\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_RetrievePayableInvoices": {
"post": {
"description": "Retrieve the list of payable invoices for the given CIM account. The Central Invoicing Module must be installed for the given site.
Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn like most PMS methods. See Common to all API methods. |
Parameters
Name | Type | Description |
---|
accountRef | string | CIM account reference |
Returned data
Name | Type | Description |
---|
AccountRef | string | CIM account reference |
DocumentRef | string | Invoice document reference |
GrossValue | decimal | Invoice gross value |
NettTotal | decimal | Invoice nett value |
BalanceRemaining | decimal | Invoice balance remaining |
",
"operationId": "cim-retrievepayableinvoices",
"summary": "cim_RetrievePayableInvoices",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 776736\r\n"
},
"description": "cim_RetrievePayableInvoicesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_RetrievePayableInvoicesSoapOut",
"examples": {
"text/xml": "\r\n \r\n \r\n 776736\r\n INV0083\r\n 2000.00\r\n 1750.00\r\n 10000.00\r\n \r\n \r\n 776736\r\n INV0084\r\n 25.00\r\n 18.57\r\n 11075.00\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_FinancialExportReportV2": {
"post": {
"description": "This method fetches financial export data from the CIM system, covering a specified time period.
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n sessionId | \n string | \n Session ID, obtained at login | \n
\n \n beforeTimestamp | \n dateTime | \n Date-time equal to or before which data is required | \n
\n \n afterTimestamp | \n dateTime | \n Date-time equal to or after which data is required | \n
\n\t \n useLessThanToDate | \n Boolean | \n Provides an option to return only the data that is less than the before timestamp which is required for financial export for LSE | \n
\n \n
\nReturned data
\n\n - A set of financial transactions
\n
\nReturned data (financial transaction)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n TransactionType | \n string | \n Transaction type (see below) | \n
\n \n AccountNumber | \n string | \n CIM account number | \n
\n \n AccountType | \n int | \n CIM account type | \n
\n \n TransactionReference | \n string | \n Transaction reference | \n
\n \n UniqueReferenceNumber | \n string | \n Unique reference number | \n
\n \n SecondReference | \n string | \n Supplementary reference number, if applicable | \n
\n \n Description | \n string | \n Transaction description | \n
\n \n DueDate | \n dateTime | \n Due date | \n
\n \n ForDate | \n dateTime | \n For date | \n
\n \n TransactionDate | \n dateTime | \n Transaction date | \n
\n \n GrossValue | \n decimal | \n Gross value | \n
\n \n NettValue | \n decimal | \n Nett value | \n
\n \n TaxValue | \n decimal | \n Tax value | \n
\n \n NominalCode | \n string | \n Nominal code | \n
\n \n SaleCode | \n string | \n Sales code | \n
\n \n PayCode | \n string | \n Payment code | \n
\n \n TaxCode | \n string | \n Tax code | \n
\n \n SiteId | \n string | \n Applicable site ID | \n
\n \n PeriodId | \n int | \n Applicable period ID | \n
\n \n PeriodFromDate | \n dateTime | \n Period 'from' date | \n
\n \n PeriodToDate | \n dateTime | \n Period 'to' date | \n
\n \n ModifiedDate | \n dateTime | \n Modified date | \n
\n \n ModifiedKey | \n int | \n Modified key | \n
\n \n
\nTransaction type is one of the following:
\n\n - \"Payment\"
\n - \"Invoice\"
\n - \"CreditNote\"
\n - \"Proforma\"
\n
",
"operationId": "cim-financialexportreportv2",
"summary": "cim_FinancialExportReportV2",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n 16460170-51b1-452f-b40a-50be4492d496\r\n 2017-08-29T00:00:00\r\n 2017-08-28T00:00:00\r\n \r\n\ttrue\r\n"
},
"description": "cim_FinancialExportReportV2SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cim_FinancialExportReportV2SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n 2019-01-10T12:00:00\r\n 2019-01-11T00:00:00\r\n \r\n \r\n \r\n Invoice\r\n PAUL\r\n 2\r\n CINV00000342\r\n CRS00244/BK00000278\r\n 9599\r\n CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick \r\nArrival 10/01/2019 Departure 13/01/2019; Nights = 3\r\nBilling 10/01/2019 to 11/01/2019 Nights = 1 @ 130.00\r\n 2018-07-11T00:00:00\r\n 2019-01-10T00:00:00\r\n 2019-01-10T00:00:00\r\n 156.0000\r\n 130.0000\r\n 26.0000\r\n ACCOMM\r\n ACCOMM\r\n \r\n VAT_20\r\n CIMA\r\n 0\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n 2019-01-10T12:11:24.023\r\n 9599\r\n \r\n \r\n Invoice\r\n PAUL\r\n 2\r\n CINV00000342\r\n CRS00244/BK00000278\r\n 9600\r\n CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick \r\nArrival 10/01/2019 Departure 13/01/2019; Nights = 3\r\nBilling 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00\r\n 2018-07-11T00:00:00\r\n 2019-01-10T00:00:00\r\n 2019-01-10T00:00:00\r\n 216.0000\r\n 180.0000\r\n 36.0000\r\n ACCOMM\r\n ACCOMM\r\n \r\n VAT_20\r\n CIMA\r\n 0\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n 2019-01-10T12:11:24.147\r\n 9600\r\n \r\n \r\n Invoice\r\n PAUL\r\n 2\r\n CINV00000342\r\n CRS00244/BK00000278\r\n 9600\r\n CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick \r\nArrival 10/01/2019 Departure 13/01/2019; Nights = 3\r\nBilling 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00\r\n 2018-07-11T00:00:00\r\n 2019-01-10T00:00:00\r\n 2019-01-10T00:00:00\r\n 24.0000\r\n 20.0000\r\n 4.0000\r\n BFAST\r\n BFAST\r\n \r\n VAT_20\r\n CIMA\r\n 0\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n 2019-01-10T12:11:24.147\r\n 9600\r\n \r\n \r\n Invoice\r\n PAUL\r\n 2\r\n CINV00000342\r\n CRS00244/BK00000278\r\n 9600\r\n CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick \r\nArrival 10/01/2019 Departure 13/01/2019; Nights = 3\r\nBilling 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00\r\n 2018-07-11T00:00:00\r\n 2019-01-10T00:00:00\r\n 2019-01-10T00:00:00\r\n 48.0000\r\n 40.0000\r\n 8.0000\r\n FOOD\r\n FOOD\r\n \r\n VAT_20\r\n CIMA\r\n 0\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n 2019-01-10T12:11:24.147\r\n 9600\r\n \r\n \r\n Invoice\r\n PAUL\r\n 2\r\n CINV00000343\r\n CRS00245/BK00000279\r\n 9603\r\n CIM QA Site A BookRef-BK00000279/1 Guest - Mr Paul McCormick \r\nArrival 10/01/2019 Departure 12/01/2019; Nights = 2\r\nBilling 10/01/2019 to 12/01/2019 Nights = 2 @ 120.00\r\n 2018-07-11T00:00:00\r\n 2019-01-10T00:00:00\r\n 2019-01-10T00:00:00\r\n 216.0000\r\n 180.0000\r\n 36.0000\r\n ACCOMM\r\n ACCOMM\r\n \r\n VAT_20\r\n CIMA\r\n 0\r\n 0001-01-01T00:00:00\r\n 0001-01-01T00:00:00\r\n 2019-01-10T12:21:35.84\r\n 9603\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_GetProfileSummaryV3": {
"post": {
"description": "This method retrieves a guest profile.
\n \n \n \n Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them. | \n
\n \n
\n \n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\n Parameters
\n \n \n \n Name | \n Type | \n Description | \n
\n \n ProfileRequestor | \n (object) | \n | \n
\n \n > ProfileUniqueId | \n string | \n Unique profile ID, must be either a profile reference, unique email address or loyalty ID | \n
\n \n > ProfileUniqueIdAuthenticatorValue | \n string | \n The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below | \n
\n \n > AuthenticationMethod | \n \"PD\" | \n \"PD\" stands for \"Person Details\" and should always be set to this | \n
\n \n > AuthenticationCode | \n string | \n The method of second line authentication to be used i.e. \"Forename\", \"Surname\" or \"PostCode\" | \n
\n \n > AuthenticationValue | \n string | \n The authentication value, e.g. if the method is \"Surname\" and the profile is under the name of \"Jones\" then the value will be \"Jones\", if the method is \"PostCode\" then the value will be \"SY26LG\" | \n
\n \n Filters | \n \"Checked Out\", \"Resident\" or \"Future\" | \n Optional filter to filter results according to the reservation status | \n
\n \n ProfileSearchMode | \n \"Contact\", \"Guest\" or \"Both\" | \n Used to indicate whether searching for a reservation contact, reservation guest or both | \n
\n \n
\n Returned data (profile)
\n \n \n \n Name | \n Type | \n Description | \n
\n \n ProfileRef | \n string | \n Profile reference | \n
\n \n Salutation | \n string | \n Title | \n
\n \n Forename | \n string | \n Forename | \n
\n \n Surname | \n string | \n Surname | \n
\n \n EMailAddress | \n string | \n E-mail address | \n
\n \n Gender | \n string | \n Gender | \n
\n \n Street | \n string | \n Address street | \n
\n \n Area | \n string | \n Address area | \n
\n \n Town | \n string | \n Address town or city | \n
\n \n County | \n string | \n Address county or state | \n
\n \n PostCode | \n string | \n Address postcode or zip code | \n
\n \n Country | \n string | \n Address country | \n
\n \n TelephoneNo | \n string | \n Telephone number | \n
\n \n FaxNo | \n string | \n Fax number | \n
\n \n MobileNo | \n string | \n Mobile telephone number | \n
\n \n Nationality | \n string | \n Nationality | \n
\n \n Language | \n string | \n Language | \n
\n \n CompanyRef | \n string | \n Company reference, if applicable | \n
\n \n Vip | \n int | \n Integer VIP level (e.g. 1,2,3...) | \n
\n \n DateOfBirth | \n dateTime | \n Date of birth | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n TypeOfPerson | \n \"Adult\", \"Child\" or \"Infant\" | \n Adult status | \n
\n \n PassportNumber | \n string | \n Passport number | \n
\n \n PreferredRoomType | \n string | \n Preferred room type | \n
\n \n ExcludeFromMailings | \n Boolean | \n Indicates if person chose to be excluded from general marketing mailings | \n
\n \n Smoker | \n int | \n Smoker or not | \n
\n \n BlackListed | \n int | \n Blacklisted or not | \n
\n \n LoyaltyID | \n string | \n Loyalty ID | \n
\n \n ProfileType | \n \"Private\", \"Agents\", \"Corporate\", \"TourGroup\" or \"TourSeries\" | \n Profile type | \n
\n \n ExcludeFromThirdPartyMailings | \n Boolean | \n Indicates if person chose to be excluded from third-party mailings | \n
\n \n Suffix | \n string | \n Name suffix | \n
\n \n MiddleName | \n string | \n Middle name | \n
\n \n AddressLine1 | \n string | \n Address line 1 | \n
\n \n AddressLine2 | \n string | \n Address line 2 | \n
\n \n State | \n string | \n Address state | \n
\n \n PublicNotes | \n string | \n Notes (public) | \n
\n \n PrivateNotes | \n string | \n Notes (private) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom 1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom 2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom 3) | \n
\n \n
",
"operationId": "pmsprf-getprofilesummaryv3",
"summary": "pmsprf_GetProfileSummaryV3",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n PF000024\r\n \r\n PD\r\n Surname\r\n Valli\r\n \r\n"
},
"description": "pmsprf_GetProfileSummaryV3SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_GetProfileSummaryV3SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n PF000024\r\n Mr\r\n Zen\r\n Valli\r\n zunaid.valli@guestline.com\r\n U\r\n Guestline House Shrewsbury Business Park\r\n Sitka Drive\r\n Shrewsbury\r\n Shropshire\r\n SY2 6LG\r\n United Kingdom\r\n 0123456789\r\n \r\n \r\n British\r\n English\r\n \r\n 0\r\n 1754-01-01T00:00:00\r\n \r\n Adult\r\n \r\n \r\n false\r\n 0\r\n 0\r\n \r\n Private\r\n true\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Gluten\r\n No Duvet\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_GetProfileSummaryWithAttributes": {
"post": {
"description": "This method retrieves a guest profile, including custom attributes. It is based on pmsprf_GetProfileSummaryV3 but with the addition of custom attributes in the response object.
\n(note however that this method uses SessionID like pmsprf_GetProfileSummaryV2 and not SOAP header authentication like pmsprf_GetProfileSummaryV3)
\n\n \n \n Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SessionID | \n string | \n Session ID, obtained at log-in | \n
\n \n ProfileRequestor | \n (object) | \n | \n
\n \n > ProfileUniqueId | \n string | \n Unique profile ID, must be either a profile reference, unique email address or loyalty ID | \n
\n \n > ProfileUniqueIdAuthenticatorValue | \n string | \n The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below | \n
\n \n > AuthenticationMethod | \n \"PD\" | \n \"PD\" stands for \"Person Details\" and should always be set to this | \n
\n \n > AuthenticationCode | \n string | \n The method of second line authentication to be used i.e. \"Forename\", \"Surname\" or \"PostCode\" | \n
\n \n > AuthenticationValue | \n string | \n The authentication value, e.g. if the method is \"Surname\" and the profile is under the name of \"Jones\" then the value will be \"Jones\", if the method is \"PostCode\" then the value will be \"SY26LG\" | \n
\n \n Filters | \n \"Checked Out\", \"Resident\" or \"Future\" | \n Optional filter to filter results according to the reservation status | \n
\n \n ProfileSearchMode | \n \"Contact\", \"Guest\" or \"Both\" | \n Used to indicate whether searching for a reservation contact, reservation guest or both | \n
\n \n
\nReturned data (profile)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n ProfileRef | \n string | \n Profile reference | \n
\n \n Salutation | \n string | \n Title | \n
\n \n Forename | \n string | \n Forename | \n
\n \n Surname | \n string | \n Surname | \n
\n \n EMailAddress | \n string | \n E-mail address | \n
\n \n Gender | \n string | \n Gender | \n
\n \n Street | \n string | \n Address street | \n
\n \n Area | \n string | \n Address area | \n
\n \n Town | \n string | \n Address town or city | \n
\n \n County | \n string | \n Address county or state | \n
\n \n PostCode | \n string | \n Address postcode or zip code | \n
\n \n Country | \n string | \n Address country | \n
\n \n TelephoneNo | \n string | \n Telephone number | \n
\n \n FaxNo | \n string | \n Fax number | \n
\n \n MobileNo | \n string | \n Mobile telephone number | \n
\n \n Nationality | \n string | \n Nationality | \n
\n \n Language | \n string | \n Language | \n
\n \n CompanyRef | \n string | \n Company reference, if applicable | \n
\n \n Vip | \n int | \n Integer VIP level (e.g. 1,2,3...) | \n
\n \n DateOfBirth | \n dateTime | \n Date of birth | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n TypeOfPerson | \n \"Adult\", \"Child\" or \"Infant\" | \n Adult status | \n
\n \n PassportNumber | \n string | \n Passport number | \n
\n \n PreferredRoomType | \n string | \n Preferred room type | \n
\n \n ExcludeFromMailings | \n Boolean | \n Indicates if person chose to be excluded from general marketing mailings | \n
\n \n Smoker | \n int | \n Smoker or not | \n
\n \n BlackListed | \n int | \n Blacklisted or not | \n
\n \n LoyaltyID | \n string | \n Loyalty ID | \n
\n \n ProfileType | \n \"Private\", \"Agents\", \"Corporate\", \"TourGroup\" or \"TourSeries\" | \n Profile type | \n
\n \n ExcludeFromThirdPartyMailings | \n Boolean | \n Indicates if person chose to be excluded from third-party mailings | \n
\n \n Suffix | \n string | \n Name suffix | \n
\n \n MiddleName | \n string | \n Middle name | \n
\n \n AddressLine1 | \n string | \n Address line 1 | \n
\n \n AddressLine2 | \n string | \n Address line 2 | \n
\n \n State | \n string | \n Address state | \n
\n \n PublicNotes | \n string | \n Notes (public) | \n
\n \n PrivateNotes | \n string | \n Notes (private) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom 1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom 2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom 3) | \n
\n \n
\nReturned data (custom attribute)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n AttributeCode | \n string | \n Attribute field type (see below) | \n
\n \n Value | \n string | \n (please ignore this field) | \n
\n \n Param1 | \n string | \n Parameter #1, if applicable | \n
\n \n Param2 | \n string | \n Parameter #2, if applicable | \n
\n \n ProfileAttributeCode | \n string | \n Name of this custom attribute | \n
\n \n ProfileAttributeDescription | \n string | \n Description or label for this custom attribute | \n
\n \n ProfileAttributeValue | \n string | \n Value of this custom attribute | \n
\n \n
\nAttribute field type can be one of the following:
\n\n - \"SMALL\" (a small text box)
\n - \"LARGE\" (a large text box)
\n - \"DATE\" (a date)
\n - \"NUMBER\" (an integer number)
\n - \"YES_NO\" (a yes/no flag)
\n - \"LIST\" (a list-box)
\n
\n\n \n \n Note some care is needed with the custom attribute values, as they depend on the attribute field type. For example, values for field type \"YES_NO\" are '1' for 'Yes' and '0' for 'No'. | \n
\n \n
\n\n \n \n Note in the case of attributes of field type \"LIST\", Param2 contains the list options, e.g. \"[],[1],[2],[3]\" indicates possible values for the attribute are <blank>, '1', '2' or '3'. | \n
\n \n
",
"operationId": "pmsprf-getprofilesummarywithattributes",
"summary": "pmsprf_GetProfileSummaryWithAttributes",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n a6a70a2d-1ac0-4da0-815a-98cd825a822e\r\n \r\n PF00000003\r\n \r\n PD\r\n Surname\r\n Alibone\r\n \r\n"
},
"description": "pmsprf_GetProfileSummaryWithAttributesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_GetProfileSummaryWithAttributesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n PF00000003\r\n Mr\r\n Lee\r\n Alibone\r\n lee.alibone@guestline.com\r\n M\r\n Guestline House Shrewsbury Business Park\r\n Sitka Drive\r\n Shrewsbury\r\n Shropshire\r\n SY2 6LG\r\n United Kingdom\r\n 0123456789\r\n \r\n \r\n British\r\n English\r\n \r\n 0\r\n 1754-01-01T00:00:00\r\n \r\n Adult\r\n \r\n \r\n false\r\n 0\r\n 0\r\n \r\n Private\r\n true\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n Gluten\r\n No Duvet\r\n \r\n \r\n \r\n SMALL\r\n Small text\r\n \r\n \r\n SMALL\r\n Small\r\n Small text\r\n \r\n \r\n LARGE\r\n \r\n \r\n \r\n LARGE\r\n Large\r\n \r\n \r\n \r\n DATE\r\n \r\n \r\n \r\n DATE\r\n Date\r\n \r\n \r\n \r\n NUMBER\r\n 99999\r\n \r\n \r\n NUMBER\r\n Number\r\n 99999\r\n \r\n \r\n YES_NO\r\n 1\r\n \r\n \r\n YES_NO\r\n Yes / No\r\n 1\r\n \r\n \r\n LIST\r\n 3\r\n \r\n [],[1],[2],[3]\r\n LIST\r\n List\r\n 3\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsprf_UpdateProfileSummaryV3": {
"post": {
"description": "This is used to amend profile details directly in the PMS.
\n\n \n \n Updating individual fields Setting a field value will overwrite the current value with the new value; fields which are blank in the request message will not cause any change in the field value, these will not be overwritten; to clear the contents of a field, set the field value to '*' in the request message. | \n
\n \n
\n\n \n \n Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them. | \n
\n \n
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n ProfileRequestor | \n (object) | \n | \n
\n \n > ProfileUniqueId | \n string | \n Unique profile ID, must be either a profile reference, unique email address or loyalty ID | \n
\n \n > ProfileUniqueIdAuthenticatorValue | \n string | \n The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below | \n
\n \n > AuthenticationMethod | \n \"PD\" | \n \"PD\" stands for \"Person Details\" and should always be set to this | \n
\n \n > AuthenticationCode | \n string | \n The method of second line authentication to be used i.e. \"Forename\", \"Surname\" or \"PostCode\" | \n
\n \n > AuthenticationValue | \n string | \n The authentication value, e.g. if the method is \"Surname\" and the profile is under the name of \"Jones\" then the value will be \"Jones\", if the method is \"PostCode\" then the value will be \"SY26LG\" | \n
\n \n StreetAddress | \n string | \n Address street | \n
\n \n AreaAddress | \n string | \n Address area | \n
\n \n Town | \n string | \n Address town or city | \n
\n \n County | \n string | \n Address county or state | \n
\n \n Country | \n string | \n Address country | \n
\n \n Postcode | \n string | \n Address postcode or zip code | \n
\n \n TelNumber | \n string | \n Telephone number | \n
\n \n FaxNumber | \n string | \n Fax number | \n
\n \n MobileNo | \n string | \n Mobile telephone number | \n
\n \n Email | \n string | \n E-mail address | \n
\n \n ExcludeFromMailings | \n Boolean | \n Indicates if person chose to be excluded from general marketing mailings | \n
\n \n Password | \n string | \n Password to secure access to the profile | \n
\n \n CompanyRef | \n string | \n Company reference | \n
\n \n Salutation | \n string | \n Title e.g. \"Mr\" or \"Ms\" | \n
\n \n Forename | \n string | \n Forename | \n
\n \n Surname | \n string | \n Surname | \n
\n \n Greeting | \n string | \n Preferred form of address | \n
\n \n Vip | \n int | \n Integer VIP level | \n
\n \n BlackListed | \n int | \n Blacklisted or not | \n
\n \n TypeOfPerson | \n int | \n Code to indicate adult, child or infant status | \n
\n \n Nationality | \n string | \n Nationality | \n
\n \n Language | \n string | \n Language | \n
\n \n DOB | \n dateTime | \n Date of birth | \n
\n \n ProfileType | \n int | \n Code to indicate profile type | \n
\n \n Smoker | \n int | \n Smoker or not | \n
\n \n LoyaltyID | \n string | \n Loyalty ID | \n
\n \n StudentID | \n string | \n Student ID, if applicable | \n
\n \n Gender | \n string | \n Gender | \n
\n \n PassportNumber | \n string | \n Passport number | \n
\n \n PreferredRoomType | \n string | \n Preferred room type | \n
\n \n ExcludeFromThirdPartyMailings | \n Boolean | \n Indicates if person chose to be excluded from third-party mailings | \n
\n \n PublicNotes | \n string | \n Notes (public) | \n
\n \n PrivateNotes | \n string | \n Notes (private) | \n
\n \n CustomNotes1 | \n string | \n Notes (custom 1) | \n
\n \n CustomNotes2 | \n string | \n Notes (custom 2) | \n
\n \n CustomNotes3 | \n string | \n Notes (custom 3) | \n
\n \n
\nReturned data
\n",
"operationId": "pmsprf-updateprofilesummaryv3",
"summary": "pmsprf_UpdateProfileSummaryV3",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n PV00067\r\n \r\n PD\r\n Surname\r\n McCormick\r\n \r\n \r\n \r\n Shrewsbury1\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n \r\n \r\n \r\n \r\n 0\r\n 0\r\n 0\r\n \r\n \r\n 2017-10-17T16:46:45.757975+01:00\r\n 0\r\n -1\r\n \r\n \r\n \r\n \r\n \r\n false\r\n \r\n \r\n \r\n \r\n \r\n"
},
"description": "pmsprf_UpdateProfileSummaryV3SoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsprf_UpdateProfileSummaryV3SoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservation": {
"post": {
"description": "This is a lightweight version of the BookingSearch method and it is used to retrieve information for a certain reservation.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n
\nReturned data
\n\n - Search results consisting of a single reservation
\n
\nReturned data (Reservation)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n RoomId | \n string | \n Room ID (room number or name) | \n
\n \n BookRef | \n string | \n Booking or reservation reference | \n
\n \n RoomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n BookingType | \n string | \n Booking or reservation type (see below) | \n
\n \n BookingStatus | \n int | \n Integer indicating the corresponding BookingStatus Id in Rezlynx | \n
\n \n RoomTypeCode | \n string | \n Room type code | \n
\n \n Arrival | \n dateTime | \n Guest planned arrival date (reservation start) | \n
\n \n Departure | \n dateTime | \n Guest planned departure date (reservation finish) | \n
\n \n Creation | \n dateTime | \n Reservation creation date | \n
\n \n GroupAllotmentRef | \n string | \n Group Allotment reference | \n
\n \n MultiRoomReference | \n string | \n Free text description field used as a heading for multi-room reservations | \n
\n \n Contact | \n (object) | \n Contact person details. If there is a profile linked to the booking, we only return ProfileRef code else we return Salutation, Forename, Surname and Name. | \n
\n \n Company | \n string | \n Reference code for company through which reservation made, if applicable. | \n
\n \n Agent | \n string | \n Reference code for agent through which reservation made, if applicable. | \n
\n \n Source | \n string | \n Reference code for reservation source, if applicable | \n
\n \n Ledger | \n string | \n Reference code for ledger, if applicable. | \n
\n \n PostsAllowed | \n string | \n Indicates any posting restrictions for the reservation: either \"All\" (all postings\n allowed), \"None\" (no postings allowed) or \"CallsOnly\" (only phone postings allowed) | \n
\n \n BookRefRoomPickID | \n string | \n Long-form booking reference, including Room Pick ID, e.g. \"BK000034/1\" | \n
\n \n AlarmCall | \n string | \n Alarm call time, if set | \n
\n \n MovieAccess | \n string | \n Movie Access\n code, if used | \n
\n \n FunctionBookingDescription | \n string | \n Description if function room reservation | \n
\n \n AllowRoomMoves | \n boolean | \n Flag to indicate if room moves are allowed | \n
\n \n MarketSegment | \n string | \n Market segment, for marketing purposes | \n
\n \n TotalCostNett | \n decimal | \n Total cost of the booking (nett of tax) | \n
\n \n TotalCostGross | \n decimal | \n Total cost of the booking (gross, including tax) | \n
\n \n LastEdited | \n dateTime | \n Date-time the reservation was last edited or changed (not including changes made at a room\n block, group or multi-room level) | \n
\n \n GDSRef | \n string | \n GDS reference, if booking came via an external GDS | \n
\n \n CRSRef1 | \n string | \n Rezlynx CRS reference | \n
\n \n CRSRef2 | \n string | \n External CRS reference, if reservation came via an external CRS | \n
\n \n SystemSource | \n string | \n System origin of this reservation (see below) | \n
\n \n DistributionChannelId | \n int | \n Distribution Channel ID, if the reservation came via a distribution channel | \n
\n \n PreCheckIn | \n boolean | \n Flag to indicate if pre-checked-in or not (if applicable) | \n
\n \n RezlynxCRS | \n string | \n Rezlynx CRS reference | \n
\n \n
\nBooking type must be one of the following:
\n\n - \"Bedroom\" = normal bedroom reservation
\n - \"Function\" = function room reservation
\n - \"Nra\" = non-resident account, i.e. not linked to a room
\n - \"Master\" = master booking
!new in 1.500!
\n
\n\n \n \n Note Master bookings are dummy room reservations, similar to an NRA but\n linked to a group or multi-room reservation. Both master bookings and NRAs can be useful for managing\n accounts. | \n
\n \n
\nSystemSource must be one of the following:
\n\n - \"Unknown\"
\n - \"Rezlynx\"
\n - \"PublicPortal\"
\n - \"AgentPortal\"
\n - \"CorporatePortal\"
\n - \"Roomlynx\"
\n - \"CRS\"
\n - \"BWCRS\"
\n - \"WebService\"
\n - \"CentralInvoicing\"
\n - \"SalesAndCatering\"
\n
",
"operationId": "get-reservation",
"summary": "pmsbkg_GetReservation",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK0000006273\r\n 1\r\n"
},
"description": "pmsbkg_GetReservationSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_GetReservationSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n BK06165\r\n 1\r\n BedRoom\r\n 1\r\n DOUBLE\r\n 2019-05-03T00:00:00\r\n 2019-05-04T00:00:00\r\n 2019-05-03T08:14:23\r\n \r\n PF00899\r\n \r\n All\r\n BK06165/1\r\n Children\r\n true\r\n MARKETSEGMEN\r\n 83.3300\r\n 100.0000\r\n 2019-05-03T08:14:23\r\n Rezlynx\r\n 1\r\n false\r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservationTransactions": {
"post": {
"description": "This methods can be used to get transactions for single reservation with pre-arrival status.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n
\nReturned data
\n\n - Search results consisting of a set of reservation transactions
\n
\nReturned data (Transactions)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n EntryTypeName | \n string | \n Name of the transaction category | \n
\n \n FolioId | \n int | \n Integer indicating which guest of a multi-folio reservation this is (1,2,3,...) | \n
\n \n ForDate | \n dateTime | \n Item date-time stamp | \n
\n \n AnalysisCode | \n string | \n Name of the analysis code, e.g. \"BARFOOD\" | \n
\n \n RatePlanCode | \n string | \n Rate plan code | \n
\n \n NettTotal | \n decimal | \n Total cost of the item (nett of tax) | \n
\n \n GrossTotal | \n decimal | \n Total cost of the item (gross, including tax) | \n
\n \n
\nEntryTypeName must be one of the following:
\n\n - RateAdultAccomodation
\n - RateChildSharingAccomodation
\n - RateChildOwnAccomodation
\n - Upsell
\n - ProductRuleUpsell
\n - RateInclusiveUpsell
\n - RateSupplement
\n - CityTaxSurcharge
\n
",
"operationId": "get-reservation-transactions",
"summary": "pmsbkg_GetReservationTransactions",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK0000006273\r\n 1\r\n"
},
"description": "pmsbkg_GetReservationTransactionsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_GetReservationTransactionsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-16T00:00:00\r\n ROTAX2\r\n BAR_BB\r\n 0.8400\r\n 2.0000\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-16T00:00:00\r\n DINNER\r\n BAR_BB\r\n 5.0000\r\n 5.0000\r\n \r\n \r\n RateAdultAccomodation\r\n 1\r\n 2019-09-16T00:00:00\r\n 20TAX\r\n BAR_BB\r\n 8333.3300\r\n 10000.0000\r\n \r\n \r\n RateAdultAccomodation\r\n 1\r\n 2019-09-17T00:00:00\r\n 0TAX\r\n BAR_BB\r\n 10000.0000\r\n 10000.0000\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-17T00:00:00\r\n ROTAX2\r\n BAR_BB\r\n 0.8400\r\n 2.0000\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-17T00:00:00\r\n DINNER\r\n BAR_BB\r\n 5.0000\r\n 5.0000\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-18T00:00:00\r\n ROTAX2\r\n BAR_BB\r\n 0.8400\r\n 2.0000\r\n \r\n \r\n RateInclusiveUpsell\r\n 1\r\n 2019-09-18T00:00:00\r\n DINNER\r\n BAR_BB\r\n 5.0000\r\n 5.0000\r\n \r\n \r\n RateAdultAccomodation\r\n 1\r\n 2019-09-18T00:00:00\r\n 0TAX\r\n BAR_BB\r\n 10000.0000\r\n 10000.0000\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservationProductRules": {
"post": {
"description": "This method retrieves the product rules added to a booking, that are NOT part of the rate plan used.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n
\nReturned data collection of (ReservationProductRule)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n ReservationProductRules | \n object | \n Object representing results collection | \n
\n \n ReservationProductRule | \n object | \n Object representing one reservation's product rule | \n
\n \n > Id | \n int | \n Id of this specific reservation's product rule | \n
\n \n > ProductRuleCode | \n string | \n Product rule code | \n
\n \n > Quantity | \n int | \n Quantity | \n
\n \n > Value | \n decimal | \n Net value | \n
\n \n
",
"operationId": "get-reservation-product-rules",
"summary": "pmsbkg_GetReservationProductRules",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK0000006298\r\n 1\r\n"
},
"description": "pmsbkg_GetReservationProductRulesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_GetReservationProductRulesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n 1280\r\n BFAST\r\n 1\r\n 12.0000\r\n \r\n \r\n 1281\r\n EASTER\r\n 2\r\n 15.0000\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservationProducts": {
"post": {
"description": "This method retrieves the products added to a booking, that are NOT part of the rate plan used.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n
\nReturned data collection of (ReservationProduct)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n Id | \n int | \n Id of this specific reservation's product | \n
\n \n ProductCode | \n string | \n Product code | \n
\n \n Quantity | \n int | \n Quantity, for Custom PostingMode it will be set to 0 | \n
\n \n Value | \n decimal | \n Net value, for Custom PostingMode it will be set to 0 | \n
\n \n ChargeMode | \n string | \n Product charge mode (basis on which product is charged, e.g. per adult or per room) | \n
\n \n PostingMode | \n object | \n Object that aggregates the PostingMode selected in Rezlynx for that specific Product | \n
\n \n > Simple | \n object | \n If the Product for the Reservation is created using Simple mode, it will be represented by this object | \n
\n \n >> DayOfArrival | \n boolean | \n Flag to indicate if Product is sold for the day of arrival | \n
\n \n >> ResidentDays | \n boolean | \n Flag to indicate if Product is sold for the resident days | \n
\n \n >> DayOfCheckout | \n boolean | \n Flag to indicate if Product is sold for the day of checkout | \n
\n \n >> Custom | \n object | \n If the Product for the Reservation is created using Custom mode, it will be represented by this object | \n
\n \n >> PostingItems | \n object | \n Collection of posting details | \n
\n \n >>> PostingItem | \n object | \n Each combination of date, quantity and value will be represented by this object | \n
\n \n >>>> ForDate | \n dateTime | \n Date used for this specific quantity and value combination | \n
\n \n >>>> Quantity | \n int | \n Quantity | \n
\n \n >>>> Value | \n decimal | \n Net value | \n
\n \n > Rhythm | \n object | \n If the Product for the Reservation is created using Rhythm mode, it will be represented by this object | \n
\n \n >> Night1 | \n boolean | \n Flag to indicate if Product is sold for the first night | \n
\n \n >> Night2 | \n boolean | \n Flag to indicate if Product is sold for the second night | \n
\n \n >> Night3 | \n boolean | \n Flag to indicate if Product is sold for the third night | \n
\n \n >> Night4 | \n boolean | \n Flag to indicate if Product is sold for the fourth night | \n
\n \n >> Night5 | \n boolean | \n Flag to indicate if Product is sold for the fifth night | \n
\n \n >> Night6 | \n boolean | \n Flag to indicate if Product is sold for the sixth night | \n
\n \n >> Night7 | \n boolean | \n Flag to indicate if Product is sold for the seventh night | \n
\n \n >> Night8 | \n boolean | \n Flag to indicate if Product is sold for the eighth night | \n
\n \n >> Night9 | \n boolean | \n Flag to indicate if Product is sold for the ninth night | \n
\n \n >> Night10 | \n boolean | \n Flag to indicate if Product is sold for the tenth night | \n
\n \n >> Night11 | \n boolean | \n Flag to indicate if Product is sold for the eleventh night | \n
\n \n >> Night12 | \n boolean | \n Flag to indicate if Product is sold for the twelfth night | \n
\n \n >> Night13 | \n boolean | \n Flag to indicate if Product is sold for the thirteenth night | \n
\n \n >> Night14 | \n boolean | \n Flag to indicate if Product is sold for the fourteenth night | \n
\n \n
\nChargeMode must be one of the following:
\n\n - \"PerRoom\"
\n - \"PerPerson\"
\n - \"PerAdult\"
\n - \"PerChild\"
\n - \"PerInfant\"
\n - \"SingleCharge\"
\n - \"DailyPerRoom\"
\n - \"DailyPerDelegate\"
\n - \"HourlyPerRoom\"
\n - \"HourlyPerDelegate\"
\n - \"FunctionSingleCharge\"
\n
",
"operationId": "get-reservation-products",
"summary": "pmsbkg_GetReservationProducts",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK0000006313\r\n 1\r\n"
},
"description": "pmsbkg_GetReservationProductsSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_GetReservationProductsSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n 5071\r\n CHIO\r\n 2\r\n 3.2000\r\n PerRoom\r\n \r\n \r\n true\r\n true\r\n false\r\n \r\n \r\n \r\n \r\n 5072\r\n COKE\r\n 1\r\n 2.0000\r\n PerRoom\r\n \r\n \r\n true\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n false\r\n \r\n \r\n \r\n \r\n 5073\r\n LAPTE\r\n 0\r\n 0\r\n PerRoom\r\n \r\n \r\n \r\n \r\n 2019-09-24T00:00:00\r\n 1\r\n 15.0000\r\n \r\n \r\n 2019-09-25T00:00:00\r\n 1\r\n 15.0000\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_RemoveReservationProduct": {
"post": {
"description": "This method provides the ability to remove a product from a reservation, if the reservation has a PreArrival status.\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Number indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n reservationProductId | \n int | \n Number indicating which product id you want to remove from the reservation | \n
\n\t\t\n\t\t\tforDate | \n\t\t\tdateTime | \n\t\t\tOptional: Will remove custom product on given date | \n\t\t
\n\t\n
\nReturned data
\n",
"operationId": "remove-reservation-product",
"summary": "pmsbkg_RemoveReservationProduct",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n\tBK0000006313\r\n\t1\r\n\t602\r\n\t2019-01-31T00:00:14.6042212+01:00\r\n"
},
"description": "pmsbkg_RemoveReservationProductSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_RemoveReservationProductSoapOut",
"examples": {
"text/xml": "\r\n\t\r\n\t\t0\r\n\t\tNo error\r\n\t\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_RemoveReservationProductRule": {
"post": {
"description": "This method provides the ability to remove a product rule from a reservation, if the reservation has a PreArrival status.\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Number indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n reservationProductRuleId | \n int | \n Number indicating which product rule id you want to remove from the reservation | \n
\n\t\n
\nReturned data
\n",
"operationId": "remove-reservation-product-rule",
"summary": "pmsbkg_RemoveReservationProductRule",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n\tBK0000006313\r\n\t1\r\n\t602\r\n"
},
"description": "pmsbkg_RemoveReservationProductRuleSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_RemoveReservationProductRuleSoapOut",
"examples": {
"text/xml": "\r\n\t\r\n\t\t0\r\n\t\tNo error\r\n\t\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservationBookingLines": {
"post": {
"description": "This method can be used to get the booking lines of a reservation.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n bookRef | \n string | \n Booking or reservation reference | \n
\n \n roomPickID | \n int | \n Integer indicating which of a multi-room reservation this is (1,2,3,...) | \n
\n \n
\nReturned data
\n\n - Search results consisting of a set of reservation booking lines
\n
\nReturned data (Booking Lines)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n Id | \n int | \n Unique identifier of the booking line | \n
\n \n Date | \n dateTime | \n Date of the booking line | \n
\n\t\t\n Adults | \n int | \n Number of adults on the booking day | \n
\n \n Children | \n int | \n Number of children on the booking day | \n
\n \n Infants | \n int | \n Number of infants on the booking day | \n
\n\t\t\n RatePlan | \n string | \n Rate plan code used on the given booking day | \n
\n \n MarketSegment | \n string | \n Market segment code used on the given booking day | \n
\n \n RoomType | \n string | \n Room type code used on the given booking day | \n
\n\t\t\n RoomId | \n string | \n Room number used on the given booking day | \n
\t\t\n \n Nett | \n decimal | \n Total cost of the item (nett of tax) | \n
\n \n Gross | \n decimal | \n Total cost of the item (gross, including tax) | \n
\n\t\t\n DayLet | \n bool | \n Flag that indicates the booking checked in and out on the same day | \n
\n \n
",
"operationId": "get-reservation-booking-lines",
"summary": "pmsbkg_GetReservationBookingLines",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n BK0000006273\r\n 1\r\n"
},
"description": "pmsbkg_GetReservationBookingLinesSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmsbkg_GetReservationBookingLinesSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n\t\t 15771 \r\n\t\t 2019-10-08T00:00:00 \r\n\t\t 2 \r\n\t\t 0 \r\n\t\t 0 \r\n\t\t UNTOLD \r\n\t\t CORPORATE \r\n\t\t DOUBLE \r\n\t\t 100 \r\n\t\t 83.3300 \r\n\t\t 100.0000 \r\n\t\t false \r\n\t\t\r\n\t\t\r\n\t\t 15772 \r\n\t\t 2019-10-09T00:00:00 \r\n\t\t 2 \r\n\t\t 0 \r\n\t\t 0 \r\n\t\t UNTOLD \r\n\t\t CORPORATE \r\n\t\t DOUBLE \r\n\t\t 100 \r\n\t\t 95.0000 \r\n\t\t 100.0000 \r\n\t\t false \r\n\t\t\r\n\t\t\r\n\t\t 15773 \r\n\t\t 2019-10-10T00:00:00 \r\n\t\t 2 \r\n\t\t 0 \r\n\t\t 0 \r\n\t\t ELECTRIC \r\n\t\t TOUR \r\n\t\t TWIN \r\n\t\t 200 \r\n\t\t 246.2800 \r\n\t\t 255.0000 \r\n\t\t false \r\n\t\t \r\n\t\t\r\n \r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cnbenq_CreateWebEnquiry": {
"post": {
"description": "Create an enquiry in the PMS for a conference/event.
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters (EventEnquiryWeb)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n StartDate | \n date | \n Start Date | \n
\n \n EndDate | \n date | \n End Date | \n
\n \n Title | \n string | \n Delegate title | \n
\n \n Forname | \n string | \n Delegate forname | \n
\n \n Surname | \n string | \n Delegate surname | \n
\n \n Telephone | \n string | \n Delegate phone number | \n
\n \n Mobile | \n string | \n Delegate mobile phone number | \n
\n \n Email | \n string | \n Delegate email | \n
\n \n Delegates | \n int | \n Number of delegates | \n
\n \n EventName | \n string | \n Event name/td>\n |
\n \n EnquiryNotes | \n string | \n Enquiry Notes | \n
\n \n
\nReturned data
\n\n \n \n Name | \n Type | \n Description | \n
\n \n Reference | \n string | \n The reference of newly created enquiry. Indicates if the process was successful or not | \n
\n \n
",
"operationId": "cnbenq_createwebenquiry",
"summary": "cnbenq_CreateWebEnquiry",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n \r\n 2018-07-11T00:00:00\r\n 2018-07-13T00:00:00\r\n Ms\r\n Joe\r\n Hart\r\n \r\n \r\n \r\n 30\r\n Wedding\r\n \r\n \r\n"
},
"description": "cnbenq_CreateWebEnquirySoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "cnbenq_CreateWebEnquirySoapOut",
"examples": {
"text/xml": "\r\n Reference\r\n"
}
}
}
}
},
"/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmscfg_GetAttributeConfiguration": {
"post": {
"description": "This method can be used to get the attribute configuration for companies, enquiries, profiles, reservation and rooms
\n\n \n \n Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. | \n
\n \n
\nParameters
\n\n \n \n Name | \n Type | \n Description | \n
\n \n systemArea | \n string | \n Optional. We can filter the data on the server, passing a comma separated list of system areas (ex. profiles,company). When left blank it will return all the data | \n
\n \n
\nReturned data
\n\n - Search results consisting of a set of attribute configuration objects
\n
\nReturned data collection of (AttributeConfiguration)
\n\n \n \n Name | \n Type | \n Description | \n
\n \n SystemArea | \n string | \n Origin of the system area (Company, Profile, Enquiry, Reservation or Room) | \n
\n \n Code | \n string | \n Attribute code | \n
\n \n Description | \n string | \n Attribute description | \n
\n \n FieldType | \n string | \n Type of the field (SmallText, LargeText, Number, Date, YesNo or List) | \n
\n \n DefaultValue | \n string | \n Default value for this attribute | \n
\n \n ListOptions | \n object | \n Only for type List. Represents a set of ListOption objects | \n
\n \n > ListOption | \n object | \n Only for type List. Represents a specific ListOption object | \n
\n \n >> Value | \n string | \n Only for type List. Represents a text set for this ListOption object | \n
\n \n
",
"operationId": "get-attribute-configuration",
"summary": "pmscfg_GetAttributeConfiguration",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"example": "\r\n profile,company \r\n"
},
"description": "pmscfg_GetAttributeConfigurationSoapIn"
}
],
"consumes": [
"text/xml"
],
"produces": [
"text/xml"
],
"responses": {
"200": {
"description": "pmscfg_GetAttributeConfigurationSoapOut",
"examples": {
"text/xml": "\r\n \r\n 0\r\n No error\r\n \r\n \r\n Company\r\n DATE
\r\n Date\r\n Date\r\n \r\n \r\n \r\n Company\r\n LARGE
\r\n Large\r\n LargeText\r\n \r\n \r\n \r\n Company\r\n LIST
\r\n List\r\n List\r\n \r\n \r\n \r\n \r\n \r\n \r\n 1\r\n \r\n \r\n 2\r\n \r\n \r\n 3\r\n \r\n \r\n \r\n \r\n Company\r\n NUMBER
\r\n Number\r\n Number\r\n \r\n \r\n \r\n Company\r\n SMALL
\r\n Small\r\n SmallText\r\n \r\n \r\n \r\n Company\r\n YES_NO
\r\n Yes / No\r\n YesNo\r\n Yes\r\n \r\n \r\n Profile\r\n SMALL
\r\n Small\r\n SmallText\r\n \r\n \r\n \r\n Profile\r\n LARGE
\r\n Large\r\n LargeText\r\n \r\n \r\n \r\n Profile\r\n DATE
\r\n Date\r\n Date\r\n 01/01/0001\r\n \r\n \r\n Profile\r\n NUMBER
\r\n Number\r\n Number\r\n \r\n \r\n \r\n Profile\r\n YES_NO
\r\n Yes / No\r\n YesNo\r\n Yes\r\n \r\n \r\n Profile\r\n LIST
\r\n List\r\n List\r\n \r\n \r\n \r\n \r\n \r\n \r\n 1\r\n \r\n \r\n 2\r\n \r\n \r\n 3\r\n \r\n \r\n \r\n \r\n Reservation\r\n DATE
\r\n Date\r\n Date\r\n \r\n \r\n \r\n Reservation\r\n LARGE
\r\n Large\r\n LargeText\r\n \r\n \r\n \r\n Reservation\r\n LIST
\r\n List\r\n List\r\n \r\n \r\n \r\n \r\n \r\n \r\n 1\r\n \r\n \r\n 2\r\n \r\n \r\n 3\r\n \r\n \r\n \r\n \r\n Reservation\r\n NUMBER
\r\n Number\r\n Number\r\n \r\n \r\n \r\n Reservation\r\n SMALL
\r\n Small\r\n SmallText\r\n \r\n \r\n \r\n Reservation\r\n YES_NO
\r\n Yes / No\r\n YesNo\r\n Yes\r\n \r\n \r\n \r\n"
}
}
}
}
}
},
"x-ms-export-notes": [
"The exported API contains schemas that aren't of content type 'application/vnd.ms-azure-apim.swagger.definitions+json', and are hence not exported as Swagger definitions."
]
}