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

Preview additional offering dates

Creates a durable preview expiring after 15 minutes. Appends 1–120 unique future same-day dates in an IANA timezone. Rejects invalid local times, overlaps and resource-assigned schedules. Does not replace, reschedule or cancel dates. Strict JSON body; maximum 16,384 UTF-8 bytes. Unknown query parameters and request fields are rejected. Requires schedule.preview.

POST/commands/preview_offering_schedule
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.

Header parameters
Idempotency-Keystringrequired

Persist with the job and reuse for retries. Scoped to organization, token, command and API version. Different input with the same key returns 409. Supported automatic retry window: 24 hours.

min length 1 · max length 128 · matches ^[!-~]+$
Request body
requiredapplication/json
offering_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
timezonestringrequired
min length 1 · max length 256
datesobject[]required
min items 1 · max items 120
Show properties
Array of object
local_datestring<date>required
min length 1 · max length 256
local_start_timestringrequired
min length 1 · max length 256 · matches ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
local_end_timestringrequired
min length 1 · max length 256 · matches ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
Responses
200

Successful operation.

datapreview_offering_scheduleResultrequired
Show properties
offering_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
organization_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
timezonestringrequired
createobject[]required
Show properties
Array of object
starts_atstring<date-time>required
ends_atstring<date-time>required
retainstring[]required
affected_enrollment_countnumberrequired
requires_approvalbooleanrequired
preview_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
approval_tokenstringrequired
expires_atstring<date-time>required
input_hashstringrequired
request_idstring<uuid>required
idempotent_replaybooleanrequired
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
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/commands/preview_offering_schedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "offering_id": "string",
  "timezone": "string",
  "dates": [
    {
      "local_date": "2019-08-24",
      "local_start_time": "string",
      "local_end_time": "string"
    }
  ]
}'
Response
{
  "data": {
    "offering_id": "string",
    "organization_id": "string",
    "timezone": "string",
    "create": [
      {
        "starts_at": "2019-08-24T14:15:22Z",
        "ends_at": "2019-08-24T14:15:22Z"
      }
    ],
    "retain": [
      "string"
    ],
    "affected_enrollment_count": 0,
    "requires_approval": true,
    "preview_id": "string",
    "approval_token": "string",
    "expires_at": "2019-08-24T14:15:22Z",
    "input_hash": "string"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "idempotent_replay": true
}

Was this page helpful?