Expand description
The mock’s half of the six contract endpoints: the client’s own request and response types, re-exported so a mock body that the client cannot read is a compile error, plus the shapes and message strings that exist only on the answering side.
Every endpoint takes a top-level JSON array and answers with one item per request item, in order. Per-item outcomes are HTTP 200; only request-level failures are 4xx/5xx.
Structs§
- Credit
Range - Date
Period - Enrolment
Resolution Result - Enrolments
Listed Result - Existing
Attainment - Import
Attainment Request Item - Import
Attainment Result - One shape for import’s four success codes:
sentfills the submitted pair,registeredandduplicateAttainmentfillattainment,notImprovedAttainmentfillsprevious_attainment. - List
ByCourse Request Item - Listed
Enrolment - Listed
Person - Localized
Name - Person
Result - Product
Access Token Request Item - Product
Access Token Result - Request
Level Error - Request
Level Error Body - Resolve
Enrolment Request Item - Resolve
Person Request Item - Suotar
Attainment - Covers both contract bodies: the bare
{id, type}of aregisteredanswer and the fuller one behindduplicateAttainmentandnotImprovedAttainment. - Suotar
Enrolment - Suotar
Item Error - Suotar
Response Item - Verify
Attainment Request Item - Verify
Attainment Result
Enums§
Functions§
- canonical_
message sisuTemporarilyUnavailableis worded differently per endpoint, reproduced here so a client keying offmessageinstead ofcodebreaks.- erase
- error_
item - error_
item_ with_ message - ok_item
Type Aliases§
- Erased
Response Item - A request’s items are all one endpoint’s shape, but the pipeline also carries fault-shaped items and logs them, so the payload is erased once the per-item logic has built it in its typed form.