get
/availability
Resource Details
|
Security |
|
|---|---|
|
Category |
Queries |
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| interval | string | ISO 8601 datetime interval for filtering availability | Yes |
| serviceTeamId | string | Service team identifer for filtering availability | No |
| serviceAdvisorId | string | Service advisor identifer for filtering availability | No |
| transportationId | string | Transportation identifer for filtering availability | No |
| duration | number | Total duration in minutes of requested services | No |
| useIntervals | boolean | Return availability at the interval level of granularity | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Request-Id | string | n/a | Yes |
| 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 | 400 - Bad Request |
| 401 | 401 - Unauthorized |
| 403 | 403 - Forbidden |
Try It Out
-
interval
(required)(string) ISO 8601 datetime interval for filtering availability
-
serviceTeamId
(string) Service team identifer for filtering availability
-
serviceAdvisorId
(string) Service advisor identifer for filtering availability
-
transportationId
(string) Transportation identifer for filtering availability
-
duration
(number) Total duration in minutes of requested services
-
useIntervals
(boolean) Return availability at the interval level of granularity
-
Request-Id
(required)(string)
-
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...