PUT api/Bookings/SaveBooking/{LinkBookings}/{PaymentOption}/{PaymentMethod}/{IsDeposit}

Allows a list of booking objects to be passed and the API will attempt to save each booking.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
LinkBookings

A flag to mark if the bookings should be linked as a single package or if they should be set as seperate bookings

 boolean

Required
PaymentOption

Marks when the booking will be paid. (ADVANCE, INVOICE, ARRIVAL)

 string

Required
PaymentMethod

Marks the payment method for the booking. (Cash, Visa, Mastercard, Cheque, etc...)

 string

Required
IsDeposit

A flag to mark if this list should be treated as deposits for booking or as full bookings.

 boolean

Required

Body Parameters

The list of bookings to be created.

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
[{"ID":0,"Customer":{"ID":0,"Email":"","UDF":"","Title":"","Firstname":"","Middlename":"","Lastname":"","DOB":"0001-01-01T00:00:00","CompanyName":"","HouseNo":"","AddressLine1":"","AddressLine2":"","AddressLine3":"","City":"","Postcode":"","County":"","Country":"","TelephoneNumber":"","EveningTelephoneNumber":"","MailingList":"","Notes":"","Password":"","Interests":null,"PersonImage":"","DDAcountHolder":"","DDAccountNumber":"","DDSortCode":"","DDBankName":"","DDBankAddress":"","DDBankPostCode":"","MemberNumber":"","AccountRef":"","ConsentMail":false,"ConsentPhone":false,"ConsentSMS":false,"ConsentEmail":false,"Username":"","ForcePasswordChange":false,"CustomerRef":""},"Products":[{"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null}],"PendingProducts":[],"Resource":{"ID":0,"Name":"","Date":"0001-01-01T00:00:00","StartTime":"","EndTime":"","AvailableFrom":"0001-01-01T00:00:00","AvailableTo":"0001-01-01T00:00:00","ResourceType":"","Adults":0,"Children":0,"Capacity":0,"TotalBooked":0,"ProductMapID":0,"AvailableDays":"","Notes":"","UpSellInfo":"","ProductList":[],"ResourceUDFs":null,"QuestionnaireID":0},"VisitDate":"0001-01-01T00:00:00","Source":"","Category":"","Status":"","Notes":"","GiftAid":false,"Adults":0,"Children":0,"LeaderName":"","LeaderTeleNo":"","BookedBy":"","ReservationReference":"","BookingUDFs":[{"UDFName":"","UDFValue":""}]}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<Bookings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIBooking>
    <ID>0</ID>
    <Customer>
      <ID>0</ID>
      <Email />
      <UDF />
      <Title />
      <Firstname />
      <Middlename />
      <Lastname />
      <DOB>0001-01-01T00:00:00</DOB>
      <CompanyName />
      <HouseNo />
      <AddressLine1 />
      <AddressLine2 />
      <AddressLine3 />
      <City />
      <Postcode />
      <County />
      <Country />
      <TelephoneNumber />
      <EveningTelephoneNumber />
      <MailingList />
      <Notes />
      <Password />
      <PersonImage />
      <DDAcountHolder />
      <DDAccountNumber />
      <DDSortCode />
      <DDBankName />
      <DDBankAddress />
      <DDBankPostCode />
      <MemberNumber />
      <AccountRef />
      <ConsentMail>false</ConsentMail>
      <ConsentPhone>false</ConsentPhone>
      <ConsentSMS>false</ConsentSMS>
      <ConsentEmail>false</ConsentEmail>
      <Username />
      <ForcePasswordChange>false</ForcePasswordChange>
      <CustomerRef />
    </Customer>
    <Products>
      <APIProduct>
        <PLU />
        <ProductDescription />
        <TicketDescription />
        <GiftAidProduct>false</GiftAidProduct>
        <GiftAidPortion>0</GiftAidPortion>
        <Adults>0</Adults>
        <Children>0</Children>
        <CategoryCode>0</CategoryCode>
        <CategoryName />
        <SubCategory />
        <Department />
        <PriceDescription />
        <Price>0</Price>
        <OnHand>0</OnHand>
        <ProductImage />
        <Notes />
        <IsKit>false</IsKit>
        <LowestKitItemPLU />
        <Quantity>0</Quantity>
        <SeatReservationID>0</SeatReservationID>
        <GiftVoucherReference />
        <Donation>false</Donation>
      </APIProduct>
    </Products>
    <PendingProducts />
    <Resource>
      <ID>0</ID>
      <Name />
      <Date>0001-01-01T00:00:00</Date>
      <StartTime />
      <EndTime />
      <AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
      <AvailableTo>0001-01-01T00:00:00</AvailableTo>
      <ResourceType />
      <Adults>0</Adults>
      <Children>0</Children>
      <Capacity>0</Capacity>
      <TotalBooked>0</TotalBooked>
      <ProductMapID>0</ProductMapID>
      <AvailableDays />
      <Notes />
      <UpSellInfo />
      <ProductList />
      <QuestionnaireID>0</QuestionnaireID>
    </Resource>
    <VisitDate>0001-01-01T00:00:00</VisitDate>
    <Source />
    <Category />
    <Status />
    <Notes />
    <GiftAid>false</GiftAid>
    <Adults>0</Adults>
    <Children>0</Children>
    <LeaderName />
    <LeaderTeleNo />
    <BookedBy />
    <ReservationReference />
    <BookingUDFs>
      <APIBookingUDF>
        <UDFName />
        <UDFValue />
      </APIBookingUDF>
    </BookingUDFs>
  </APIBooking>
</Bookings>

Response Information

Resource Description

Returns a list of booking responses for each booking passed, with details of the save status and ID's of the bookings.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
[{"SaveStatus":"","BookingID":0,"BookingLeader":"","ResourceName":"","BookingVisitDate":"0001-01-01T00:00:00","GiftCards":null,"ETickets":null,"GiftVouchers":null}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<BookingResponses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIBookingResponse>
    <SaveStatus />
    <BookingID>0</BookingID>
    <BookingLeader />
    <ResourceName />
    <BookingVisitDate>0001-01-01T00:00:00</BookingVisitDate>
  </APIBookingResponse>
</BookingResponses>