GET
/
Resource Details
|
Security |
|---|
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| vin | string | The full 17-character Vehicle Identification Number. | Yes |
| page | integer | A non-zero integer representing the page of the results | No |
| pageSize | integer | A non-negative, non-zero integer indicating the maximum number of results to return at one time | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Content-Type | string | n/a | No |
| Content-Type | string | n/a | No |
| Accept | string | Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header. | No |
| Accept-Charset | string | Indicates which character sets the requesting client is is capable of understanding. | No |
| Accept-Language | string | Indicates which local language representations of resources client is capable of understanding. | No |
| If-Match | string | Specifies a conditional request to only return the resource when it does match one of the included ETag values. | No |
| If-None-Match | string | Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | No |
| Prefer | string | n/a | No |
| Request-Id | string | Specifies the unique identifier of the originating request. | No |
| Subscription-Id | string | The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. | Yes |
| Authorization | string | Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. | Yes |
Request Body Structure
Request Body Example
Response
Response Body Structure
Response Body Example
Response Error Details
| HTTP Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Server Error |
| 503 | Server Down |
Try It Out
-
vin
(required)(string) The full 17-character Vehicle Identification Number.
-
page
(integer) A non-zero integer representing the page of the results
-
pageSize
(integer) A non-negative, non-zero integer indicating the maximum number of results to return at one time
-
Content-Type
(string)
-
Content-Type
(string)
-
Accept
(string) Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.
-
Accept-Charset
(string) Indicates which character sets the requesting client is is capable of understanding.
-
Accept-Language
(string) Indicates which local language representations of resources client is capable of understanding.
-
If-Match
(string) Specifies a conditional request to only return the resource when it does match one of the included ETag values.
-
If-None-Match
(string) Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values.
-
Prefer
(string)
-
Request-Id
(string) Specifies the unique identifier of the originating request.
-
Subscription-Id
(required)(string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.
-
Authorization
(required)(string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.
Working...