Query Appointment Slots

POST

/slots

Query available appointment slots.

Resource Details

Security

Request

Path Parameters

Parameter Type Description Required

Query Parameters

Parameter Type Description Required
queryToken string A token that represents a slotQueryRequest used in a previous request. This is used to support pagination for subsequent calls to the /slots endpoint. No
page number A non-zero integer indicating the requested the page of query 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 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
Prefer string n/a Yes
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

Expand All
Collapse All

Request Body Example

Response

Response Body Structure

Expand All
Collapse All

Response Body Example

Response Error Details

HTTP Code Description
400 400 - Bad Request
401 401 - Unauthorized
403 403 - Forbidden
410 410 - Gone - Query Token Expired

Try It Out

  • queryToken

    (string) A token that represents a slotQueryRequest used in a previous request. This is used to support pagination for subsequent calls to the /slots endpoint.

  • page

    (number) A non-zero integer indicating the requested the page of query 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)

  • 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
    (required)

    (string)

  • 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.

Reset

Make a request and see the request.

Make a request and see the response.

Make a request and see the cURL.

Working...

x