Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.folio


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}


.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/chain/{chainId}/property/{propertyId}/folio/{folioId}



Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
folioIdIntegertrue
Unique identificator of the folio.


Example request

Code Block
languagepowershell
themeDJango
GET https://prod.ulysescloud.com/public/api/v1/chain/1/property/1/folio/1



Response

PropertyTypeRequiredDescription
FolioFolio
The Folio requested by its Id.

Entity

Insert excerpt
Folio
Folio
nopaneltrue


Example response

Code Block
themeDJango
{
	"id": 14,
	"serie": 1,
	"name": "Eire",
	"folioType": {
		"id": 1,
		"code": "M",
"serie		"name": "Main"
	},
	"roomModel": {
		"id": 1,
		"code": "101",
		"name": "Wayne Geneviève Harrison",
  "folioType"R101",
		"roomModuleStatusType": {
			"id": 2,
			"code": "DI",
			"name": "M",
  "roomDirty"
		}
	},
	"reservationRoomStayModel": {
		"id": 24,
		"reservationStatusType": {
			"id": 4,
			"code": "COM",
			"name": "Committed"
		},
		"reservationSituationType": {
			"id": 3,
			"code": "IH",
			"name": "InHouse"
		},
		"arrival": "2019-04-29",
		"departure": "2019-05-02",
		"arrivalTime": null,
		"departureTime": null,
		"101quantity": 1,
		"accommodation": {
			"id": 79,
			"name": "Junior Suite"
		},
		"adult": 1,
		"junior": 0,
"Room 101"
  },
  "reservationRoomStay": {
    "idReservation": 1,
    "arrival": "2018-04-05",
    "departure		"child": 0,
		"infant": 0,
		"productFee": {
			"id": 79,
			"name": "Junior Suite"
		},
		"adultFee": 1,
		"juniorFee": 0,
		"childFee": 0,
		"infantFee": 0,
		"pmsLocator": "0000000024/32",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"remark": null,
		"mainProductBoard": null,
		"reservationRoomStayGuests": [{
			"id": 48,
			"documentType": {
				"id": 5,
				"code": "5",
				"name": "National identity document"
			},
			"documentNumber": "hcHieiOT",
			"givenName": "Richard",
			"middleName": "Réjane",
			"surName": "Wells",
			"genderType": {
				"id": 2,
				"code": "F",
				"name": "Female"
			},
			"birthDate": "2001-04-30",
			"birthCountry": {
				"id": 199,
				"code": "ESP",
				"name": "SPAIN"
			},
			"birthPlace": "Peoria",
			"effectiveDate": "2018-04-30",
			"expireDate": "2018-04-1330",
			"street": "9101 Portage Street",
			"city": "Peoria",
			"stateProvName": null,
			"stateProv": {
				"adultid": 1,
				"code": "ES-C",
				"name": "La Coruña",
				"country": {
					"id": 199,
					"code": "ESP",
					"name": "SPAIN"
				}
			},
			"country": {
				"id": 199,
				"code": "ESP",
				"juniorname": 0,
    "child": 0,
    "infant": 0,
    "reservationRoomStayGuestModelArray": [
      {
        "givenName": "Wayne",
        "middleName": "Geneviève",
        "surName": "Harrison"
      }
    ],
    "mainProductBoard": {
       "id": 56,
       "name": "RoomOnly"
     },
   "SPAIN"
			},
			"postalCode": "85383",
			"nationalityCountry": {
				"id": 199,
				"code": "ESP",
				"name": "SPAIN"
			},
			"ocr": null,
			"email": "jbailey6n@berkeley.edu",
			"phoneNumber": "1-(928)620-1967"
		}],
		"reservationRoomStayDaily": [{
				"id": 78,
				"date": "2019-04-29",
				"allotment": null,
				"rate": {
					"id": 1,
					"code": "BAR",
					"name": "Best Rate Available"
				},
				"price": 358,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"productBoard": {
					"id": 112,
					"name": "HalfBoard"
				},
				"boardPriceAdult": 20,
				"boardPriceJunior": null,
				"boardPriceChild": null,
				"boardPriceInfant": null,
				"paymentType": {
					"id": 5,
					"code": "AG",
					"name": "Pay Agency Guest"
				},
				"propertyPolicy": {
					"id": 57,
					"code": "24H",
					"name": "24 Hours Before Arrival"
				},
				"propertySource": {
					"id": 2,
					"code": "AGE",
					"name": "Agency"
				},
				"propertySegment": {
					"id": 101,
					"code": "EMP",
					"name": "Employee"
				},
				"propertyChannel": {
					"id": 24,
					"code": "IDS",
					"name": "IDS"
				},
				"postingDate": "2019-04-30"
			},
			{
				"id": 2061,
				"date": "2019-04-30",
				"allotment": null,
				"rate": {
					"id": 1,
					"code": "BAR",
					"name": "Best Rate Available"
				},
				"price": 358,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"productBoard": {
					"id": 112,
					"name": "HalfBoard"
				},
				"boardPriceAdult": 20,
				"boardPriceJunior": null,
				"boardPriceChild": null,
				"boardPriceInfant": null,
				"paymentType": {
					"id": 5,
					"code": "AG",
					"name": "Pay Agency Guest"
				},
				"propertyPolicy": {
					"id": 57,
					"code": "24H",
					"name": "24 Hours Before Arrival"
				},
				"propertySource": {
					"id": 2,
					"code": "AGE",
					"name": "Agency"
				},
				"propertySegment": {
					"id": 101,
					"code": "EMP",
					"name": "Employee"
				},
				"propertyChannel": {
					"id": 24,
					"code": "IDS",
					"name": "IDS"
				},
				"postingDate": "2019-05-01"
			},
			{
				"id": 2062,
				"date": "2019-05-01",
				"allotment": null,
				"rate": {
					"id": 1,
					"code": "BAR",
					"name": "Best Rate Available"
				},
				"price": 358,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"productBoard": {
					"id": 112,
					"name": "HalfBoard"
				},
				"boardPriceAdult": 20,
				"boardPriceJunior": null,
				"boardPriceChild": null,
				"boardPriceInfant": null,
				"paymentType": {
					"id": 5,
					"code": "AG",
					"name": "Pay Agency Guest"
				},
				"propertyPolicy": {
					"id": 57,
					"code": "24H",
					"name": "24 Hours Before Arrival"
				},
				"propertySource": {
					"id": 2,
					"code": "AGE",
					"name": "Agency"
				},
				"propertySegment": {
					"id": 101,
					"code": "EMP",
					"name": "Employee"
				},
				"propertyChannel": {
					"id": 24,
					"code": "IDS",
					"name": "IDS"
				},
				"postingDate": "2019-05-02"
			}
		],
		"reservationRoomStayServiceList": null
	}
}