Dynamic includes
In Slotify, you have the flexibility to dynamically include related objects, also known as expanding objects, in API responses. For instance, when retrieving a resource:
- curl
curl --request GET \
--url https://api.slotify.ca/v1/resources/123e4567-e89b-12d3-a456-426655440000?include=meta,app \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <BASE64-ENCODED_TOKEN>'
You can also retrieve multiple related objects simultaneously by separating them with commas. For example, appending ?include=meta,app to the URL fetches both calendars and accounts associated with the resource.
Refining Your Search
In Slotify's API, you can specify your search criteria using the "search" query parameter. Each search criterion follows a key-value pair format separated by a colon.
For example, appending "?search=first_name:john;last_name:doe" to the URL will search for resources where resource first name is john and last name is doe.
Following table shows how search query is interpreted as search conditions:
| Parameter | Description |
|---|---|
| ?search=field1:value;field2:value | WHERE ( field1 = value AND field2 = value) |
| ?search=field1|value;field2|value | WHERE ( field1 = value OR field2 = value) |
| ?search=field1:value;field2!:value | WHERE ( field1 = value AND field2 <> value) |
| ?search=field1>=:value;field2<=:value | WHERE ( field1 >= value AND field2 <= value) |
| ?search=field1>:value;field2<:value | WHERE ( field1 > value AND field2 < value) |
| ?search=field~:value | WHERE field like '%value%' |