Operation
Version minifield of the list folio, use for POS.
| Rw ui textbox macro | ||
|---|---|---|
| ||
Only accessible with permission of pms.integration.folio |
| Style |
|---|
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
} |
| Div | ||
|---|---|---|
| ||
GET |
| Div | ||
|---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/folio/pos |
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| onlyExtras | Boolean | false | request parameter | false | Only gets extra folios for each reservationRoomStay, and if there are not any of that kind, it gets the first main folio. |
| roomId | Integer | false | request parameter | ||
| roomCode | String | false | request parameter | ||
| roomName | String | false | request parameter | ||
| folioCode | String | false | request parameter | ||
| reservationStatusTypeId | Integer | false | request parameter | This parameter will return folios of reservations that were marked in a specific status If value is: 1- Status is Reserved 2- Status is Cancelled 3- Status is NoShow 4- Status is inHouse 5- Status is Checkedout | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
| sort | string | false | request parameter | id | Property of the entity to sort by. |
| sortMode | string | false | request parameter | Asc | Mode of sorting. |
Example request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/folio/pos |
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true | Description of the response of the success operation |
Entity
The entity returned is a Page with a list of Folios. Description of the Folio entity:
Insert excerpt FolioPOS FolioPOS nopanel true
| Code Block | ||
|---|---|---|
| ||
{
"count": 41,
"offset": 0,
"limit": 10,
"list": [
{
"id" : 8748,
"sequence" : 28727124,
"code" : "ATRX109",
"serie" : 1,
"name" : "ATRAPALO.COM S.L.Maëlle Diaz, Katherine",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main"
},
"room": {
"id": null9,
"reservationRoomStaySummary" : null "code": "109"
},
"reservationRoomStaySummary": {
"id" : 89,19,
"sequencearrival" : 37095,"2023-12-24",
"code" "departure": "CAF 2024-01-11",
"serie" : 1, "adult": 4,
"name" : " , CAFETERIA", "folioTypeboard" : {
"id": 5,
"chainBoardId": 1,
"code" : "MRO",
"name" : "MainRoom Only",
"nameI18n" : "Main"Room Only",
}, "roomserviceList" : null,
"reservationRoomStaySummary" : null },
{ "guest"id: "Maëlle :Diaz, 96,Katherine",
"sequence" "hasCredit": 36711true,
"code" : "DESA", "creditAvailable": null,
"seriecustomerPreference" : 1null,
"name" : " , CONTADOS/TARJETAS DESAYUNOS",
"folioType" : { "reservationRoomStayGuestList": [
{
"id": 44,
"profileId": 1338,
"documentType": {
"id" : 1,5,
"code" : "MD",
"name" : "MainNational identity document",
"nameI18n" : "Main"National identity document"
},
"room" : null, "documentNumber": "sZuPwCRi",
"reservationRoomStaySummary" : null }, { "idgivenName" : 15520,"Katherine",
"sequence" : 37550, "surName": "Maëlle",
"codesecondSurName" : "413Diaz",
"serie" : 2, "name" : "BLOKZIJL BLOKZIJL, SEBASTIAAN", "folioTypegenderType" : {
"id" : 2,1,
"code" : "EM",
"name" : "ExtraMale",
"nameI18n" : "ExtraMale"
},
"room" : { "idbirthDate" : 201"2006-01-16",
"code" "birthCountryCode": "413"ES",
}, "reservationRoomStaySummary" : { "idbirthPlace" : 11661"Cincinnati",
"arrival" "effectiveDate": "20222023-0301-16",
"departure" "expireDate": "20222026-0301-1716",
"adult" : 3 "street": "9490 Manufacturers Alley",
"city": "Cincinnati",
"board" : { "stateProvName": null,
"stateProvCode": "ES-BI",
"id" : 1,"countryCode": "ES",
"postalCode": "45203",
"codenationalityCountryCode" : "SAES",
"name" "countryOfIssuanceCode": "Sólo AlojamientoES",
"serviceList" : null "ocr": null,
} "email": "dphillips6y@sciencedirect.com",
"guest" : "BLOKZIJL BLOKZIJL, SEBASTIAAN", "phoneNumber": "1-(513)398-3146",
"allowMarketing": null,
"hasCredit" "allowThirdParty": falsenull,
"creditAvailable" : -91.340000, "language": null,
"customerPreferenceregistrationNumber" : "Fumador39, Mascotas, Spa incluido"
"reservationRoomStayGuestCustomFieldValueSet": null
}
]
}
}
]
} |