Operations on Reservations

Get Reservation

Description

Get a specific Reservation with the specified data.

Request

URI

https://api.pricetravel.com/services/bookings/summary

Verb

GET

Parameters

IdReservation: string
CustomerEmail: string

Headers

Accept (optional)

Response

Response code

200 (OK)

Body

XML

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfReservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Reservation>
    <CreationDate>date</CreationDate>
    <CustomerName>string</CustomerName>
    <Id>string</Id>
    <ExternalId>string</ExternalId>
    <Uri>string</Uri>
  </Reservation>
</ArrayOfReservation>

JSON

  {
   "Id":"string",
   "CustomerInformation":
    {
      "FirstName":"string",
      "LastName":"string",
      "Email":"string",
      "Phone":"string",
      "MobilePhone":"string"
    },
    "Items":
     {
      "Insurances":
       [
        {
         "InsuranceName":"string",
         "StartValidityDate":"datetime",
         "EndValidityDate":"datetime",
         "PurchaseCountry":"string",
         "Destination":"string",
         "InsuredPaxCount":int,
         "Type": int
        }
       ],
      "Transfer":
      [
       {
        "TransferType":int,
        "PaxCount":int,
        "HotelName":"string",
        "Airport":"string",
        "ArrivalDate":"datetime",
        "ArrivalFlightAirline":"string",
        "ArrivalFlightNumber":"string",
        "DepartureDate":"datetime",
        "DepartureFlightAirline":"string",
        "DepartureFlightNumber":"string"
       }
      ]
     }
    }

Errors

400 (Bad Request)

The parameters dateRange.From and dateRange.To are missing or the values supplied are not valid.

401 (Unauthorized)

Invalid “Authorization” header.

404 (Not Found)

No Reservations could be found.

Create Reservation

Description

Creates a Reservation with the items sent in the body of the request.

Request

URI

https://api.pricetravel.com/services/bookings/create

Verb

POST

Headers

Accept (optional)

Body

   <?xml version="1.0" encoding="utf-8" ?>
<Reservation>
  <ExternalId>string</ExternalId>
  <Services>
    <HotelItems />
    <TransferItems />
    <TourItems />
  </Services>
  <CustomerInformation>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Email>string</Email>
    <Phone>string</Phone>
    <MobilePhone>string</MobilePhone>
    <SpecialRequests>string</SpecialRequests>
  </CustomerInformation>
  <PaymentInformation>
    <Method>[CreditCard, Credit]</Method>
    <CreditCardType>[AMEX, VISA, MC]</CreditCardType>
    <CreditCardNumber>string</CreditCardNumber>
    <CreditCardExpirationMonth>string</CreditCardExpirationMonth>
    <CreditCardExpirationYear>string</CreditCardExpirationYear>
    <CreditCardName>string</CreditCardName>}
    <CreditCardAddress>string</CreditCardAddress>
    <CreditCardCity>string</CreditCardCity>
    <CreditCardState>string</CreditCardState>
    <CreditCardZipCode>string</CreditCardZipCode>
    <CreditCardCountryCode>string</CreditCardCountryCode>
  </PaymentInformation>
</Reservation>

JSON


{
   "CustomerInformation" :{
       "FirstName":"string",
       "LastName":"string",
       "Email": "string",
       "Phone": "string",
       "MobilePhone":"string"
   },
   "PaymentInformation" :{
       "PaymentMethod": integer (1 for credit card only), 
       "CreditCardInformation":{
         "Type": integer, (NONE = 0, VISA = 1, MC = 2, AMEX = 3, PT = 4, DINERS = 5, CREDENCIAL = 6, MAESTRO = 7, EXITO = 8, CODENSA = 9,)
         "Number":"string", (No separator)
         "ExpirationMonth" : int, (MM) 
         "ExpirationYear" : int, (YYYY)
         "SecurityCode": "string", (This is the CCV, 3 or 4 digit max)
         "CardHolderName" :"string",
         "Street":"string",
         "City":"string",
         "State":"string",
         "CountryCode":"string" (MX, US, CO, etc),
         "ZipCode":"string",
         "PaymentPlan": integer (Number of months the charge will be split, recommended value is 1),
         "Surcharge":float,
         "BankName":"string"
      }
   },
   "ReservationSettings" :{
       "Currency":"string",
       "Language":"string",
       "IpAddress":"string" ('0.0.0.0' Format)
   },
    "ServiceItems":{
       "Hotel":{ 
          "RatePlanId": int ,
          "HotelId": int ,
          "RoomId": int ,
          "ArrivalDate": "string",
          "DepartureDate": "string",
          "NumberOfRooms":int ,
          "Currency": "string",
          "TotalAmount": decimal,
          "IsPackageRate": boolean,
          "Rooms":[ 
            {
               "Adults": int,
               "ChildAges":[] int
            },
         ],
          "Type":1 (Fixed Value for Hotel)
        },
       "Flight":{
          "TripMode": int (0-OneWay, 1-RoundTrip, 2-MultipleDestinations),
          "TripCabin": int (0-None, 1-FirstClass, 2-Business, 3-Economy, 4-EconomyPremium, 5-EconomyStandard),
          "Adults": int,
          "Seniors": int,
          "ChildAges": [] int,
          "PromotionalCode": "string",
          "IsPackageRate": boolean,
          "TotalAmount": decimal,
          "EmergencyContact": 
            {
               "FirstName": "string",
               "LastName": "string",
               "PhoneNumber": "string",
               "Title": "string",
               "bool": WasProvided
            },
          "ExtraCodes": [] "string",
          "FlightPassengers": 
            {
               "Title": "string",
               "Names": "string",
               "LastNames": "string",
               "PassengerIndex": int,
               "RequireAdditionalUsaInformation": bool,
               "Sex": int (0-Unkown, 1-Male, 2-Female),
               "Type": int (0-Adult, 1-Minor, 2-Senior),
               "BirthDateDay": int (DD),
               "BirthDateMonth": int (MM),
               "BirthDateYear": int (YYYY),
               "FrequentFlyerNumber": string,
               "FrequentFlyerProgram": string,
               "ExtraServicesCodes": string,             
            },
           "Flights":
            {
               "DepartureFlights":
                {
                  "DepartureAirportCode": "string",
                  "ArrivalAirportCode": "string",
                  "DepartureDateTime": "datetime",
                  "ArrivalDateTime": "datetime",
                  "FlightNumber": "string"
                },
                "ReturningFlights":
                {
                  "DepartureAirportCode": "string",
                  "ArrivalAirportCode": "string",
                  "DepartureDateTime": "datetime",
                  "ArrivalDateTime": "datetime",
                  "FlightNumber": "string"
                } 
            } 
            
            "Type": 2 (Fixed Value for Flight) 
         },
         "Tours":
         [
            {
                "Id": int,
                "ArrivalDate": "datetime",
                "DepartureDate": "datetime",
                "TotalAmount": decimal,
                "Adults": int,
                "ChildValues": [] int,
                "HotelName": "string",
                "TourTime": "string"
                "Type": 6
            }
         ],
         "Transfer":
         {
            "Id": int,
            "TransferRateId": int,
            "TransferType": int, (0-None,1-Roundtrip,2-AirportToHotel,)
            "ArrivalDate": "datetime",
            "ArrivalTime": "string",
            "ArrivalFlightNumber": "string",
            "ArrivalFlightAirline": "string",
            "DepartureDate": "datetime",
            "DepartureTime": "string"
            "DepartureFlightNumber": "string",
            "DepartureFlightAirline": "string",
            "NumberOfAdults": int,
            "ChildAges": [] int,            
            "AirportCode": "string",
            "HotelId": int,
            "TotalAmount": decimal,
            "Type": 5
         },
         "Insurance":
         {
            "Currency": "string",
            "Amount": decimal,
            "InsuranceType": int,
            "InsuranceItemId": int,
            "InsuranceRateId": int,
            "Name": "string",
            "Description": "string",
            "IsDefault": bool,
            "Adults": int,
            "Kids": int,
            "StartDate": "datetime",
            "EndDate": "datetime",
            "TotalAmount": decimal,
            "Type": 4
         }         
     } ,
   
   "KeyValidation": "string" (must be a valid GUID)
}

Response

Response code

200 (OK)

Body

XML

<?xml version="1.0" encoding="utf-8" ?>
<Reservation>
  <Id>string</Id>
  <ExternalId>string</ExternalId>
  <Services>
    <HotelItems>
      <HotelItem>
        <ItemId>string</ItemId>
        <CancellationPolicy>string</CancellationPolicy>
      </HotelItem>
    </HotelItems>
    <TransferItems>
      <ItemId>string</ItemId>
      <CancellationPolicy>string</CancellationPolicy>
    </TransferItems>>
    <TourItems>
      <ItemId>string</ItemId>
      <CancellationPolicy>string</CancellationPolicy>
    </TourItems>
  </Services>
</Reservation>

JSON

{
    "Id": string 
    "ExternalId": string 
    "Services": [ 
    "HotelItems": [
        {
           "ItemId": string
           "CancellationPolicy": string
        }
    ],
    "TransferItems": [
        {
           "ItemId": string
           "CancellationPolicy": string
        }
    ],
    "TourItems": [
        {
           "ItemId": string
           "CancellationPolicy": string
        }
    ]
}

400 (Bad Request)

There is an error in the Request.

401 (Unauthorized)

Invalid “Authorization” header.