POST api/Reservations?apiKey={apiKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required

Body Parameters

RentalReservation
NameDescriptionTypeAdditional information
Identity

Identity

None.

ContactInfo

ContactInfo

None.

RentalIn

RentalIn

None.

RentalRateDetail

Collection of RateDetail

None.

ModifyRateDetail

Collection of RateDetail

None.

UpgradeText

string

None.

InsuranceText

string

None.

ReservationStatus

ReservationStatus

None.

Remark

string

None.

Renter

Renter

None.

TotalAmount

decimal number

None.

TotalTax

decimal number

None.

SubTotal

decimal number

None.

RentalType

RentalType

None.

CustomerFeedback

Feedback

None.

AirlinesName

string

None.

PaynowDiscount

decimal number

None.

OnlinePaymentDetail

OnlinePaymentDetail

None.

BookingSource

BookingSource

None.

BookingIncluded

Collection of BookingIncluded

None.

ModificationCharge

ModificationCharge

None.

CancellationCharge

CancellationCharge

None.

IsAllowCancellation

boolean

None.

IsAllowModification

boolean

None.

IPLocation

IPLocation

None.

Request Formats

application/json, text/json

Sample:
{
  "Identity": {
    "Id": "f401d1b9-78f8-45fa-8c7a-89be8e8d3c82",
    "Code": "sample string 2"
  },
  "ContactInfo": {
    "CustomerType": 0,
    "TitleType": 0,
    "Name": "sample string 1",
    "Address": "sample string 2",
    "Email": "sample string 3",
    "ContactNo": "sample string 4",
    "CountryState": {
      "StateCode": "sample string 2",
      "StateName": "sample string 3",
      "CountryCode": "sample string 4",
      "CountryName": "sample string 5",
      "NationalityCode": "sample string 6",
      "NationalityName": "sample string 7"
    },
    "Id": "b42379bd-020f-48f5-a37a-bb05d87d6928",
    "Code": "sample string 9"
  },
  "RentalIn": {
    "RentalDays": 1,
    "RentalType": 0,
    "VehicleModelID": "4b7e0b76-aff9-43ae-896b-1c67fdc43e8d",
    "SubscriptionMonth": 3,
    "ModelYear": 4,
    "SubscriptionKm": 5,
    "RentalTariffID": "649486c2-9b15-4112-a388-4e05aacf239c",
    "RentalTariffName": "sample string 7",
    "CheckOutOn": "2024-06-16T13:03:27.3945436+04:00",
    "CheckInOn": "2024-06-16T13:03:27.3945436+04:00",
    "CheckOutBranchID": "afd7acac-b6d7-4ec7-aeae-c536596334e9",
    "CheckInBranchID": "0b2fd568-18e1-4c49-8b5a-42551fa90ec7",
    "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": "556361c5-b0c6-45ac-aa77-f05d872f9e17",
    "RentalDiscountOffered": 14.1,
    "AdditionalDrivers": 15,
    "IsPAISelected": true,
    "IsCDWSelected": true,
    "IsSCDWSelected": true,
    "AncillaryIn": [
      {
        "AncillaryID": "51791baa-c912-403a-8c8a-49ce89e6a9b8",
        "Qty": 2,
        "AncillaryItemIDs": [
          "7000d8fe-0965-4fed-81eb-87c7c76f792c",
          "4dde1c89-ad03-4006-a60b-2f107378b51a"
        ]
      },
      {
        "AncillaryID": "51791baa-c912-403a-8c8a-49ce89e6a9b8",
        "Qty": 2,
        "AncillaryItemIDs": [
          "7000d8fe-0965-4fed-81eb-87c7c76f792c",
          "4dde1c89-ad03-4006-a60b-2f107378b51a"
        ]
      }
    ],
    "RemovedLedgerID": "deb72e82-c1c9-41c1-b12f-936a2ea01c44",
    "PromoCode": "sample string 20",
    "SpecialOfferID": "8c45a330-a5b2-4738-80b8-e21f4e951116",
    "SpecialOfferName": "sample string 22",
    "CheckOutKm": 23,
    "CheckInKm": 24,
    "CheckInFuel": 25,
    "CheckOutFuel": 26,
    "VehicleID": "97fb4e4f-fa53-4542-9145-65546cf6d629",
    "AllowedKm": 28,
    "AllowedKmPerRental": 29,
    "TransactionID": "9b34ec6e-ee1f-4903-8ebd-e5e4702cf39a",
    "TransactionType": 0,
    "RentalRate": 31.1,
    "ModelWiseChargeID": "366c46f9-4f00-419e-a324-6cf73dd23081",
    "VehicleVariantID": "1f7087b1-38a3-4ccf-a8a6-d7b8eb8fa786",
    "CancelledOn": "2024-06-16T13:03:27.3945436+04:00",
    "DayUnitID": 35,
    "PaymentStatus": 0,
    "UpgradeTariffGroupID": "21e9dbad-7601-4850-ab55-c65d35ef372f",
    "UpgradeModelID": "3b55ae1a-4a2f-46c6-acfe-56799ed7c08b",
    "UpgradeType": 0,
    "ModifiedReservationID": "a2065671-3870-4d25-b68f-f7cf2dd88ebf",
    "ContactID": "fb6b36e3-2cc5-40b3-9458-97b865856a36",
    "IsMonthlyBooking": true,
    "IPLocation": {
      "IPAddress": "sample string 2"
    }
  },
  "RentalRateDetail": [
    {
      "RentalRateDetailID": "9f2e249e-dd99-42f2-8f38-552c741d429c",
      "ItemID": "74900282-3238-4100-9562-b8c79fe7e53e",
      "Item": "sample string 3",
      "Description": "sample string 4",
      "Days": 5,
      "Qty": 6,
      "Rate": 7.1,
      "DiscRate": 8.1,
      "TaxAmt": 9.1,
      "FreeDays": 10,
      "SequenceNo": 11,
      "RateChargeType": 0,
      "RateOffered": 12.1,
      "OnlinePayDiscPer": 13.1,
      "DiscTotal": -30.0,
      "SubTotal": 243.0,
      "TotalWithOutDisc": 222.1,
      "TotalAmt": 252.1,
      "CanBeDeleted": true
    },
    {
      "RentalRateDetailID": "9f2e249e-dd99-42f2-8f38-552c741d429c",
      "ItemID": "74900282-3238-4100-9562-b8c79fe7e53e",
      "Item": "sample string 3",
      "Description": "sample string 4",
      "Days": 5,
      "Qty": 6,
      "Rate": 7.1,
      "DiscRate": 8.1,
      "TaxAmt": 9.1,
      "FreeDays": 10,
      "SequenceNo": 11,
      "RateChargeType": 0,
      "RateOffered": 12.1,
      "OnlinePayDiscPer": 13.1,
      "DiscTotal": -30.0,
      "SubTotal": 243.0,
      "TotalWithOutDisc": 222.1,
      "TotalAmt": 252.1,
      "CanBeDeleted": true
    }
  ],
  "ModifyRateDetail": [
    {
      "RentalRateDetailID": "9f2e249e-dd99-42f2-8f38-552c741d429c",
      "ItemID": "74900282-3238-4100-9562-b8c79fe7e53e",
      "Item": "sample string 3",
      "Description": "sample string 4",
      "Days": 5,
      "Qty": 6,
      "Rate": 7.1,
      "DiscRate": 8.1,
      "TaxAmt": 9.1,
      "FreeDays": 10,
      "SequenceNo": 11,
      "RateChargeType": 0,
      "RateOffered": 12.1,
      "OnlinePayDiscPer": 13.1,
      "DiscTotal": -30.0,
      "SubTotal": 243.0,
      "TotalWithOutDisc": 222.1,
      "TotalAmt": 252.1,
      "CanBeDeleted": true
    },
    {
      "RentalRateDetailID": "9f2e249e-dd99-42f2-8f38-552c741d429c",
      "ItemID": "74900282-3238-4100-9562-b8c79fe7e53e",
      "Item": "sample string 3",
      "Description": "sample string 4",
      "Days": 5,
      "Qty": 6,
      "Rate": 7.1,
      "DiscRate": 8.1,
      "TaxAmt": 9.1,
      "FreeDays": 10,
      "SequenceNo": 11,
      "RateChargeType": 0,
      "RateOffered": 12.1,
      "OnlinePayDiscPer": 13.1,
      "DiscTotal": -30.0,
      "SubTotal": 243.0,
      "TotalWithOutDisc": 222.1,
      "TotalAmt": 252.1,
      "CanBeDeleted": true
    }
  ],
  "UpgradeText": "sample string 4",
  "InsuranceText": "sample string 5",
  "ReservationStatus": 0,
  "Remark": "sample string 6",
  "Renter": {
    "Identity": {
      "Id": "f401d1b9-78f8-45fa-8c7a-89be8e8d3c82",
      "Code": "sample string 2"
    },
    "TitleType": 0,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactNo": "sample string 4",
    "EmailId": "sample string 5",
    "BirthDate": "2024-06-16T13:03:27.3945436+04:00",
    "Address": "sample string 7",
    "CountryState": {
      "StateCode": "sample string 2",
      "StateName": "sample string 3",
      "CountryCode": "sample string 4",
      "CountryName": "sample string 5",
      "NationalityCode": "sample string 6",
      "NationalityName": "sample string 7"
    },
    "DrivingLicense": {
      "LicenseNo": "sample string 1",
      "IssuedBy": "sample string 2",
      "IssuedOn": "2024-06-16T13:03:27.3945436+04:00",
      "ExpiresOn": "2024-06-16T13:03:27.3945436+04:00"
    },
    "Passport": {
      "PassportNo": "sample string 1",
      "IssuedOn": "2024-06-16T13:03:27.3945436+04:00",
      "ExpiresOn": "2024-06-16T13:03:27.3945436+04:00",
      "IssuedCountryCode": "sample string 5",
      "IssuedCountryName": "sample string 6"
    },
    "Balance": 9.0,
    "CreditCardDetail": [
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2024-06-16T13:03:27.3945436+04:00",
        "IssuedByBank": "sample string 7"
      },
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2024-06-16T13:03:27.3945436+04:00",
        "IssuedByBank": "sample string 7"
      }
    ],
    "AdditionalDocument": {
      "DocumentNo": "sample string 1",
      "IssuedBy": "sample string 2",
      "IssuedOn": "2024-06-16T13:03:27.3945436+04:00",
      "ExpiresOn": "2024-06-16T13:03:27.3945436+04:00"
    }
  },
  "TotalAmount": 9.1,
  "TotalTax": 10.1,
  "SubTotal": -1.0,
  "RentalType": 0,
  "CustomerFeedback": {
    "TransactionID": "f811447b-7ec7-43af-9e2f-25930f05d676",
    "TransactionType": 0,
    "TransactionNo": "sample string 3",
    "Rating": 6,
    "Remark": "sample string 7",
    "FeatureType": [
      1,
      2
    ]
  },
  "AirlinesName": "sample string 13",
  "PaynowDiscount": 15.1,
  "OnlinePaymentDetail": {
    "OrderRefNo": "sample string 3",
    "OnlinePayRefNo": "sample string 5",
    "OnlinePayStatus": 0,
    "PaymentMessage": "sample string 7"
  },
  "BookingSource": 0,
  "BookingIncluded": [
    {
      "BookingIncludedID": "08f9747a-032c-4064-bbf8-8c525e5c6464",
      "BookingIncludedType": 0,
      "ShortText": "sample string 2",
      "LongText": "sample string 3",
      "TempCRUD": {
        "TempId": 1,
        "IsNew": true,
        "IsDeleted": true,
        "IsUpdated": true,
        "IsActive": true
      }
    },
    {
      "BookingIncludedID": "08f9747a-032c-4064-bbf8-8c525e5c6464",
      "BookingIncludedType": 0,
      "ShortText": "sample string 2",
      "LongText": "sample string 3",
      "TempCRUD": {
        "TempId": 1,
        "IsNew": true,
        "IsDeleted": true,
        "IsUpdated": true,
        "IsActive": true
      }
    }
  ],
  "ModificationCharge": {
    "AmountPaid": 1.1,
    "AmountToRefund": 2.1,
    "AmountToPay": 3.1
  },
  "CancellationCharge": {
    "AmountCancellationCharge": 1.1,
    "AmountToRefund": 2.1,
    "AmountToPay": 3.1,
    "AmountPaid": 4.1
  },
  "IsAllowCancellation": true,
  "IsAllowModification": true,
  "IPLocation": {
    "IPAddress": "sample string 2"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReservationResult
NameDescriptionTypeAdditional information
PaymentUrl

string

None.

PaymentOrderJson

string

None.

Parameters

Collection of PaymentParam

None.

IsValid

boolean

None.

Message

string

None.

Code

string

None.

ID

globally unique identifier

None.

Errors

Collection of string

None.

ErrorCodes

Collection of ErrorCode

None.

Response Formats

application/json, text/json

Sample:
{
  "PaymentUrl": "sample string 1",
  "PaymentOrderJson": "sample string 2",
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "IsValid": true,
  "Message": "sample string 4",
  "Code": "sample string 5",
  "ID": "6e74f770-35ed-4aa6-8560-bd23420d1327",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCodes": [
    1,
    1
  ]
}

application/xml, text/xml

Sample:
<ReservationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
  <Code>sample string 5</Code>
  <ErrorCodes>
    <ErrorCode>Success</ErrorCode>
    <ErrorCode>Success</ErrorCode>
  </ErrorCodes>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <ID>6e74f770-35ed-4aa6-8560-bd23420d1327</ID>
  <IsValid>true</IsValid>
  <Message>sample string 4</Message>
  <Parameters>
    <PaymentParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </PaymentParam>
    <PaymentParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </PaymentParam>
  </Parameters>
  <PaymentOrderJson>sample string 2</PaymentOrderJson>
  <PaymentUrl>sample string 1</PaymentUrl>
</ReservationResult>