Decide exact enrollment#

PropertyValue
Servicecrossfire
OperationdecideEnrollment
MethodPOST
Path/api/enrollments/{enrollmentId}/decision
Authenticationhuman
Success status202
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesenrollment.approve.owned, enrollment.reject.owned, enrollment.reject.any

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

HTTP 202 means the request was accepted for processing. Check the operation’s status to find out whether it completed.

Path parameters#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
enrollmentIdlowercase opaque UUID

Validation#

check.object({ enrollmentId: check.identifier })

Referenced definitions:

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

Request body#

object; fields below; unknown fields rejected ( enrollmentDecision )

Field pathRepresentation and constraints
expectedRevisionexact JSON integer; 0…9007199254740991 ( revision )
decisionapprove or reject
verificationCodestring; 12–12 UTF-16 units; well-formed Unicode; no C0/DEL controls

Validation#

req.enrollmentDecision

Referenced definitions:

Response data#

object; fields below; unknown fields rejected ( enrollmentDecision )

Field pathRepresentation and constraints
enrollmentIdlowercase opaque UUID
statusapproved or rejected
revisionexact JSON integer; 0…9007199254740991

Validation#

res.enrollmentDecision

Referenced definitions:

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}