Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Expand a weekly or fortnightly private lesson series into dates, with alternatives for dates that can't be booked.

Expand a weekly or fortnightly private lesson series into dates, with alternatives for dates that can’t be booked. An organization-scoped read using JSON filter arguments; requires private_lessons.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/plan_private_lesson_series
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
endobjectrequired
Show properties
Any of:
object
countnumberrequired
kindstringrequired
object
datestringrequired
kindstringrequired
exclude_appointment_idsstring[]
exclude_booking_idstring

Opaque Soljio resource ID.

min length 1
instructor_idstring

Opaque Soljio resource ID.

min length 1
interval_weeksnumberrequired
Show properties
Any of:
number
number
number
number
lesson_type_idstringrequired

Opaque Soljio resource ID.

min length 1
location_idstringrequired

Opaque Soljio resource ID.

min length 1
nownumberrequired
overridebooleanrequired
starts_atstring<date-time>required
Responses
200

Successful read.

dataobjectrequired
Show properties
closed_datesstring[]required
instructor_idstring

Opaque Soljio resource ID.

min length 1
lessonsobject[]required
Show properties
Array of object
alternativesnumber[]required
local_datestringrequired
problemstring
starts_atstring<date-time>required
timezonestringrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/plan_private_lesson_series' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "end": {
    "count": 0,
    "kind": "count"
  },
  "exclude_appointment_ids": [
    "string"
  ],
  "exclude_booking_id": "string",
  "instructor_id": "string",
  "interval_weeks": 1,
  "lesson_type_id": "string",
  "location_id": "string",
  "now": 0,
  "override": true,
  "starts_at": "2019-08-24T14:15:22Z"
}'
Response
{
  "data": {
    "closed_dates": [
      "string"
    ],
    "instructor_id": "string",
    "lessons": [
      {
        "alternatives": [
          0
        ],
        "local_date": "string",
        "problem": "string",
        "starts_at": "2019-08-24T14:15:22Z"
      }
    ],
    "timezone": "string"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}