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

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKey		string	Required
lng		string	Default value is en

Body Parameters

RentalIn

Name	Type	Additional 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": "49669252-9604-445c-b71f-05ba0047b809",
  "SubscriptionMonth": 3,
  "ModelYear": 4,
  "SubscriptionKm": 5,
  "RentalTariffID": "a085417a-ceb6-4ff0-bac3-6a34d976490f",
  "RentalTariffName": "sample string 7",
  "CheckOutOn": "2023-12-10T13:39:20.1939015+04:00",
  "CheckInOn": "2023-12-10T13:39:20.1939015+04:00",
  "CheckOutBranchID": "d7495f15-9069-4126-ad73-4c04e9cd243b",
  "CheckInBranchID": "0750be5c-aa65-440e-aa44-f9413e19f4c2",
  "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": "9e059a5d-3964-4727-a7e4-d94009fad269",
  "RentalDiscountOffered": 14.1,
  "AdditionalDrivers": 15,
  "IsPAISelected": true,
  "IsCDWSelected": true,
  "IsSCDWSelected": true,
  "AncillaryIn": [
    {
      "AncillaryID": "63b91f18-3000-4699-bd69-f21427420b78",
      "Qty": 2,
      "AncillaryItemIDs": [
        "cde18f64-f712-4a15-b0e6-1ebba1acb5a0",
        "6a608a54-7b48-4625-a74a-baeebea5ebb6"
      ]
    },
    {
      "AncillaryID": "63b91f18-3000-4699-bd69-f21427420b78",
      "Qty": 2,
      "AncillaryItemIDs": [
        "cde18f64-f712-4a15-b0e6-1ebba1acb5a0",
        "6a608a54-7b48-4625-a74a-baeebea5ebb6"
      ]
    }
  ],
  "RemovedLedgerID": "cab258d3-58bf-4b55-8f2d-e8997b2a706b",
  "PromoCode": "sample string 20",
  "SpecialOfferID": "86fdf685-9094-4b10-bfec-56c213b52098",
  "SpecialOfferName": "sample string 22",
  "CheckOutKm": 23,
  "CheckInKm": 24,
  "CheckInFuel": 25,
  "CheckOutFuel": 26,
  "VehicleID": "8c14c564-8c00-457c-9923-8ae9c0c96792",
  "AllowedKm": 28,
  "AllowedKmPerRental": 29,
  "TransactionID": "28ab9e5c-edc6-4f2f-b950-4c6262ddac62",
  "TransactionType": 0,
  "RentalRate": 31.1,
  "ModelWiseChargeID": "785e3d05-e8c9-41a1-8c82-fe3dcbfa3061",
  "VehicleVariantID": "659f6166-7d13-4ba4-a6f8-af7c6b85bcb2",
  "CancelledOn": "2023-12-10T13:39:20.1939015+04:00",
  "DayUnitID": 35,
  "PaymentStatus": 0,
  "UpgradeTariffGroupID": "539c19dd-cdf7-4876-8540-561e2783d6ff",
  "UpgradeModelID": "a1bbf308-3af3-4f66-a910-aa31b5225f31",
  "UpgradeType": 0,
  "ModifiedReservationID": "023b6fae-f674-4737-a2e8-a830f9324190",
  "ContactID": "ffef8aad-abd1-4db2-9ab0-505989ba5112",
  "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>63b91f18-3000-4699-bd69-f21427420b78</AncillaryID>
      <AncillaryItemIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>cde18f64-f712-4a15-b0e6-1ebba1acb5a0</d4p1:guid>
        <d4p1:guid>6a608a54-7b48-4625-a74a-baeebea5ebb6</d4p1:guid>
      </AncillaryItemIDs>
      <Qty>2</Qty>
    </AncillaryIn>
    <AncillaryIn>
      <AncillaryID>63b91f18-3000-4699-bd69-f21427420b78</AncillaryID>
      <AncillaryItemIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>cde18f64-f712-4a15-b0e6-1ebba1acb5a0</d4p1:guid>
        <d4p1:guid>6a608a54-7b48-4625-a74a-baeebea5ebb6</d4p1:guid>
      </AncillaryItemIDs>
      <Qty>2</Qty>
    </AncillaryIn>
  </AncillaryIn>
  <CancelledOn>2023-12-10T13:39:20.1939015+04:00</CancelledOn>
  <CheckInBranchID>0750be5c-aa65-440e-aa44-f9413e19f4c2</CheckInBranchID>
  <CheckInFuel>25</CheckInFuel>
  <CheckInKm>24</CheckInKm>
  <CheckInOn>2023-12-10T13:39:20.1939015+04:00</CheckInOn>
  <CheckOutBranchID>d7495f15-9069-4126-ad73-4c04e9cd243b</CheckOutBranchID>
  <CheckOutFuel>26</CheckOutFuel>
  <CheckOutKm>23</CheckOutKm>
  <CheckOutOn>2023-12-10T13:39:20.1939015+04:00</CheckOutOn>
  <ContactID>ffef8aad-abd1-4db2-9ab0-505989ba5112</ContactID>
  <DayUnitID>35</DayUnitID>
  <DebtorID>9e059a5d-3964-4727-a7e4-d94009fad269</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>785e3d05-e8c9-41a1-8c82-fe3dcbfa3061</ModelWiseChargeID>
  <ModelYear>4</ModelYear>
  <ModifiedReservationID>023b6fae-f674-4737-a2e8-a830f9324190</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>cab258d3-58bf-4b55-8f2d-e8997b2a706b</RemovedLedgerID>
  <RentalDays>1</RentalDays>
  <RentalDiscountOffered>14.1</RentalDiscountOffered>
  <RentalRate>31.1</RentalRate>
  <RentalTariffID>a085417a-ceb6-4ff0-bac3-6a34d976490f</RentalTariffID>
  <RentalTariffName>sample string 7</RentalTariffName>
  <RentalType>Daily</RentalType>
  <SpecialOfferID>86fdf685-9094-4b10-bfec-56c213b52098</SpecialOfferID>
  <SpecialOfferName>sample string 22</SpecialOfferName>
  <SubscriptionKm>5</SubscriptionKm>
  <SubscriptionMonth>3</SubscriptionMonth>
  <TransactionID>28ab9e5c-edc6-4f2f-b950-4c6262ddac62</TransactionID>
  <TransactionType>None</TransactionType>
  <UpgradeModelID>a1bbf308-3af3-4f66-a910-aa31b5225f31</UpgradeModelID>
  <UpgradeTariffGroupID>539c19dd-cdf7-4876-8540-561e2783d6ff</UpgradeTariffGroupID>
  <UpgradeType>None</UpgradeType>
  <VehicleID>8c14c564-8c00-457c-9923-8ae9c0c96792</VehicleID>
  <VehicleModelID>49669252-9604-445c-b71f-05ba0047b809</VehicleModelID>
  <VehicleVariantID>659f6166-7d13-4ba4-a6f8-af7c6b85bcb2</VehicleVariantID>
</RentalIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AncillaryTariff

Name	Type	Additional information
AncillaryTariffID	globally unique identifier	None.
Name	string	None.
IsCompulsoryOnRental	boolean	None.
Description	string	None.
Attachment	Attachment	None.
SelectionType	SelectionType	None.
Rate	decimal number	None.
RateType	RateType	None.
FreeDays	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AncillaryTariffID": "ad1514af-f641-44bd-bbfb-b69bf5b9bb4a",
    "Name": "sample string 2",
    "IsCompulsoryOnRental": true,
    "Description": "sample string 7",
    "Attachment": {
      "AttachmentID": "341c71d6-f46d-4546-9910-fdfbe546a049",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    },
    "SelectionType": 0,
    "Rate": 9.1,
    "RateType": 0,
    "FreeDays": 11
  },
  {
    "AncillaryTariffID": "ad1514af-f641-44bd-bbfb-b69bf5b9bb4a",
    "Name": "sample string 2",
    "IsCompulsoryOnRental": true,
    "Description": "sample string 7",
    "Attachment": {
      "AttachmentID": "341c71d6-f46d-4546-9910-fdfbe546a049",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    },
    "SelectionType": 0,
    "Rate": 9.1,
    "RateType": 0,
    "FreeDays": 11
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

Api Documentation

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

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml

text/xml