Skip to main content
GET
Read the offer file generation of an assignment set

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

setId
string<uuid>
required

Assignment set identifier.

Response

OK

assignmentSetId
string
required

The set the offer file is generated for.

state
enum<string>
required

pending: Reporter is rendering the file. failed: the attempt ended without a file; failureCode says why and POST starts the next attempt. ready: the file is authorized and served by GET .../offer-file.

Available options:
pending,
failed,
ready
attempt
integer<int64>

The attempt number, from 1. Absent when the set's file was authorized with no Reporter generation.

attemptStartedAt
string<date-time>

When the attempt started (RFC3339, UTC). An attempt pending for 30 minutes fails as reporter_timeout.

failureCode
enum<string>

Why the attempt ended without a file. composition_changed: a line left the lot after this attempt started; POST starts the next attempt over the lines still in it.

Available options:
template_changed,
template_missing,
reporter_access_denied,
reporter_refused,
report_failed,
report_partial,
report_incomplete,
report_too_large,
reporter_timeout,
set_not_approved,
composition_changed
failureDetail
string

What Reporter or the verification reported, for the failure code.

file
object

The authorized file. Present only when ready.

reportId
string

The Reporter report rendering the attempt, once Reporter accepted the request.

requestedBy
string

Validated identity that started the attempt.

templateId
string<uuid>

The Reporter template the attempt froze.

transientError
enum<string>

A transient Reporter failure seen on this read. The attempt stays pending.

Available options:
reporter_unavailable