| GET | /api/v1/force | Returns a the list of force endpoints |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutoRental | query | AutoRental | No | The auto rental parameters to be passed in for an auto rental transaction. more» |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | No | Customer Name. |
| AgreementNumber | form | string | No | Agreement number. |
| VehicleClassCode | form | AutoRentalVehicleClassCode? | No | Classification of rental vehicleAllowable Values
|
| NoShowIndicator | form | AutoRentalNoShowIndicator? | No | No show indicator. Indicates whether rental vehicle was reserved, but not actually rented.Allowable Values
|
| AdjustmentData | form | AutoRentalAdjustmentData | No | Data related to any auto rental adjustments. |
| PickupData | form | AutoRentalPickupData | No | Data related to autorental pickup. |
| ReturnData | form | AutoRentalReturnData | No | Data related to autorental return. |
| DailyRentalRate | form | decimal | No | Rate charged per day Visa/MC – Daily rate required for Corp T&E rate III. |
| WeeklyRentalRate | form | decimal | No | Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate III. |
| InsuranceCharges | form | decimal | No | If insurance is charged, the insurance amount should be provided. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Duration | form | int | No | The number of rental days. Value should be between 0 and 99. Set to 01 for no show rentals. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | decimal | No | Adjustment amount. |
| Code | form | AutoRentalAuditAdjustmentCode? | No | Indicates if adjustment for mileage, fuel, vehicle damage, etc. was made to a rental agreement.Allowable Values
|
| ExtraChargesDetail | form | AutoRentalExtraChargesDetail[] | No | Pass in up to 6 values that describe the extra charges. For an empty or invalid value, this parameter defaults to NoExtraCharge.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | Auto rental pickup city. |
| CountryCode | form | string | No | Country code where vehicle was picked up. For US, use 840. |
| Date | form | string | No | return date in yyyy-MM-ddTHH:mm:ss format. |
| Location | form | string | No | Name of business where vehicle was picked up. |
| State | form | string | No | Abbreviation of state, province, or other country subdivision where vehicle was picked up. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | Auto rental return city. |
| CountryCode | form | string | No | Country code where vehicle was returned. For US, use 840. |
| Date | form | string | No | return date in yyyy-MM-ddTHH:mm:ss format. |
| LocationId | form | string | No | Auto Rental location ID where vehicle was returned. |
| State | form | string | No | Auto rental return state. |
| Distance | form | int | No | Numeric distance traveled during rental period. |
| DistanceUnit | form | AutoRentalDistanceUnit? | No | Unit of measurement applicable to distance traveled.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ForceRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"autoRental":{"CustomerName":"String","AgreementNumber":"String","VehicleClassCode":"Unused","NoShowIndicator":"NotApplicable","AdjustmentData":{"Amount":0,"Code":"NoAdjustments","ExtraChargesDetail":["NoExtraCharge"]},"PickupData":{"City":"String","CountryCode":"String","Date":"String","Location":"String","State":"String"},"ReturnData":{"City":"String","CountryCode":"String","Date":"String","LocationId":"String","State":"String","Distance":0,"DistanceUnit":"Unused"},"DailyRentalRate":0,"WeeklyRentalRate":0,"InsuranceCharges":0,"Duration":0}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/force/credit","method":"POST","rel":"forceCredit"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}