GET
/
Resource Details
|
Security |
|---|
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| servicePackageId | string | The service package identifier | No |
| makeId | string | The vehicle make identifier | No |
| modelId | string | The vehicle model identifier | No |
| variantId | string | The vehicle variant identifier | No |
| user | string | The user who made the service package request | No |
| vehicleSectionCode | string | The vehicle section code | No |
| method | string | The method from the Service Package call (GET, POST or DELETE) | No |
| responseCode | number | The HTTPS response code from the Service Package call (201, 402, 500, etc...) | No |
| responseSuccessful | boolean | Contains True if the HTTPS response from the Service Package call was successful | No |
| dateStart | string | Contains the date to start collecting data in YYYY-MM-DD format (eg 1997-07-16) | Yes |
| dateEnd | string | Contains the date to end collecting data in YYYY-MM-DD format (eg 1997-07-16) | No |
| page | number | A non-zero integer representing the page of the results | No |
| pageSize | number | A non-negative, non-zero integer indicating the maximum number of results to return at one time | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Accept | string | n/a | Yes |
| Accept-Charset | string | n/a | Yes |
| Accept-Language | string | See RFC 7231 (example US-EN) | Yes |
| Prefer | string | n/a | Yes |
| Region | string | Provided to support data from multiple regions (Like US and CA) | No |
| Request-Id | string | n/a | Yes |
| 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 |
| 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 |
| 403 | Forbidden |
Try It Out
-
servicePackageId
(string) The service package identifier
-
makeId
(string) The vehicle make identifier
-
modelId
(string) The vehicle model identifier
-
variantId
(string) The vehicle variant identifier
-
user
(string) The user who made the service package request
-
vehicleSectionCode
(string) The vehicle section code
-
method
(string) The method from the Service Package call (GET, POST or DELETE)
-
responseCode
(number) The HTTPS response code from the Service Package call (201, 402, 500, etc...)
-
responseSuccessful
(boolean) Contains True if the HTTPS response from the Service Package call was successful
-
dateStart
(required)(string) Contains the date to start collecting data in YYYY-MM-DD format (eg 1997-07-16)
-
dateEnd
(string) Contains the date to end collecting data in YYYY-MM-DD format (eg 1997-07-16)
-
page
(number) A non-zero integer representing the page of the results
-
pageSize
(number) A non-negative, non-zero integer indicating the maximum number of results to return at one time
-
Accept
(required)(string)
-
Accept-Charset
(required)(string)
-
Accept-Language
(required)(string) See RFC 7231 (example US-EN)
-
Prefer
(required)(string)
-
Region
(string) Provided to support data from multiple regions (Like US and CA)
-
Request-Id
(required)(string)
-
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
-
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...