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" : 3111,
  "serie" : 1,
  "name" : "GregoryNancy BénédicteLéana FergusonMorrison",
  "folioType" : {
    "id" : 1,
    "code" : "M",
    "name" : "Main"
  },
  "roomModelroom" : {
    "id" : 910,
    "code" : "109110",
    "name" : "109110",
    "roomSpaceStatusType" : {
      "id" : 12,
      "code" : "CLDI",
      "name" : "CleanDirty"
    },
    "reservationRoomStay" : null
  },
  "reservationRoomStayModelreservationRoomStaySummary" : {
    "id" : 2011,
    "reservationStatusTypereservationRoomStay" : {null,
      "idreservationRoomStayId" : 411,
      "codereservation" : "IH"null,

     "namereservationId" : "InHouse"7,
    "pmsLocator" : }"ALI00000007/11",
    "arrivalcrsLocator" : "2020-01-18"null,
    "departureotaLocator" : "2020-01-19"null,
    "arrivalTimecmLocator" : null,
    "departureTimeholder" : null,
    "quantityarrival" : 1"2020-02-04",
    "accommodationdeparture" : {
 "2020-02-07",
    "idnights" : 6323,
    "productAccommodation" : {
      "id" : 632,
      "name" : "Single"
    },
    "roomproductAccommodationUpgrade" : {null,
      "idroomType" : 9null,
      "codeadult" : "109"1,
      "namejunior" : "109"0,

     "roomSpaceStatusTypechild" : {
   0,
    "idinfant" : 10,
    "extraBed" : 0,
    "codeextraCot" : "CL"0,
    "board" :  {
"name": "Clean"     "id" : }7,
      "reservationRoomStaycode" : null,
    },  "name"  : "adultHalfBoard":,
 1,     "juniorserviceList" : 0,[ {
   "child": 0,
    "infantid" : 061,
    "productFee": {   "name" : "Breakfast"
  "id": 767,   }, {
  "name": "City Tax Barcelona"   "id" : }66,
    "adultFee": 0,   "name" : "juniorFeeDinner":
0,     "childFee": 0,
 } ]
   "infantFee": 0},
    "pmsLocatorguest" : "ALI00000020/25Nancy Léana Morrison",
    "crsLocatorallotment" : null,
    "otaLocatorrate" : {
 null,     "cmLocatorid" : null2,
      "remarkcode" : null"BAR",
      "mainBoardname" : {"Best Available Rate"
    },
    "idoffer" : 6,{
      "codeid" : null2,
      "namecode" : "Bed And BreakfastNR",
      "serviceListname" : ["Non Refundable"
    },
  {  "promotion"         "id": 61,
          "name": "Breakfast"
        }
      ]
    },
    "reservationRoomStayGuests": [
      {
        "id": 35,
        "documentType": {
          "id": 2,
          "code": "2",
          "name": "Passport"
        },
        "documentNumber": "cagdROWL",
        "givenName": "Gregory",
        "middleName": "Bénédicte",
        "surName": "Ferguson",
        "genderType": {
          "id": 1,
          "code": "M",
          "name": "Male"
        },
        "birthDate": "2002-02-13",
        "birthCountryCode": "CF",
        "birthPlace": "Van Nuys",
        "effectiveDate": "2019-02-13",
        "expireDate": "2019-02-13",
        "street": "9417 Buena Vista Terrace",
        "city": "Van Nuys",
        "stateProvName": "California",
        "stateProvCode": null,
        "countryCode": "CF",
        "postalCode": "91411",
        "nationalityCountryCode": "CF",
        "ocr": null,
        "email": "alongf4@seesaa.net",
        "phoneNumber": "1-(661)969-2605"
      }
    ],
    "reservationRoomStayDaily": [
      {
        "id": 65,
        "date": "2020-01-18",
        "room": {
          "id": 9,
          "code": "109",
          "name": "109",
          "roomSpaceStatusType": {
            "id": 1,
            "code": "CL",
            "name": "Clean"
          },
          "reservationRoomStay": null
        },
        "allotment": null,
        "rate": {
          "id": 1,
          "code": "BAR",
          "name": "Best Available Rate"
        },
        "price": 124.200000,
        "currency": {
          "id": 1,
          "code": "EUR",
          "name": "Euro"
        },
        "offer": {
          "id": 1,
          "code": "NR",
          "name": "Non Refundable"
        },
        "offerAmountDiscount": 0.000000,
        "offerPercentDiscount": 10.000000,
        "promotion": null,
        "promotionAmountDiscount": null,
        "promotionPercentDiscount": null,
        "board": {
          "id": 6,
          "code": null,
          "name": "Bed And Breakfast",
          "serviceList": [
            {
              "id": 61,
              "name": "Breakfast"
            }
          ]
        },
        "boardPriceAdult": 22.000000,
        "boardPriceJunior": 49.000000,
        "boardPriceChild": 0.000000,
        "boardPriceInfant": 0.000000,
        "paymentType": {
          "id": 1,
          "code": "G",
          "name": "Pay Guest"
        },
        "propertyPolicy": {
          "id": 7,
          "code": "NR",
          "name": "Non Refundable"
        },
        "propertySource": {
          "id": 12,
          "code": "EMA",
          "name": "Email"
        },
        "propertySegment": {
          "id": 25,
          "code": "CAGE",
          "name": "Company Agent"
        },
        "propertyChannel": {
          "id": 8,
          "code": "GDS",
          "name": "GDS"
        },
        "booker": null,
        "billTo": {
          "id": 121,
          "name": "Jaxnation",
          "code": null,
          "taxId": "78230110",
          "iataId": null,
          "companyEmailList": [
            {
              "id": 121,
              "primary": true,
              "emailAddressType": {
                "id": 1,
                "code": "1",
                "name": "Personal"
              },
              "email": "wpeters31@ning.com",
              "remark": null
            }
          ],
          "companyAddressList": [
            {
              "id": 121,
              "primary": true,
              "communicationLocationType": {
                "id": 1,
                "code": "1",
                "name": "Home"
              },
              "street": "29 Farmco Drive",
              "city": "San Antonio",
              "stateProvName": "Pontevedra",
              "stateProvCode": "ES-PO",
              "postalCode": "78230",
              "countryCode": "ES",
              "remark": "Address Remark"
            }
          ],
          "companyPhoneList": [
            {
              "id": 121,
              "primary": true,
              "phoneLocationType": {
                "id": 6,
                "code": "6",
                "name": "Home"
              },
              "phoneTechType": {
                "id": 1,
                "code": "1",
                "name": "Voice"
              },
              "countryAccessCode": "+34",
              "areaCityCode": "B",
              "phoneNumber": "1-(830)708-5101",
              "extension": "1",
              "remark": "Phone Remark"
            }
          ],
          "companyTaxAddress": {
            "id": 111,
            "communicationLocationType": null,
            "street": "29 Farmco Drive",
            "city": "San Antonio",
            "stateProvName": "Zamora",
            "stateProvCode": "ES-ZA",
            "postalCode": "78230",
            "countryCode": "ES",
     : null,
    "accommodationAmount" : 467.700000,
    "boardAmount" : 156.000000,
    "serviceAmount" : 120.000000,
    "totalAmount" : 743.700000,
    "currency" : {
      "id" : 1,
      "remarkcode" : "Address RemarkEUR",
      "name" : "Euro"
 },   },
       "remarkbooker" : "Company{
Remarks"      "id" :  }911,
      "name" : "centralWordtune": null,
        "companycode" : {null,
      "taxId"   : "id34233900": 997,
   
      "nameiataId" : "Oozz"null,
          "codecompanyEmailList" : null,[  {
        "taxIdid" : "87110986"911,
          "iataIdprimary" : nulltrue,
          "companyEmailListemailAddressType" : [{
          "id" : {1,
          "code" :   "id1":,
 997,         "name" : "Personal"
   "primary": true,    },
        "email" : "emailAddressTypenmorrisonoz@ehow.com":,
{        "remark" : null
      "id": 1} ],
      "companyAddressList" : [ {
        "codeid" : "1"911,
        "primary" : true,
      "name":  "PersonalcommunicationLocationType" : {
          "id" : }1,
              "emailcode" : "ldayrd@phpbb.com1",
   
          "remarkname" : null"Home"
        },
   }     "street" : "8 Glendale   ]Place",
        "city" : "companyAddressListSarasota":,
[        "stateProvName" : "Álava",
  {      "stateProvCode" : "ES-VI",
        "idpostalCode" : 997"34233",
              "primary": true,
     "countryCode" : "ES",
        "communicationLocationTyperemark" : {"Address Remark"
      }  ],
      "idcompanyPhoneList" : 1,[ {
        "id" : 911,
        "codeprimary" : "1"true,
        "phoneLocationType" : {
     "name": "Home"    "id" : 6,
        },  "code" : "6",
          "streetname" :  "Home"8581
Delladonna Trail",       },
       "city": "AlbuquerquephoneTechType", :   {
          "stateProvNameid" : "Albacete"1,
              "stateProvCodecode" : "ES-AB1",
              "postalCodename" : "87110Voice",
        },
        "countryCodecountryAccessCode" : "ES+34",
              "remark""areaCityCode" : "Address RemarkB",
         "phoneNumber" :  }"1-(941)176-0996",
        "extension" :  ],
 "1",
        "companyPhoneListremark" : ["Phone Remark"
      } ],
   {   "companyTaxAddress" :  {
        "id" : 997901,
              "primary""communicationLocationType" : truenull,
        "street" : "8 Glendale Place",
  "phoneLocationType": {     "city" : "Sarasota",
         "idstateProvName" : 6"Pontevedra",
        "stateProvCode" : "ES-PO",
        "codepostalCode" : "634233",
        "countryCode" : "ES",
        "nameremark" : "HomeAddress Remark"
      },
      "remark" },: "Company Remarks"
       },
    "phoneTechTypebillTo" : {
      "id"  : 836,
      "idname" : 1"Dabtype",
      "code" : null,
       "codetaxId" : "140293825",
      "iataId" : null,
       "namecompanyEmailList" : "Voice"[ {
        "id" : 836,
  },      "primary" : true,
      "countryAccessCode":  "+34emailAddressType", : {
            "areaCityCodeid" : "B"1,
              "phoneNumbercode" : "1-(505)216-1400",
              "extensionname" : "1Personal",
        },
        "remarkemail" : "Phone Remark"jfoxmw@sfgate.com",
        "remark" : null
 }     } ],
    ],  "companyAddressList" : [ {
     "companyTaxAddress": {  "id" : 836,
        "idprimary" : 987true,
            "communicationLocationType": null, : {
          "streetid" : "8581 Delladonna Trail"1,
            "citycode" : "Albuquerque1",
            "stateProvNamename" : "BarcelonaHome",
        },
        "stateProvCodestreet" : "ES-B52865 Main Drive",
            "postalCodecity" : "87110Louisville",

           "countryCodestateProvName" : "ESKentucky",
  
         "remark": "Address Remark"stateProvCode" : null,
        },"postalCode" : "40293",
        "remarkcountryCode" : "Company RemarksLA",
        }"remark" : "Address Remark"
   }   }  ],
      "reservationRoomStayServiceListcompanyPhoneList" : [
      {
        "id" : 27836,
        "serviceprimary" : {
true,
         "idphoneLocationType" : 74,
          "name": "Parking"{
          "id" : }6,
          "startDatecode" : "2020-01-186",
          "endDatename" : "2020-01-19Home",
        "quantity": 1},
        "reservationRoomStayServiceDailyListphoneTechType" : [{
          {"id" : 1,
          "idcode" : 72"1",
            "datename" : "2020-01-18",Voice"
        },
        "ratecountryAccessCode" : null"+34",
        "areaCityCode"   : "priceB": 10.000000,
        "phoneNumber" :   "currency": {"1-(502)141-5836",
        "extension" : "1",
    "id": 1,   "remark" : "Phone Remark"
      } ],
"code": "EUR",     "companyTaxAddress" : {
       "name": "Euroid" : 826,
        "communicationLocationType" : }null,
        "street" : "52865 Main Drive"offer": null,
        "city" :   "offerAmountDiscountLouisville": null,
        "stateProvName" :   "offerPercentDiscountKentucky": null,
            "promotionstateProvCode" : null,
   
        "promotionAmountDiscount": null,
   postalCode" : "40293",
        "promotionPercentDiscountcountryCode" : null"ET",
            "postingDateremark" : "2020-02-13Address Remark"
          },
      "remark" : ]"Company Remarks"
     },
    "central" : {null,
        "idcompany" : 28null,
        "serviceroom" : {
 
        "id": 74,
  : 10,
      "namecode" : "Parking110",
      "name" : }"110",
 
      "startDateroomSpaceStatusType" : "2020-01-18",{
        "endDateid" : "2020-01-19"2,
        "quantitycode" : 1"DI",
        "reservationRoomStayServiceDailyListname" : ["Dirty"
      },
     { "reservationRoomStay" : null
    },
    "idpaymentType" : {
  73,    "id" : 1,
      "datecode" : "2020-01-18G",
      "name" : "Pay Guest"
   "rate": null},
    "propertyPolicy" : {
      "priceid" : 10.0000007,
      "code" : "NR",
   "currency": {  "name" : "Non Refundable"
    },
    "idpropertySource" : 1,{
      "id" : 9,
      "code" : "EURCOM",
              "name" : "EuroCompany"
    
       },
    "propertyChannel" : {
      "offerid" : null7,
      "code"  :    "offerAmountDiscountCRS": null,
      "name" :     "offerPercentDiscountCRS":
null,    },
    "propertySegment" : {
 "promotion": null,    "id" : 25,
      "promotionAmountDiscountcode" : null"CAGE",
      "name" : "Company Agent"
   "promotionPercentDiscount": null},
    "reservationStatusType" : {
     "postingDate": "2020-02-13id" : 4,
      "code" : }"IH",
      "name" : ]"InHouse"
    },
 }   "expiredDate" : ]null
  }
}