POST

/results

Results API · ADMINISTRATIESYSTEEMLEERRESULTATEN - Administratiesysteem leerresultaten · Ontvanger / PushSynchronous / Server

Terug naar sandbox

Sandbox endpoint

http://eduvtestlab.bloemendaalconsultancy.nl/sandbox/11111111-1111-1111-1111-111111111111/api/results

List of student scores/results items, for each item to create a new scores/results object for the student or change an existing student scores/results object, including general information (e.g. the assessment/test and date and time of offering).

Databankdekking

Hosted sandbox gebruikt faker fallback
Captures
0
0 requests · 0 responses
Laatst: -
Validatie
0 valide
0 ongeldig volgens huidige fieldspecs
Verouderde specificatie
0 captures
Gebaseerd op deprecated runtimeversies

Bad flows

Code Status HTTP
0000
OK
Bevraging succesvol.
 200
0001
Created
Bericht heeft geleid tot registratie van een nieuwe entiteit.
 201
0002
Accepted
Bericht geaccepteerd.
 202
0011
Schema incorrect
Schemavalidatie niet succesvol
 400
0012
schemaVersion not supported
De ontvanger kan de gehanteerde schemaVersion niet verwerken
 400
0021
scope required
Deelnemer is niet geautoriseerd voor scope
 401
0022
consent required
Het informatieobject is van classificatie IV. Dit vereist een activering van de gegevensdienst. Dit is in dit foutscenario niet het geval.
 403
0023
school unknown
De client communiceert in de context van een Onderwijsorganisatie die niet bekend is bij server
 400
0099
Vullingsregel: in statusMessage een beschrijving van de reden opnemen
Overige reden
 400
8001
Student identifier unknown
De identifier van onderwijsdeelnemer is onbekend.
 - Negatieve flow
8002
Employee identifier unknown
De identifier van onderwijsmedewerker is onbekend.
 - Negatieve flow
8003
Score value is invalid for the score type
Een in het bericht opgenomen score is ongeldig gegeven de bijbehorende typering
 -
8004
Result value is invalid for the result type
Een in het bericht opgenomen resultaat is ongeldig gegeven de bijbehorende typering
 -

Statuscodes

HTTP Betekenis
201 The request has led to the creation of a resource. Succes
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
400 This is the error response for HTTP status code 400 (Bad request). Foutpad
401 This is the error response for HTTP status code 401 (Unauthorized). Foutpad
403 This is the error response for HTTP status code 403 (Forbidden). Foutpad

Recente databankcaptures

Geen captures beschikbaar
Dit endpoint heeft nog geen opgeslagen request- of responsepayloads in de gedeelde databank.

Veldspecificaties

Pad Naam Type Verplicht Regels
request.body body Object Nee Min: - · Max: - · Pattern: -
request.body.additionalInfo additionalInfo String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDateTime assessmentDateTime DateTime Ja Min: - · Max: - · Pattern: -
request.body.assessmentDefinition assessmentDefinition Object Ja Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.id id String Ja Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.name name String Ja Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.parts parts Array Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.parts[*] parts Object Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.parts[*].id id String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.parts[*].index index Integer Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.parts[*].name name String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.studyLevelId studyLevelId String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.subjects subjects Array Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.subjects[*] subjects Object Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.subjects[*].subjectName subjectName String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.subjects[*].subjectPrefix subjectPrefix String Nee Min: - · Max: - · Pattern: -
request.body.assessmentDefinition.version version String Nee Min: - · Max: - · Pattern: -
request.body.employees employees Array Nee Min: - · Max: - · Pattern: -
request.body.employees[*] employees Object Nee Min: - · Max: - · Pattern: -
request.body.employees[*].userIds userIds Array Nee Min: - · Max: - · Pattern: -
request.body.employees[*].userIds[*] userIds Object Nee Min: - · Max: - · Pattern: -
request.body.employees[*].userIds[*].userId userId String Nee Min: - · Max: - · Pattern: -
request.body.employees[*].userIds[*].userIdType userIdType Enum Nee Min: - · Max: - · Pattern: -
request.body.employees[*].userMasterIdentifier userMasterIdentifier String Nee Min: - · Max: - · Pattern: -
request.body.id id String Ja Min: - · Max: - · Pattern: -
request.body.reviewUrl reviewUrl String Nee Min: - · Max: - · Pattern: -
request.body.school school Object Ja Min: - · Max: - · Pattern: -
request.body.school.organisationIds organisationIds Array Nee Min: - · Max: - · Pattern: -
request.body.school.organisationIds[*] organisationIds Object Nee Min: - · Max: - · Pattern: -
request.body.school.organisationIds[*].organisationId organisationId String Nee Min: - · Max: - · Pattern: -
request.body.school.organisationIds[*].organisationIdType organisationIdType Enum Nee Min: - · Max: - · Pattern: -
request.body.school.organisationMasterIdentifier organisationMasterIdentifier String Nee Min: - · Max: - · Pattern: -
request.body.schoolPeriod schoolPeriod String Ja Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions scoreScaleDefinitions Array Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*] scoreScaleDefinitions Object Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].id id String Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].name name String Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].scoreScaleEntries scoreScaleEntries Array Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*] scoreScaleEntries Object Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*].LHS LHS String Nee Min: - · Max: - · Pattern: -
request.body.scoreScaleDefinitions[*].scoreScaleEntries[*].RHS RHS String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults studentScoresAndResults Array Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*] studentScoresAndResults Object Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].additionalInfo additionalInfo String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].dateCreated dateCreated DateTime Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].dateLastModified dateLastModified DateTime Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].id id String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].missing missing Boolean Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results results Array Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results[*] results Object Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results[*].assessmentId assessmentId String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results[*].assessmentPartId assessmentPartId String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results[*].resultType resultType Enum Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].results[*].resultValue resultValue String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].reviewUrl reviewUrl String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores scores Array Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*] scores Object Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].assessmentId assessmentId String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].assessmentPartId assessmentPartId String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].scoreMaximum scoreMaximum String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].scoreScaleIds scoreScaleIds Array Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].scoreScaleIds[*] scoreScaleIds String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].scoreType scoreType Enum Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].scores[*].scoreValue scoreValue String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].status status Enum Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student student Object Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student.userIds userIds Array Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student.userIds[*] userIds Object Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student.userIds[*].userId userId String Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student.userIds[*].userIdType userIdType Enum Nee Min: - · Max: - · Pattern: -
request.body.studentScoresAndResults[*].student.userMasterIdentifier userMasterIdentifier String Nee Min: - · Max: - · Pattern: -
request.body.timestamp timestamp DateTime Ja Min: - · Max: - · Pattern: -
request.body.toolName toolName String Nee Min: - · Max: - · Pattern: -
response.400 response 400 Array Nee Min: - · Max: - · Pattern: -
response.400[*] response 400 Object Nee Min: - · Max: - · Pattern: -
response.400[*].id id String Nee Min: - · Max: - · Pattern: -
response.400[*].status status Integer Ja Min: - · Max: - · Pattern: -
response.400[*].statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -
response.401 response 401 Array Nee Min: - · Max: - · Pattern: -
response.401[*] response 401 Object Nee Min: - · Max: - · Pattern: -
response.401[*].id id String Nee Min: - · Max: - · Pattern: -
response.401[*].status status Integer Ja Min: - · Max: - · Pattern: -
response.401[*].statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -
response.403 response 403 Array Nee Min: - · Max: - · Pattern: -
response.403[*] response 403 Object Nee Min: - · Max: - · Pattern: -
response.403[*].id id String Nee Min: - · Max: - · Pattern: -
response.403[*].status status Integer Ja Min: - · Max: - · Pattern: -
response.403[*].statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -

Business rules

Geen business rules
Voor deze API-definitie zijn geen business rules vastgelegd.