POST Bookings/InsertBook

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HashCode	string	None.
ClientID	integer	None.
InternalComments	string	None.
ExternalComments	string	None.
Pax	Collection of BookPax	None.
Service	BookDetail	None.
ConfirmationEmail	string	None.
Emails	Collection of BookEmails	None.
Questions	Collection of BookQuestion	None.
FileNumber	string	None.
BookType	string	None.
Adults	integer	None.
Childs	integer	None.
Infants	integer	None.
StartDate	string	None.
EndDate	string	None.

Request Formats

application/json, text/json

Sample:

{
  "HashCode": "sample string 1",
  "ClientID": 2,
  "InternalComments": "sample string 3",
  "ExternalComments": "sample string 4",
  "Pax": [
    {
      "ID": 1,
      "BookID": 2,
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Email": "sample string 6",
      "Address": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "Age": 11,
      "Type": 1,
      "Holder": true,
      "RoomNumber": 13,
      "ProductCode": "sample string 14",
      "RateKey": "sample string 15",
      "PaxIndex": 16,
      "DocumentNumber": "sample string 17",
      "DocDay": "sample string 18",
      "DocMonth": "sample string 19",
      "DocYear": "sample string 20",
      "BirthDay": "sample string 21",
      "BirthMonth": "sample string 22",
      "BirthYear": "sample string 23",
      "AppKey": "sample string 24",
      "HasError": true,
      "ErrorDescription": "sample string 26"
    },
    {
      "ID": 1,
      "BookID": 2,
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Email": "sample string 6",
      "Address": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "Age": 11,
      "Type": 1,
      "Holder": true,
      "RoomNumber": 13,
      "ProductCode": "sample string 14",
      "RateKey": "sample string 15",
      "PaxIndex": 16,
      "DocumentNumber": "sample string 17",
      "DocDay": "sample string 18",
      "DocMonth": "sample string 19",
      "DocYear": "sample string 20",
      "BirthDay": "sample string 21",
      "BirthMonth": "sample string 22",
      "BirthYear": "sample string 23",
      "AppKey": "sample string 24",
      "HasError": true,
      "ErrorDescription": "sample string 26"
    }
  ],
  "Service": {
    "ID": 1,
    "BookID": 2,
    "ProviderType": 1,
    "ProductCode": "sample string 3",
    "ProductDescription": "sample string 4",
    "ModalityCode": "sample string 5",
    "AccommodationCode": "sample string 6",
    "Quantity": 7,
    "TotalAdults": 8,
    "TotalChilds": 9,
    "TotalInfant": 10,
    "Status": 1,
    "StartDate": "sample string 11",
    "EndDate": "sample string 12",
    "Nights": 13,
    "IssuedVoucher": true,
    "Comments": "sample string 15",
    "ClientPaymentStatus": 0,
    "SupplierPaymentStatus": 0,
    "Billed": true,
    "AdultCostValue": 17.1,
    "ChildCostValue": 18.1,
    "InfantCostValue": 19.1,
    "AdultSaleValue": 20.1,
    "ChildSaleValue": 21.1,
    "InfantSaleValue": 22.1,
    "TotalAgencyCost": 23.1,
    "CancellationDate": "sample string 24",
    "CancellationValue": 25.1,
    "CancellationDates": [
      {
        "ID": 1,
        "BookID": 2,
        "ServiceID": 3,
        "CancellationDate": "sample string 4",
        "CancellationValue": 5.1,
        "HasError": true,
        "ErrorDescription": "sample string 7"
      },
      {
        "ID": 1,
        "BookID": 2,
        "ServiceID": 3,
        "CancellationDate": "sample string 4",
        "CancellationValue": 5.1,
        "HasError": true,
        "ErrorDescription": "sample string 7"
      }
    ],
    "SupplierID": "sample string 26",
    "SupplierCode": "sample string 27",
    "SupplierProvider": "sample string 28",
    "SupplierProviderID": 29,
    "VoucherNumber": 30,
    "VoucherPath": "sample string 31",
    "RoomNumber": 32,
    "ProviderReference": "sample string 33",
    "ProviderReferenceBook": "sample string 34",
    "FlightNumber": "sample string 35",
    "FlightTime": "sample string 36",
    "FlightSegments": [
      {
        "ID": 1,
        "BookID": 2,
        "cDataVoos": "sample string 3",
        "cBookingCode": "sample string 4",
        "cCabinClass": "sample string 5",
        "cNrMalas": "sample string 6",
        "cModelo": "sample string 7",
        "cTerminal": "sample string 8",
        "cTerminal1": "sample string 9",
        "cClass": "sample string 10",
        "cKey": "sample string 11",
        "cGroup": "sample string 12",
        "cCarrier": "sample string 13",
        "cFlightNumber": "sample string 14",
        "cOrigin": "sample string 15",
        "cDestination": "sample string 16",
        "cNameOrigin": "sample string 17",
        "cNameDestination": "sample string 18",
        "cDepartureTime": "sample string 19",
        "cArrivalTime": "sample string 20",
        "cFlightTime": "sample string 21",
        "cFlightTimeConv": "sample string 22",
        "cDistance": "sample string 23",
        "cETicketability": "sample string 24",
        "cEquipment": "sample string 25",
        "cChangeOfPlane": "sample string 26",
        "cAvailabilitySource": "sample string 27",
        "cAllotment": "sample string 28",
        "cIdaVolta": 29,
        "HasError": true,
        "ErrorDescription": "sample string 31"
      },
      {
        "ID": 1,
        "BookID": 2,
        "cDataVoos": "sample string 3",
        "cBookingCode": "sample string 4",
        "cCabinClass": "sample string 5",
        "cNrMalas": "sample string 6",
        "cModelo": "sample string 7",
        "cTerminal": "sample string 8",
        "cTerminal1": "sample string 9",
        "cClass": "sample string 10",
        "cKey": "sample string 11",
        "cGroup": "sample string 12",
        "cCarrier": "sample string 13",
        "cFlightNumber": "sample string 14",
        "cOrigin": "sample string 15",
        "cDestination": "sample string 16",
        "cNameOrigin": "sample string 17",
        "cNameDestination": "sample string 18",
        "cDepartureTime": "sample string 19",
        "cArrivalTime": "sample string 20",
        "cFlightTime": "sample string 21",
        "cFlightTimeConv": "sample string 22",
        "cDistance": "sample string 23",
        "cETicketability": "sample string 24",
        "cEquipment": "sample string 25",
        "cChangeOfPlane": "sample string 26",
        "cAvailabilitySource": "sample string 27",
        "cAllotment": "sample string 28",
        "cIdaVolta": 29,
        "HasError": true,
        "ErrorDescription": "sample string 31"
      }
    ],
    "HasError": true,
    "ErrorDescription": "sample string 38"
  },
  "ConfirmationEmail": "sample string 5",
  "Emails": [
    {
      "Email": "sample string 1"
    },
    {
      "Email": "sample string 1"
    }
  ],
  "Questions": [
    {
      "ID": 1,
      "BookID": 2,
      "Type": 1,
      "TravelType": 1,
      "Question": "sample string 3",
      "Answer": "sample string 4",
      "HasError": true,
      "ErrorDescription": "sample string 6"
    },
    {
      "ID": 1,
      "BookID": 2,
      "Type": 1,
      "TravelType": 1,
      "Question": "sample string 3",
      "Answer": "sample string 4",
      "HasError": true,
      "ErrorDescription": "sample string 6"
    }
  ],
  "FileNumber": "sample string 6",
  "BookType": "sample string 7",
  "Adults": 8,
  "Childs": 9,
  "Infants": 10,
  "StartDate": "sample string 11",
  "EndDate": "sample string 12"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Book

Name	Type	Additional information
ID	integer	None.
HashCode	string	None.
FileNumber	string	None.
ClientID	integer	None.
AgencyID	integer	None.
AgencyTIN	string	None.
AgencyName	string	None.
UserID	integer	None.
CompanyID	integer	None.
Username	string	None.
BookDate	string	None.
TotalAdults	integer	None.
TotalChilds	integer	None.
TotalInfant	integer	None.
Status	eBookStatus	None.
StartDate	string	None.
EndDate	string	None.
Nights	integer	None.
InternalComments	string	None.
ExternalComments	string	None.
ClientPaymentStatus	ePaymentStatus	None.
SupplierPaymentStatus	ePaymentStatus	None.
ExternalRef	string	None.
FileOptigest	string	None.
Services	Collection of BookDetail	None.
Pax	Collection of BookPax	None.
Payments	Collection of BookPayment	None.
Emails	Collection of BookEmail	None.
Questions	Collection of BookQuestion	None.
HasError	boolean	None.
ErrorDescription	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "HashCode": "sample string 2",
  "FileNumber": "sample string 3",
  "ClientID": 4,
  "AgencyID": 5,
  "AgencyTIN": "sample string 6",
  "AgencyName": "sample string 7",
  "UserID": 8,
  "CompanyID": 9,
  "Username": "sample string 10",
  "BookDate": "sample string 11",
  "TotalAdults": 12,
  "TotalChilds": 13,
  "TotalInfant": 14,
  "Status": 1,
  "StartDate": "sample string 15",
  "EndDate": "sample string 16",
  "Nights": 17,
  "InternalComments": "sample string 18",
  "ExternalComments": "sample string 19",
  "ClientPaymentStatus": 0,
  "SupplierPaymentStatus": 0,
  "ExternalRef": "sample string 20",
  "FileOptigest": "sample string 21",
  "Services": [
    {
      "ID": 1,
      "BookID": 2,
      "ProviderType": 1,
      "ProductCode": "sample string 3",
      "ProductDescription": "sample string 4",
      "ModalityCode": "sample string 5",
      "AccommodationCode": "sample string 6",
      "Quantity": 7,
      "TotalAdults": 8,
      "TotalChilds": 9,
      "TotalInfant": 10,
      "Status": 1,
      "StartDate": "sample string 11",
      "EndDate": "sample string 12",
      "Nights": 13,
      "IssuedVoucher": true,
      "Comments": "sample string 15",
      "ClientPaymentStatus": 0,
      "SupplierPaymentStatus": 0,
      "Billed": true,
      "AdultCostValue": 17.1,
      "ChildCostValue": 18.1,
      "InfantCostValue": 19.1,
      "AdultSaleValue": 20.1,
      "ChildSaleValue": 21.1,
      "InfantSaleValue": 22.1,
      "TotalAgencyCost": 23.1,
      "CancellationDate": "sample string 24",
      "CancellationValue": 25.1,
      "CancellationDates": [
        {
          "ID": 1,
          "BookID": 2,
          "ServiceID": 3,
          "CancellationDate": "sample string 4",
          "CancellationValue": 5.1,
          "HasError": true,
          "ErrorDescription": "sample string 7"
        },
        {
          "ID": 1,
          "BookID": 2,
          "ServiceID": 3,
          "CancellationDate": "sample string 4",
          "CancellationValue": 5.1,
          "HasError": true,
          "ErrorDescription": "sample string 7"
        }
      ],
      "SupplierID": "sample string 26",
      "SupplierCode": "sample string 27",
      "SupplierProvider": "sample string 28",
      "SupplierProviderID": 29,
      "VoucherNumber": 30,
      "VoucherPath": "sample string 31",
      "RoomNumber": 32,
      "ProviderReference": "sample string 33",
      "ProviderReferenceBook": "sample string 34",
      "FlightNumber": "sample string 35",
      "FlightTime": "sample string 36",
      "FlightSegments": [
        {
          "ID": 1,
          "BookID": 2,
          "cDataVoos": "sample string 3",
          "cBookingCode": "sample string 4",
          "cCabinClass": "sample string 5",
          "cNrMalas": "sample string 6",
          "cModelo": "sample string 7",
          "cTerminal": "sample string 8",
          "cTerminal1": "sample string 9",
          "cClass": "sample string 10",
          "cKey": "sample string 11",
          "cGroup": "sample string 12",
          "cCarrier": "sample string 13",
          "cFlightNumber": "sample string 14",
          "cOrigin": "sample string 15",
          "cDestination": "sample string 16",
          "cNameOrigin": "sample string 17",
          "cNameDestination": "sample string 18",
          "cDepartureTime": "sample string 19",
          "cArrivalTime": "sample string 20",
          "cFlightTime": "sample string 21",
          "cFlightTimeConv": "sample string 22",
          "cDistance": "sample string 23",
          "cETicketability": "sample string 24",
          "cEquipment": "sample string 25",
          "cChangeOfPlane": "sample string 26",
          "cAvailabilitySource": "sample string 27",
          "cAllotment": "sample string 28",
          "cIdaVolta": 29,
          "HasError": true,
          "ErrorDescription": "sample string 31"
        },
        {
          "ID": 1,
          "BookID": 2,
          "cDataVoos": "sample string 3",
          "cBookingCode": "sample string 4",
          "cCabinClass": "sample string 5",
          "cNrMalas": "sample string 6",
          "cModelo": "sample string 7",
          "cTerminal": "sample string 8",
          "cTerminal1": "sample string 9",
          "cClass": "sample string 10",
          "cKey": "sample string 11",
          "cGroup": "sample string 12",
          "cCarrier": "sample string 13",
          "cFlightNumber": "sample string 14",
          "cOrigin": "sample string 15",
          "cDestination": "sample string 16",
          "cNameOrigin": "sample string 17",
          "cNameDestination": "sample string 18",
          "cDepartureTime": "sample string 19",
          "cArrivalTime": "sample string 20",
          "cFlightTime": "sample string 21",
          "cFlightTimeConv": "sample string 22",
          "cDistance": "sample string 23",
          "cETicketability": "sample string 24",
          "cEquipment": "sample string 25",
          "cChangeOfPlane": "sample string 26",
          "cAvailabilitySource": "sample string 27",
          "cAllotment": "sample string 28",
          "cIdaVolta": 29,
          "HasError": true,
          "ErrorDescription": "sample string 31"
        }
      ],
      "HasError": true,
      "ErrorDescription": "sample string 38"
    },
    {
      "ID": 1,
      "BookID": 2,
      "ProviderType": 1,
      "ProductCode": "sample string 3",
      "ProductDescription": "sample string 4",
      "ModalityCode": "sample string 5",
      "AccommodationCode": "sample string 6",
      "Quantity": 7,
      "TotalAdults": 8,
      "TotalChilds": 9,
      "TotalInfant": 10,
      "Status": 1,
      "StartDate": "sample string 11",
      "EndDate": "sample string 12",
      "Nights": 13,
      "IssuedVoucher": true,
      "Comments": "sample string 15",
      "ClientPaymentStatus": 0,
      "SupplierPaymentStatus": 0,
      "Billed": true,
      "AdultCostValue": 17.1,
      "ChildCostValue": 18.1,
      "InfantCostValue": 19.1,
      "AdultSaleValue": 20.1,
      "ChildSaleValue": 21.1,
      "InfantSaleValue": 22.1,
      "TotalAgencyCost": 23.1,
      "CancellationDate": "sample string 24",
      "CancellationValue": 25.1,
      "CancellationDates": [
        {
          "ID": 1,
          "BookID": 2,
          "ServiceID": 3,
          "CancellationDate": "sample string 4",
          "CancellationValue": 5.1,
          "HasError": true,
          "ErrorDescription": "sample string 7"
        },
        {
          "ID": 1,
          "BookID": 2,
          "ServiceID": 3,
          "CancellationDate": "sample string 4",
          "CancellationValue": 5.1,
          "HasError": true,
          "ErrorDescription": "sample string 7"
        }
      ],
      "SupplierID": "sample string 26",
      "SupplierCode": "sample string 27",
      "SupplierProvider": "sample string 28",
      "SupplierProviderID": 29,
      "VoucherNumber": 30,
      "VoucherPath": "sample string 31",
      "RoomNumber": 32,
      "ProviderReference": "sample string 33",
      "ProviderReferenceBook": "sample string 34",
      "FlightNumber": "sample string 35",
      "FlightTime": "sample string 36",
      "FlightSegments": [
        {
          "ID": 1,
          "BookID": 2,
          "cDataVoos": "sample string 3",
          "cBookingCode": "sample string 4",
          "cCabinClass": "sample string 5",
          "cNrMalas": "sample string 6",
          "cModelo": "sample string 7",
          "cTerminal": "sample string 8",
          "cTerminal1": "sample string 9",
          "cClass": "sample string 10",
          "cKey": "sample string 11",
          "cGroup": "sample string 12",
          "cCarrier": "sample string 13",
          "cFlightNumber": "sample string 14",
          "cOrigin": "sample string 15",
          "cDestination": "sample string 16",
          "cNameOrigin": "sample string 17",
          "cNameDestination": "sample string 18",
          "cDepartureTime": "sample string 19",
          "cArrivalTime": "sample string 20",
          "cFlightTime": "sample string 21",
          "cFlightTimeConv": "sample string 22",
          "cDistance": "sample string 23",
          "cETicketability": "sample string 24",
          "cEquipment": "sample string 25",
          "cChangeOfPlane": "sample string 26",
          "cAvailabilitySource": "sample string 27",
          "cAllotment": "sample string 28",
          "cIdaVolta": 29,
          "HasError": true,
          "ErrorDescription": "sample string 31"
        },
        {
          "ID": 1,
          "BookID": 2,
          "cDataVoos": "sample string 3",
          "cBookingCode": "sample string 4",
          "cCabinClass": "sample string 5",
          "cNrMalas": "sample string 6",
          "cModelo": "sample string 7",
          "cTerminal": "sample string 8",
          "cTerminal1": "sample string 9",
          "cClass": "sample string 10",
          "cKey": "sample string 11",
          "cGroup": "sample string 12",
          "cCarrier": "sample string 13",
          "cFlightNumber": "sample string 14",
          "cOrigin": "sample string 15",
          "cDestination": "sample string 16",
          "cNameOrigin": "sample string 17",
          "cNameDestination": "sample string 18",
          "cDepartureTime": "sample string 19",
          "cArrivalTime": "sample string 20",
          "cFlightTime": "sample string 21",
          "cFlightTimeConv": "sample string 22",
          "cDistance": "sample string 23",
          "cETicketability": "sample string 24",
          "cEquipment": "sample string 25",
          "cChangeOfPlane": "sample string 26",
          "cAvailabilitySource": "sample string 27",
          "cAllotment": "sample string 28",
          "cIdaVolta": 29,
          "HasError": true,
          "ErrorDescription": "sample string 31"
        }
      ],
      "HasError": true,
      "ErrorDescription": "sample string 38"
    }
  ],
  "Pax": [
    {
      "ID": 1,
      "BookID": 2,
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Email": "sample string 6",
      "Address": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "Age": 11,
      "Type": 1,
      "Holder": true,
      "RoomNumber": 13,
      "ProductCode": "sample string 14",
      "RateKey": "sample string 15",
      "PaxIndex": 16,
      "DocumentNumber": "sample string 17",
      "DocDay": "sample string 18",
      "DocMonth": "sample string 19",
      "DocYear": "sample string 20",
      "BirthDay": "sample string 21",
      "BirthMonth": "sample string 22",
      "BirthYear": "sample string 23",
      "AppKey": "sample string 24",
      "HasError": true,
      "ErrorDescription": "sample string 26"
    },
    {
      "ID": 1,
      "BookID": 2,
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "Surname": "sample string 5",
      "Email": "sample string 6",
      "Address": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "Age": 11,
      "Type": 1,
      "Holder": true,
      "RoomNumber": 13,
      "ProductCode": "sample string 14",
      "RateKey": "sample string 15",
      "PaxIndex": 16,
      "DocumentNumber": "sample string 17",
      "DocDay": "sample string 18",
      "DocMonth": "sample string 19",
      "DocYear": "sample string 20",
      "BirthDay": "sample string 21",
      "BirthMonth": "sample string 22",
      "BirthYear": "sample string 23",
      "AppKey": "sample string 24",
      "HasError": true,
      "ErrorDescription": "sample string 26"
    }
  ],
  "Payments": [
    {
      "ID": 1,
      "BookID": 2,
      "PaymentMethod": 1,
      "PaymentDate": "sample string 3",
      "PaymentStatus": 0,
      "Token": "sample string 4",
      "Comments": "sample string 5",
      "HasError": true,
      "ErrorDescription": "sample string 7"
    },
    {
      "ID": 1,
      "BookID": 2,
      "PaymentMethod": 1,
      "PaymentDate": "sample string 3",
      "PaymentStatus": 0,
      "Token": "sample string 4",
      "Comments": "sample string 5",
      "HasError": true,
      "ErrorDescription": "sample string 7"
    }
  ],
  "Emails": [
    {
      "ID": 1,
      "BookID": 2,
      "Email": "sample string 3",
      "Confirmation": true,
      "HasError": true,
      "ErrorDescription": "sample string 6"
    },
    {
      "ID": 1,
      "BookID": 2,
      "Email": "sample string 3",
      "Confirmation": true,
      "HasError": true,
      "ErrorDescription": "sample string 6"
    }
  ],
  "Questions": [
    {
      "ID": 1,
      "BookID": 2,
      "Type": 1,
      "TravelType": 1,
      "Question": "sample string 3",
      "Answer": "sample string 4",
      "HasError": true,
      "ErrorDescription": "sample string 6"
    },
    {
      "ID": 1,
      "BookID": 2,
      "Type": 1,
      "TravelType": 1,
      "Question": "sample string 3",
      "Answer": "sample string 4",
      "HasError": true,
      "ErrorDescription": "sample string 6"
    }
  ],
  "HasError": true,
  "ErrorDescription": "sample string 23"
}