GET api/Reservations/GetByID?apiKey={apiKey}&reservationId={reservationId}

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKey		string	Required
reservationId		globally unique identifier	Required
Body Parameters

None.
Response Information

Resource Description

RentalReservationDetail
Name	Type	Additional information
VehicleModel	VehicleModel	None.
InDetail	InOutDetail	None.
OutDetail	InOutDetail	None.
Driver	Renter	None.
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.
Response Formats

application/json, text/json

Sample:
{
  "VehicleModel": {
    "VehicleModelID": "a782a2a6-e9c3-4802-ba3b-73fca2f2bd8d",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Description": "sample string 4",
    "TariffGroup": {
      "TariffGroupID": "964f6262-4e9a-4cf5-ace1-68bb9f6b9cf1",
      "Name": "sample string 2",
      "IsOnFreeSale": true
    },
    "VehicleClassification": {
      "VehicleClassificationID": "43581d99-6da7-43f3-82cb-deb555f07970",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SequenceNo": 4,
      "Attachment": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      },
      "Icon": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      },
      "ShortDetails": "sample string 5"
    },
    "Passengers": "sample string 8",
    "Luggages": "sample string 9",
    "Doors": "sample string 10",
    "AutoTransmission": true,
    "Airbag": true,
    "ABS": true,
    "AC": true,
    "CruseControl": true,
    "Engine": "sample string 17",
    "VehicleMake": {
      "VehicleMakeID": "8823a338-ffc7-43d9-a440-c7b0f9235d6f",
      "Name": "sample string 2"
    },
    "Features": [
      {
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "IsSoldOut": true,
    "IsCallToBook": true,
    "IsBestSeller": true,
    "VehicleImages": {
      "FrontImageAttachment": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      },
      "BackImageAttachment": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      },
      "LeftImageAttachment": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      },
      "RightImageAttachment": {
        "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
        "ImageString": "sample string 6",
        "AttachmentDataBase64": "sample string 7"
      }
    },
    "SuggestedUpgradeModelIDs": [
      "e3de6312-4d3c-46c5-b680-f659af30251f",
      "02a94eab-addb-4308-afed-6a3a133f17dd"
    ],
    "FavouriteNote": "sample string 26",
    "IsRestrictBooking": true,
    "PaymentMode": 0,
    "ModelYear": "sample string 28"
  },
  "InDetail": {
    "Timestamp": "2023-12-08T20:08:53.9504829+04:00",
    "BranchID": "005caa4f-7492-4dc2-9876-b5ed347d9734",
    "Name": "sample string 5",
    "BranchDescription": "sample string 6",
    "BranchMessage": "sample string 7",
    "Address": "sample string 8",
    "StateName": "sample string 9",
    "DeliveryPickupAddress": "sample string 10",
    "DeliveryPickupStateName": "sample string 11",
    "ContactNo": "sample string 12",
    "Email": "sample string 13",
    "Attachment": {
      "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    }
  },
  "OutDetail": {
    "Timestamp": "2023-12-08T20:08:53.9504829+04:00",
    "BranchID": "005caa4f-7492-4dc2-9876-b5ed347d9734",
    "Name": "sample string 5",
    "BranchDescription": "sample string 6",
    "BranchMessage": "sample string 7",
    "Address": "sample string 8",
    "StateName": "sample string 9",
    "DeliveryPickupAddress": "sample string 10",
    "DeliveryPickupStateName": "sample string 11",
    "ContactNo": "sample string 12",
    "Email": "sample string 13",
    "Attachment": {
      "AttachmentID": "7ea2ba3c-8382-4654-88a9-3148dd23b540",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    }
  },
  "Driver": {
    "Identity": {
      "Id": "7d01a861-5c50-4320-9b9d-7c0e46ec51cd",
      "Code": "sample string 2"
    },
    "TitleType": 0,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactNo": "sample string 4",
    "EmailId": "sample string 5",
    "BirthDate": "2023-12-08T20:08:53.9504829+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": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00"
    },
    "Passport": {
      "PassportNo": "sample string 1",
      "IssuedOn": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00",
      "IssuedCountryCode": "sample string 5",
      "IssuedCountryName": "sample string 6"
    },
    "Balance": 9.0,
    "CreditCardDetail": [
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2023-12-08T20:08:53.9661133+04:00",
        "IssuedByBank": "sample string 7"
      },
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2023-12-08T20:08:53.9661133+04:00",
        "IssuedByBank": "sample string 7"
      }
    ],
    "AdditionalDocument": {
      "DocumentNo": "sample string 1",
      "IssuedBy": "sample string 2",
      "IssuedOn": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00"
    }
  },
  "Identity": {
    "Id": "7d01a861-5c50-4320-9b9d-7c0e46ec51cd",
    "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": "65331af4-8b94-4a1b-96c0-c8629a64854e",
    "Code": "sample string 9"
  },
  "RentalIn": {
    "RentalDays": 1,
    "RentalType": 0,
    "VehicleModelID": "e5219ca3-6bf1-4aff-a84e-ef39f3e5c83b",
    "SubscriptionMonth": 3,
    "ModelYear": 4,
    "SubscriptionKm": 5,
    "RentalTariffID": "38a47c87-202d-4a06-a4ef-29c0469f3ae8",
    "RentalTariffName": "sample string 7",
    "CheckOutOn": "2023-12-08T20:08:53.9661133+04:00",
    "CheckInOn": "2023-12-08T20:08:53.9661133+04:00",
    "CheckOutBranchID": "dd433765-c75c-445d-8573-3ecbc8ff6995",
    "CheckInBranchID": "c8f2ed75-68b2-4d30-b112-163caa298861",
    "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": "685fc481-4ea9-4fd5-8654-3cd4a4d29517",
    "RentalDiscountOffered": 14.1,
    "AdditionalDrivers": 15,
    "IsPAISelected": true,
    "IsCDWSelected": true,
    "IsSCDWSelected": true,
    "AncillaryIn": [
      {
        "AncillaryID": "e8920d92-9b7b-4454-9d34-109339f9e392",
        "Qty": 2,
        "AncillaryItemIDs": [
          "16d5522b-f1aa-44ca-a3cb-0b0b6ae4ae07",
          "8f5b6b2c-145f-44a5-b62a-6567259ab7c9"
        ]
      },
      {
        "AncillaryID": "e8920d92-9b7b-4454-9d34-109339f9e392",
        "Qty": 2,
        "AncillaryItemIDs": [
          "16d5522b-f1aa-44ca-a3cb-0b0b6ae4ae07",
          "8f5b6b2c-145f-44a5-b62a-6567259ab7c9"
        ]
      }
    ],
    "RemovedLedgerID": "1fa98eb7-1cfe-45df-be36-e5e92ef89886",
    "PromoCode": "sample string 20",
    "SpecialOfferID": "b39b4fec-974d-478a-8495-bcf45d52cb35",
    "SpecialOfferName": "sample string 22",
    "CheckOutKm": 23,
    "CheckInKm": 24,
    "CheckInFuel": 25,
    "CheckOutFuel": 26,
    "VehicleID": "2fa398f2-7cf6-4238-ad5b-7c21c4a9809c",
    "AllowedKm": 28,
    "AllowedKmPerRental": 29,
    "TransactionID": "395cf176-5ded-4ebc-82b7-bc45a6720df5",
    "TransactionType": 0,
    "RentalRate": 31.1,
    "ModelWiseChargeID": "78f37825-8355-4851-af94-e10f24adf063",
    "VehicleVariantID": "5ca8c225-64e1-42d4-a674-20ae4dfa02cc",
    "CancelledOn": "2023-12-08T20:08:53.9661133+04:00",
    "DayUnitID": 35,
    "PaymentStatus": 0,
    "UpgradeTariffGroupID": "932fb8ab-075d-4386-9b77-72979e7dfd88",
    "UpgradeModelID": "01cdedd4-7aa8-4cd0-acbf-bb6db9275ff7",
    "UpgradeType": 0,
    "ModifiedReservationID": "5cc83cf5-2e98-4c50-abb2-b4c5b814ff0d",
    "ContactID": "f2c6bcf8-4bb7-4d40-a604-e37840a38e47",
    "IsMonthlyBooking": true,
    "IPLocation": {
      "IPAddress": "sample string 2"
    }
  },
  "RentalRateDetail": [
    {
      "RentalRateDetailID": "4d7cab1c-8581-4606-800d-054fdbb1974d",
      "ItemID": "6aa33d45-963a-40ac-8813-3c8bde774b5e",
      "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": "4d7cab1c-8581-4606-800d-054fdbb1974d",
      "ItemID": "6aa33d45-963a-40ac-8813-3c8bde774b5e",
      "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": "4d7cab1c-8581-4606-800d-054fdbb1974d",
      "ItemID": "6aa33d45-963a-40ac-8813-3c8bde774b5e",
      "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": "4d7cab1c-8581-4606-800d-054fdbb1974d",
      "ItemID": "6aa33d45-963a-40ac-8813-3c8bde774b5e",
      "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 7",
  "InsuranceText": "sample string 8",
  "ReservationStatus": 0,
  "Remark": "sample string 9",
  "Renter": {
    "Identity": {
      "Id": "7d01a861-5c50-4320-9b9d-7c0e46ec51cd",
      "Code": "sample string 2"
    },
    "TitleType": 0,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactNo": "sample string 4",
    "EmailId": "sample string 5",
    "BirthDate": "2023-12-08T20:08:53.9504829+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": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00"
    },
    "Passport": {
      "PassportNo": "sample string 1",
      "IssuedOn": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00",
      "IssuedCountryCode": "sample string 5",
      "IssuedCountryName": "sample string 6"
    },
    "Balance": 9.0,
    "CreditCardDetail": [
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2023-12-08T20:08:53.9661133+04:00",
        "IssuedByBank": "sample string 7"
      },
      {
        "CreditCardType": "sample string 3",
        "CreditCardNo": "sample string 4",
        "ExpiryOn": "2023-12-08T20:08:53.9661133+04:00",
        "IssuedByBank": "sample string 7"
      }
    ],
    "AdditionalDocument": {
      "DocumentNo": "sample string 1",
      "IssuedBy": "sample string 2",
      "IssuedOn": "2023-12-08T20:08:53.9661133+04:00",
      "ExpiresOn": "2023-12-08T20:08:53.9661133+04:00"
    }
  },
  "TotalAmount": 12.1,
  "TotalTax": 13.1,
  "SubTotal": -1.0,
  "RentalType": 0,
  "CustomerFeedback": {
    "TransactionID": "29258512-e612-472f-a1d0-9be963a1763e",
    "TransactionType": 0,
    "TransactionNo": "sample string 3",
    "Rating": 6,
    "Remark": "sample string 7",
    "FeatureType": [
      1,
      2
    ]
  },
  "AirlinesName": "sample string 16",
  "PaynowDiscount": 18.1,
  "OnlinePaymentDetail": {
    "OrderRefNo": "sample string 3",
    "OnlinePayRefNo": "sample string 5",
    "OnlinePayStatus": 0,
    "PaymentMessage": "sample string 7"
  },
  "BookingSource": 0,
  "BookingIncluded": [
    {
      "BookingIncludedID": "bc2f349f-c5f4-4ef5-b845-24d0caaa31f3",
      "BookingIncludedType": 0,
      "ShortText": "sample string 2",
      "LongText": "sample string 3",
      "TempCRUD": {
        "TempId": 1,
        "IsNew": true,
        "IsDeleted": true,
        "IsUpdated": true,
        "IsActive": true
      }
    },
    {
      "BookingIncludedID": "bc2f349f-c5f4-4ef5-b845-24d0caaa31f3",
      "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"
  }
}
Api Documentation

GET api/Reservations/GetByID?apiKey={apiKey}&reservationId={reservationId}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json
