Veldspecificaties

88 items
Veld Beschrijving Type Verplicht Beperkingen
request.body
body

The message that contains information about the assessment (test) that has been taken and the scores and results for one or more participants (students).

Object Nee - Bewerken
request.body.additionalInfo
additionalInfo

Optional additional information about the bundle of student scores/results. E.g. a generic remark regarding all scores/results.

Tekenreeks Nee - Bewerken
request.body.assessmentDateTime
assessmentDateTime

Date and time of the assessment offering. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6.

Datum/tijd Ja - Bewerken
request.body.assessmentDefinition
assessmentDefinition

Definition of assessment for which scores/results are reported.

Object Ja - Bewerken
request.body.assessmentDefinition.id
id

Assessment identifier that is used for reference for which scores/results are reported.

Tekenreeks Ja - Bewerken
request.body.assessmentDefinition.name
name

Name of the assessment to be displayed to employees that register results in the gradebook.

Tekenreeks Ja - Bewerken
request.body.assessmentDefinition.parts
parts
Lijst[] Nee - Bewerken
request.body.assessmentDefinition.parts[*]
parts

Definition of assessment parts for which scores/results are reported.

Object Nee - Bewerken
request.body.assessmentDefinition.parts[*].id
id

Assessment part reference for which scores/results are reported.

Tekenreeks Nee - Bewerken
request.body.assessmentDefinition.parts[*].index
index

Number for sequencing the assessment parts.

Geheel getal Nee - Bewerken
request.body.assessmentDefinition.parts[*].name
name

Name of the assessment part to be displayed in the gradebook.

Tekenreeks Nee - Bewerken
request.body.assessmentDefinition.studyLevelId
studyLevelId

Id of the study level of the assessment.

Tekenreeks Nee - Bewerken
request.body.assessmentDefinition.subjects
subjects
Lijst[] Nee - Bewerken
request.body.assessmentDefinition.subjects[*]
subjects

Subject for which scores/results are reported as a result of the assessment.

Object Nee - Bewerken
request.body.assessmentDefinition.subjects[*].subjectName
subjectName

Name of the subject

Tekenreeks Nee - Bewerken
request.body.assessmentDefinition.subjects[*].subjectPrefix
subjectPrefix

Prefix of the subject.

Tekenreeks Nee - Bewerken
request.body.assessmentDefinition.version
version

Version of assessment.

Tekenreeks Nee - Bewerken
request.body.employees
employees

List of employee identifications.

Lijst[] Nee - Bewerken
request.body.employees[*]
employees

A reference to an assessment participant (Employee) based on identification.

Object Nee - Bewerken
request.body.employees[*].userIds
userIds
Lijst[] Nee - Bewerken
request.body.employees[*].userIds[*]
userIds

A single reference to an employee, using id and type in an identification entry.

Object Nee - Bewerken
request.body.employees[*].userIds[*].userId
userId

Extra unique id of this user according to the type userIdType, besides the userMasterIdentifier.

Tekenreeks Nee - Bewerken
request.body.employees[*].userIds[*].userIdType
userIdType

The type of extra unique id of this user in userId.

Keuzelijst Nee toegestaan ["NEPRI","BPI","eduID","ASI"] Bewerken
request.body.employees[*].userMasterIdentifier
userMasterIdentifier

Unique id of this employee-user according to the master identifier type.

Tekenreeks Nee - Bewerken
request.body.id
id

Message id.

Tekenreeks Ja - Bewerken
request.body.reviewUrl
reviewUrl

Optional link into the assesment system (deeplink) to the details of about the bundle of student scores/results.

Tekenreeks Nee - Bewerken
request.body.school
school

A reference to a school based on its identifications.

Object Ja - Bewerken
request.body.school.organisationIds
organisationIds
Lijst[] Nee - Bewerken
request.body.school.organisationIds[*]
organisationIds

A single reference to a school by using id and type in an identification entry.

Object Nee - Bewerken
request.body.school.organisationIds[*].organisationId
organisationId

Unique id of this organisation to the type organisationIdType, besides the organisationMasterIdentifier.

Tekenreeks Nee - Bewerken
request.body.school.organisationIds[*].organisationIdType
organisationIdType

The type of extra unique id of this organisation in organisationId.

Keuzelijst Nee toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID"] Bewerken
request.body.school.organisationMasterIdentifier
organisationMasterIdentifier

Unique id of this school according to the master identifier type.

Tekenreeks Nee - Bewerken
request.body.schoolPeriod
schoolPeriod

School period, e.g. schoolyear of semester.

Tekenreeks Ja - Bewerken
request.body.scoreScaleDefinitions
scoreScaleDefinitions

List of score scale definitions.

Lijst[] Nee - Bewerken
request.body.scoreScaleDefinitions[*]
scoreScaleDefinitions

Definition of score scales for conversion from score to result.

Object Nee - Bewerken
request.body.scoreScaleDefinitions[*].id
id

Score scale identifier that is used for reference.'

Tekenreeks Nee - Bewerken
request.body.scoreScaleDefinitions[*].name
name

Name of the score scale.

Tekenreeks Nee - Bewerken
request.body.scoreScaleDefinitions[*].scoreScaleEntries
scoreScaleEntries
Lijst[] Nee - Bewerken
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*]
scoreScaleEntries

Entry for LHS & RHS combination.

Object Nee - Bewerken
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*].LHS
LHS

Defines the score interval, e.g. '0-5' or '0.0-5.5'. The format is either a single value ('x') or a range ('x' - 'y'). In the case of a single value this is considered to be the inclusive lower value for the implied interval. When a range is specified (lower-to-upper) the values are inclusive for the specified interval.

Tekenreeks Nee - Bewerken
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*].RHS
RHS

Defines the result label which is based on the scoreValue and LHS, e.g. 'Onvoldoende'.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults
studentScoresAndResults
Lijst[] Nee - Bewerken
request.body.studentScoresAndResults[*]
studentScoresAndResults

Scores/results statement for a specific student.

Object Nee - Bewerken
request.body.studentScoresAndResults[*].additionalInfo
additionalInfo

Optional additional information about these scores/results. E.g. for indicating which judgement level has been applied or the reason for absence of student scores/results.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].dateCreated
dateCreated

Date and time of the creation of this object. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6.

Datum/tijd Nee - Bewerken
request.body.studentScoresAndResults[*].dateLastModified
dateLastModified

Date and time of the latest modification of this object. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6.

Datum/tijd Nee - Bewerken
request.body.studentScoresAndResults[*].id
id

Unique id of this scores/results statement

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].missing
missing

The indication whether the student scores/results are missing or not.

Ja/nee Nee - Bewerken
request.body.studentScoresAndResults[*].results
results

List of student results.

Lijst[] Nee - Bewerken
request.body.studentScoresAndResults[*].results[*]
results

A single result, using value and type in a result entry.

Object Nee - Bewerken
request.body.studentScoresAndResults[*].results[*].assessmentId
assessmentId

Reference to the assessment of this result.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].results[*].assessmentPartId
assessmentPartId

Reference to the assessment part of this result.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].results[*].resultType
resultType

Enumeration for the type of results that defines allowed values for resultValue.

Keuzelijst Nee toegestaan ["AE","AVI","CAE","CIV","CPercentiel","DLE","EducationLevel","FunctioningLevel","Grade0-10","Grade0.0-10.0","IV","LA","LGH","OVG","PassOrFail","Percentiel","RnERK","RnTR"] Bewerken
request.body.studentScoresAndResults[*].results[*].resultValue
resultValue

Value of the achieved assessment Result.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].reviewUrl
reviewUrl

Optional link into the assesment system (deeplink) to the details of these student scores/results.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].scores
scores

List of student scores.

Lijst[] Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*]
scores

A single score, using value and type in a score entry.

Object Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].assessmentId
assessmentId

Reference to the assessment of this score.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].assessmentPartId
assessmentPartId

Reference to the assessment part of this score.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].scoreMaximum
scoreMaximum

Maximum value of the achieved assessment score.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].scoreScaleIds
scoreScaleIds

References to the score scale for conversion to result value.

Lijst[] Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].scoreScaleIds[*]
scoreScaleIds

References to the score scale for conversion to result value.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].scores[*].scoreType
scoreType

Enumeration for the type of scores that defines allowed values for scoreValue.

Keuzelijst Nee toegestaan ["DurationInSeconds","NumberCorrect","NumberIncorrect","NumberItems","PercentageCorrect","ScorePoints","SkillScore"] Bewerken
request.body.studentScoresAndResults[*].scores[*].scoreValue
scoreValue

Value of the achieved assessment score.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].status
status

Status of the student student scores/results statement.

Keuzelijst Nee toegestaan ["InProgress","Final","Canceled"] Bewerken
request.body.studentScoresAndResults[*].student
student

A reference to an assessment participant (Student) based on its identifications.

Object Nee - Bewerken
request.body.studentScoresAndResults[*].student.userIds
userIds
Lijst[] Nee - Bewerken
request.body.studentScoresAndResults[*].student.userIds[*]
userIds

A single reference to a student, using id and type in an identification entry.

Object Nee - Bewerken
request.body.studentScoresAndResults[*].student.userIds[*].userId
userId

Extra unique id of this user according to the type userIdType, besides the userMasterIdentifier.

Tekenreeks Nee - Bewerken
request.body.studentScoresAndResults[*].student.userIds[*].userIdType
userIdType

The type of extra unique id of this user in userId.

Keuzelijst Nee toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI"] Bewerken
request.body.studentScoresAndResults[*].student.userMasterIdentifier
userMasterIdentifier

Unique id of this student-user according to the master identifier type.

Tekenreeks Nee - Bewerken
request.body.timestamp
timestamp

Date and time of the message assembling. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6.

Datum/tijd Ja - Bewerken
request.body.toolName
toolName

Name of tool/system that sends these assessment scores/results.

Tekenreeks Nee - Bewerken
response.400
response 400

Functional status code and status message in list per student scores/results.

Lijst[] Nee - Bewerken
response.400[*]
response 400

Functional status code and status message in list item per student scores/results.

Object Nee - Bewerken
response.400[*].id
id

Unique id of the student scores/results.

Tekenreeks Nee - Bewerken
response.400[*].status
status

See functional status codes within the Documentation.

Geheel getal Ja - Bewerken
response.400[*].statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee - Bewerken
response.401
response 401

Functional status code and status message in list per student scores/results.

Lijst[] Nee - Bewerken
response.401[*]
response 401

Functional status code and status message in list item per student scores/results.

Object Nee - Bewerken
response.401[*].id
id

Unique id of the student scores/results.

Tekenreeks Nee - Bewerken
response.401[*].status
status

See functional status codes within the Documentation.

Geheel getal Ja - Bewerken
response.401[*].statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee - Bewerken
response.403
response 403

Functional status code and status message in list per student scores/results.

Lijst[] Nee - Bewerken
response.403[*]
response 403

Functional status code and status message in list item per student scores/results.

Object Nee - Bewerken
response.403[*].id
id

Unique id of the student scores/results.

Tekenreeks Nee - Bewerken
response.403[*].status
status

See functional status codes within the Documentation.

Geheel getal Ja - Bewerken
response.403[*].statusMessage
statusMessage

See functional status messages within the Documentation.

Tekenreeks Nee - Bewerken

Verwachte statuscodes

5 items
Code Betekenis Uitkomst
201 The request has led to the creation of a resource. Succes Bewerken
202 The request has been accepted for processing, but the processing has not been completed; in fact, processing may not have started yet. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. Succes Bewerken
400 This is the error response for HTTP status code 400 (Bad request). Fout Bewerken
401 This is the error response for HTTP status code 401 (Unauthorized). Fout Bewerken
403 This is the error response for HTTP status code 403 (Forbidden). Fout Bewerken