POST api/AddOn/GetBookingIncluded?apiKey={apiKey}&lng={lng}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required
lng

string

Default value is en

Body Parameters

RentalIn
NameDescriptionTypeAdditional information
RentalDays

integer

None.
RentalType

RentalType

None.
VehicleModelID

globally unique identifier

None.
SubscriptionMonth

integer

None.
ModelYear

integer

None.
SubscriptionKm

integer

None.
RentalTariffID

globally unique identifier

None.
RentalTariffName

string

None.
CheckOutOn

date

None.
CheckInOn

date

None.
CheckOutBranchID

globally unique identifier

None.
CheckInBranchID

globally unique identifier

None.
DeliveryDetails

DeliveryPickupDetail

None.
PickupDetails

DeliveryPickupDetail

None.
DebtorID

globally unique identifier

None.
RentalDiscountOffered

decimal number

None.
AdditionalDrivers

integer

None.
IsPAISelected

boolean

None.
IsCDWSelected

boolean

None.
IsSCDWSelected

boolean

None.
AncillaryIn

Collection of AncillaryIn

None.
RemovedLedgerID

globally unique identifier

None.
PromoCode

string

None.
SpecialOfferID

globally unique identifier

None.
SpecialOfferName

string

None.
CheckOutKm

integer

None.
CheckInKm

integer

None.
CheckInFuel

integer

None.
CheckOutFuel

integer

None.
VehicleID

globally unique identifier

None.
AllowedKm

integer

None.
AllowedKmPerRental

integer

None.
TransactionID

globally unique identifier

None.
TransactionType

TransactionType

None.
RentalRate

decimal number

None.
ModelWiseChargeID

globally unique identifier

None.
VehicleVariantID

globally unique identifier

None.
CancelledOn

date

None.
DayUnitID

integer

None.
PaymentStatus

PaymentStatus

None.
UpgradeTariffGroupID

globally unique identifier

None.
UpgradeModelID

globally unique identifier

None.
UpgradeType

UpgradeType

None.
ModifiedReservationID

globally unique identifier

None.
ContactID

globally unique identifier

None.
IsMonthlyBooking

boolean

None.
IPLocation

IPLocation

None.

Request Formats

application/json, text/json

Sample: 
{
  "RentalDays": 1,
  "RentalType": 0,
  "VehicleModelID": "d4e9e9cc-c2e0-4dce-9279-7ce49a073a2a",
  "SubscriptionMonth": 3,
  "ModelYear": 4,
  "SubscriptionKm": 5,
  "RentalTariffID": "1cf29a69-4255-4d3e-8854-62c812c1245d",
  "RentalTariffName": "sample string 7",
  "CheckOutOn": "2023-12-08T20:38:42.7580271+04:00",
  "CheckInOn": "2023-12-08T20:38:42.7580271+04:00",
  "CheckOutBranchID": "07349020-c44e-4ed2-ab44-4ccde14467de",
  "CheckInBranchID": "8e3d20d5-44f4-4d6f-b826-6381b33c2cef",
  "DeliveryDetails": {
    "Address": "sample string 4",
    "AddressJson": "sample string 5",
    "StateName": "sample string 8"
  },
  "PickupDetails": {
    "Address": "sample string 4",
    "AddressJson": "sample string 5",
    "StateName": "sample string 8"
  },
  "DebtorID": "1cb5fb43-b058-4951-948c-eb66429f805f",
  "RentalDiscountOffered": 14.1,
  "AdditionalDrivers": 15,
  "IsPAISelected": true,
  "IsCDWSelected": true,
  "IsSCDWSelected": true,
  "AncillaryIn": [
    {
      "AncillaryID": "e906b7d3-5422-4a2b-a0fb-ca91d798a384",
      "Qty": 2,
      "AncillaryItemIDs": [
        "f5c5721f-9aa3-41b1-8101-5d623cfa4cba",
        "f4b2f328-b475-47d4-9b92-4856109a19de"
      ]
    },
    {
      "AncillaryID": "e906b7d3-5422-4a2b-a0fb-ca91d798a384",
      "Qty": 2,
      "AncillaryItemIDs": [
        "f5c5721f-9aa3-41b1-8101-5d623cfa4cba",
        "f4b2f328-b475-47d4-9b92-4856109a19de"
      ]
    }
  ],
  "RemovedLedgerID": "3336ad7c-a124-4a9f-80c2-601548afd741",
  "PromoCode": "sample string 20",
  "SpecialOfferID": "9dfeceb1-7b26-4f63-a687-7818bc516f1a",
  "SpecialOfferName": "sample string 22",
  "CheckOutKm": 23,
  "CheckInKm": 24,
  "CheckInFuel": 25,
  "CheckOutFuel": 26,
  "VehicleID": "2d489349-8983-41a9-85bd-6397b4b76dec",
  "AllowedKm": 28,
  "AllowedKmPerRental": 29,
  "TransactionID": "b981ae52-1dc5-4fcc-9d46-2e3bb6a23674",
  "TransactionType": 0,
  "RentalRate": 31.1,
  "ModelWiseChargeID": "3504347d-287c-4dee-98e6-38471018d22d",
  "VehicleVariantID": "d2d9db66-55be-4c05-9c60-abd53349ff80",
  "CancelledOn": "2023-12-08T20:38:42.7580271+04:00",
  "DayUnitID": 35,
  "PaymentStatus": 0,
  "UpgradeTariffGroupID": "14bdc1d4-8968-4a93-aa33-8925bea5dca8",
  "UpgradeModelID": "e173b01e-a4b4-42da-a196-756892f1c2ab",
  "UpgradeType": 0,
  "ModifiedReservationID": "438aa9e1-d5a6-4042-adc5-03de3ddc9483",
  "ContactID": "d2153672-7de7-4dbe-bf16-65bb7382382e",
  "IsMonthlyBooking": true,
  "IPLocation": {
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<RentalIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Rental">
  <AdditionalDrivers>15</AdditionalDrivers>
  <AllowedKm>28</AllowedKm>
  <AllowedKmPerRental>29</AllowedKmPerRental>
  <AncillaryIn>
    <AncillaryIn>
      <AncillaryID>e906b7d3-5422-4a2b-a0fb-ca91d798a384</AncillaryID>
      <AncillaryItemIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>f5c5721f-9aa3-41b1-8101-5d623cfa4cba</d4p1:guid>
        <d4p1:guid>f4b2f328-b475-47d4-9b92-4856109a19de</d4p1:guid>
      </AncillaryItemIDs>
      <Qty>2</Qty>
    </AncillaryIn>
    <AncillaryIn>
      <AncillaryID>e906b7d3-5422-4a2b-a0fb-ca91d798a384</AncillaryID>
      <AncillaryItemIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>f5c5721f-9aa3-41b1-8101-5d623cfa4cba</d4p1:guid>
        <d4p1:guid>f4b2f328-b475-47d4-9b92-4856109a19de</d4p1:guid>
      </AncillaryItemIDs>
      <Qty>2</Qty>
    </AncillaryIn>
  </AncillaryIn>
  <CancelledOn>2023-12-08T20:38:42.7580271+04:00</CancelledOn>
  <CheckInBranchID>8e3d20d5-44f4-4d6f-b826-6381b33c2cef</CheckInBranchID>
  <CheckInFuel>25</CheckInFuel>
  <CheckInKm>24</CheckInKm>
  <CheckInOn>2023-12-08T20:38:42.7580271+04:00</CheckInOn>
  <CheckOutBranchID>07349020-c44e-4ed2-ab44-4ccde14467de</CheckOutBranchID>
  <CheckOutFuel>26</CheckOutFuel>
  <CheckOutKm>23</CheckOutKm>
  <CheckOutOn>2023-12-08T20:38:42.7580271+04:00</CheckOutOn>
  <ContactID>d2153672-7de7-4dbe-bf16-65bb7382382e</ContactID>
  <DayUnitID>35</DayUnitID>
  <DebtorID>1cb5fb43-b058-4951-948c-eb66429f805f</DebtorID>
  <DeliveryDetails>
    <Address>sample string 4</Address>
    <AddressJson>sample string 5</AddressJson>
    <StateName>sample string 8</StateName>
  </DeliveryDetails>
  <IPLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Booking">
    <d2p1:IPAddress>sample string 2</d2p1:IPAddress>
  </IPLocation>
  <IsCDWSelected>true</IsCDWSelected>
  <IsMonthlyBooking>true</IsMonthlyBooking>
  <IsPAISelected>true</IsPAISelected>
  <IsSCDWSelected>true</IsSCDWSelected>
  <ModelWiseChargeID>3504347d-287c-4dee-98e6-38471018d22d</ModelWiseChargeID>
  <ModelYear>4</ModelYear>
  <ModifiedReservationID>438aa9e1-d5a6-4042-adc5-03de3ddc9483</ModifiedReservationID>
  <PaymentStatus>PayAtCounter</PaymentStatus>
  <PickupDetails>
    <Address>sample string 4</Address>
    <AddressJson>sample string 5</AddressJson>
    <StateName>sample string 8</StateName>
  </PickupDetails>
  <PromoCode>sample string 20</PromoCode>
  <RemovedLedgerID>3336ad7c-a124-4a9f-80c2-601548afd741</RemovedLedgerID>
  <RentalDays>1</RentalDays>
  <RentalDiscountOffered>14.1</RentalDiscountOffered>
  <RentalRate>31.1</RentalRate>
  <RentalTariffID>1cf29a69-4255-4d3e-8854-62c812c1245d</RentalTariffID>
  <RentalTariffName>sample string 7</RentalTariffName>
  <RentalType>Daily</RentalType>
  <SpecialOfferID>9dfeceb1-7b26-4f63-a687-7818bc516f1a</SpecialOfferID>
  <SpecialOfferName>sample string 22</SpecialOfferName>
  <SubscriptionKm>5</SubscriptionKm>
  <SubscriptionMonth>3</SubscriptionMonth>
  <TransactionID>b981ae52-1dc5-4fcc-9d46-2e3bb6a23674</TransactionID>
  <TransactionType>None</TransactionType>
  <UpgradeModelID>e173b01e-a4b4-42da-a196-756892f1c2ab</UpgradeModelID>
  <UpgradeTariffGroupID>14bdc1d4-8968-4a93-aa33-8925bea5dca8</UpgradeTariffGroupID>
  <UpgradeType>None</UpgradeType>
  <VehicleID>2d489349-8983-41a9-85bd-6397b4b76dec</VehicleID>
  <VehicleModelID>d4e9e9cc-c2e0-4dce-9279-7ce49a073a2a</VehicleModelID>
  <VehicleVariantID>d2d9db66-55be-4c05-9c60-abd53349ff80</VehicleVariantID>
</RentalIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BookingIncluded
NameDescriptionTypeAdditional information
BookingIncludedID

globally unique identifier

None.
BookingIncludedType

BookingIncludedType

None.
ShortText

string

None.
LongText

string

None.
TempCRUD

TemporaryCRUD

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "BookingIncludedID": "286bc79c-506d-4894-88ea-963ba135bd05",
    "BookingIncludedType": 0,
    "ShortText": "sample string 2",
    "LongText": "sample string 3",
    "TempCRUD": {
      "TempId": 1,
      "IsNew": true,
      "IsDeleted": true,
      "IsUpdated": true,
      "IsActive": true
    }
  },
  {
    "BookingIncludedID": "286bc79c-506d-4894-88ea-963ba135bd05",
    "BookingIncludedType": 0,
    "ShortText": "sample string 2",
    "LongText": "sample string 3",
    "TempCRUD": {
      "TempId": 1,
      "IsNew": true,
      "IsDeleted": true,
      "IsUpdated": true,
      "IsActive": true
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBookingIncluded xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity.Setup">
  <BookingIncluded>
    <BookingIncludedID>286bc79c-506d-4894-88ea-963ba135bd05</BookingIncludedID>
    <BookingIncludedType>UnlimitedKm</BookingIncludedType>
    <LongText>sample string 3</LongText>
    <ShortText>sample string 2</ShortText>
    <TempCRUD xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
      <d3p1:IsActive>true</d3p1:IsActive>
      <d3p1:IsDeleted>true</d3p1:IsDeleted>
      <d3p1:IsNew>true</d3p1:IsNew>
      <d3p1:IsUpdated>true</d3p1:IsUpdated>
      <d3p1:TempId>1</d3p1:TempId>
    </TempCRUD>
  </BookingIncluded>
  <BookingIncluded>
    <BookingIncludedID>286bc79c-506d-4894-88ea-963ba135bd05</BookingIncludedID>
    <BookingIncludedType>UnlimitedKm</BookingIncludedType>
    <LongText>sample string 3</LongText>
    <ShortText>sample string 2</ShortText>
    <TempCRUD xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
      <d3p1:IsActive>true</d3p1:IsActive>
      <d3p1:IsDeleted>true</d3p1:IsDeleted>
      <d3p1:IsNew>true</d3p1:IsNew>
      <d3p1:IsUpdated>true</d3p1:IsUpdated>
      <d3p1:TempId>1</d3p1:TempId>
    </TempCRUD>
  </BookingIncluded>
</ArrayOfBookingIncluded>