Skip to content

Car Get Cancellation Policy
Run in Postman

/api/v1/car/cancellation-policy   
This service method is used to fetch Cancellation policies of selected result. The search key and the offerId need to be snet in the get cancellation policy request.

Car Get Cancellation Policy Request

Tags Attribute Description
searchKey*
(String)
Unique Key for the car search
offerId*
(String)
Unique Key for the car result


Car Get Cancellation Policy Request
1
2
3
4
5
{
    "searchKey": "aff2cea4-60c3-405e-b7fe-b69d991a132f",
    "offerId": "aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000"

}

Car Get Cancellation Policy Response

Following table contains the attributes of the cancellation policy response and the description.

Tags Attribute Description
GetCancellationPolicyCriteria (JsonObject)
GetCancellationPolicyCriteria searchKey*
(String)
Unique Key for the car search
offerId*
(String)
Unique Key for the car result
policy policy
(List)
policyRemarks
(String)
Not released yet
noChargePolicyDetail noChargePolicyDetail
(Object)
Not released yet
noShowPolicyType
(String)
Not released yet
noShowPolicyCharge
(Double)
Not released yet
policyDetails policyDetails
(List)
Not released yet
fromDate
(String)
Not released yet
toDate
(String)
Not released yet
chargeType
(String)
Not released yet
charge
(Double)
Not released yet
chargeType
(String)
This attribute contains the details of the cancellation policy based on the supplier
description*
(String)
This attribute contains the cancellation policy description
Car Get Cancellation Policy Response
{
 "meta": {
   "success": true,
   "statusCode": "",
   "statusMessage": "",
   "additionalProperties": [
     {
       "key": "timeStamp",
       "value": "YYYY-MM-DD HH:MM:SST",
       "description": "description"
     },
     {
       "key": "serverKey",
       "value": "Server01",
       "description": "description"
     }
   ],
    "actionType": "",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
 },
 "warnings": [
   {
     "code": "validation_required",
     "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
     "message": "SearchKey  can't be blank",
     "value": "SearchKey  can't be blank"
   }
 ],
 "errors": [
   {
     "code": "validation_required",
     "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
     "message": "Field 'offerId' can't be blank",
     "value": "Field 'offerId' can't be blank",
     "source": {
       "field": "PickUpLocation",
       "pointer": "/CarCancellationPolicyCriteriaCriteria/offerId"
     },
     "title": "Required field",
     "type": "validation_error"
   }
 ],
 "commonData": {
   "searchKey": "a3d43ec7-8f6e-45de-b03e-00c6cdac3b8e"
 },
 "offerId": "aff2cea4-60c3-405e-b7fe-b69d991a132ftravelboutiqueonlinehtr00000000",
 "searchKey": "aff2cea4-60c3-405e-b7fe-b69d991a132f",
 "policy": [
   {
     "policyRemarks": "",
     "noChargePolicyDetail": "",
     "noShowPolicyDetail": {
       "noShowPolicyType": "p",
       "noShowPolicyCharge": 100
     },
     "policyDetails": [
       {
         "fromDate": "2023-01-23",
         "toDate": "2023-06-23",
         "chargeType": "p",
         "charge": 100
       }
     ],
     "description": "1. You can cancel your reservation online through the View/Modify/Cancel button or through Contact Us on our web site. </br> 2. If you made a prepaid reservation and canceled no later than midnight two days before the date of your scheduled pick-up we will refund your reservation in full. An administration charge of 30.00 GBP / 45.00 EUR (or local equivalent - see 'PREPAID ONLINE CANCELLATION AND NO SHOW CHARGES' below) will apply if the cancellation is made after this time and will be taken from the credit card you used to make your booking. </br></Description>"
   }
 ]
}