563848e0ecc0
Retrieve the validation schema for a roster job
Returns the JSON Schema document that governs validation of the rows in one roster job.
When to use: call this before preparing or correcting a roster file, to see exactly which fields, types, and constraints will be enforced; it is also the quickest way to understand why particular rows failed validation.
How the schema is resolved: a schema attached to this specific roster job takes precedence; when the job has none, the schema belonging to its template is returned instead.
Preconditions: supply the tenant-id header and the roster job's id. The job must have a template associated with it - a roster without one returns 400, which is resolved by assigning a valid template to the roster and calling again.
What you get back: a JSON Schema document conforming to draft 2019-09, describing the expected shape of a single roster row. Read-only; no state is mutated.
Path parameters
Identifier of the roster job, as returned by the roster listing endpoints.
Headers
Unique identifier of the tenant that owns the roster job. Obtained from your account configuration; it scopes every roster this request can reach.
Response
The JSON Schema document that roster rows are validated against.
A JSON Schema document (draft 2019-09). Free-form here because its properties mirror the roster's template, so the keys vary per roster.