Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETENROLLMENTSSCHOOLID
Bewerken
Testcase bewerken
Werk testcasevelden, endpointkoppeling en JSON-definities bij.
Terug naar lijst
Stabiele testcase-id
Code
Name
Categorie
Sector
Doelrol
Alle rollen
Verzender
Ontvanger
Afnemer
Bron
Doelversie
Groep
Tags
TestType
KVT
IOT
Severity
Info
Laag
Middel
Hoog
Kritiek
Endpoint
Geen endpoint gekoppeld
Association API (PullSynchronous) · GET /assignments/school
Association API (PullSynchronous) · GET /assignments/school/{id}
Association API (PullSynchronous) · GET /enrollments/school
Association API (PullSynchronous) · GET /enrollments/school/{id}
Association API (PullSynchronous) · GET /groups/school
Association API (PullSynchronous) · GET /groups/school/{id}
Association API (PullSynchronous) · GET /schoolperiods/school
Association API (PullSynchronous) · GET /schoolperiods/school/{id}
Association API (PushSynchronous) · POST /assignments/school/employee
Association API (PushSynchronous) · POST /enrollments/school/student
Education API · GET /organisations
Education API · GET /studyofferings/school
Education API · GET /studyofferings/school/{id}
Education API · GET /subjectofferings/school
Education API · GET /subjectofferings/school/{id}
Employees API (PullSynchronous) · GET /employees/school
Employees API (PushSynchronous) · POST /employees
Students API (PullSynchronous) · GET /students/school
Students API (PushSynchronous) · POST /students
Description
Request Enrollment object based on its enrollmentId.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/enrollments/school/{{path.KVTGETENROLLMENTSSCHOOLID.id}}","url":"{{supplier.baseUrl}}/enrollments/school/{{path.KVTGETENROLLMENTSSCHOOLID.id}}","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETENROLLMENTSSCHOOLID.orgMasterId}}","orgId":"{{query.KVTGETENROLLMENTSSCHOOLID.orgId}}","orgIdType":"{{query.KVTGETENROLLMENTSSCHOOLID.orgIdType}}"},"requestFieldSpecifications":[{"fieldPath":"request.path.id","name":"id","dataType":"String","isRequired":true,"isArray":false,"description":"Reference to the enrollmentId of the Enrollment object."},{"fieldPath":"request.query.orgMasterId","name":"orgMasterId","dataType":"String","isRequired":false,"isArray":false,"description":"The organisationMasterIdentifier of the school.\nThis parameter is used when the primary identifier for a school (being the \u0060OnderwijsaanbiederId\u0060) is available.\n"},{"fieldPath":"request.query.orgId","name":"orgId","dataType":"String","isRequired":false,"isArray":false,"description":"The organisationIdentifier (secondary identifier) of the school.\nThis parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.\n"},{"fieldPath":"request.query.orgIdType","name":"orgIdType","dataType":"Enum","isRequired":false,"isArray":false,"description":"The type of the organisationIdentifier.\nThis parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.\nThe following values are supported:\n- \u0060OIE_CODE\u0060: OnderwijsInstellingserkenningcode\n- \u0060BP_ID\u0060: Basispoort-generated identifier for the school\n- \u0060DD_ID\u0060: DigiDeliveryId generated by the Central Registration of Edu-iX\n- \u0060AS_ID\u0060: LAS-generated identifier (LAS-Key) for the school\n- \u0060V_ID\u0060: VestigingsId \u2013 BRIN6-format identifier, including dummy locations\n","allowedValues":["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETENROLLMENTSSCHOOLID.tokenEndpoint}}","defaultTokenEndpoint":"https://api.example.com/oauth2/token","scopes":"eduv.association","scheme":"OAuth2"}}
Expected result JSON
{"statusCode":200,"responseMustBeJson":true,"headers":{"Content-Type":"application/json"},"responseBody":{"enrollmentId":"11111111-1111-1111-1111-111111111111","student":{"userMasterIdentifier":"SAMPLE-ID-001","userIds":[{"userId":"SAMPLE-ID-001","userIdType":"NEPPI"}]},"enrollmentType":"study","schoolPeriod":"sample-value","beginDate":"2022-07-31","status":"active","dateCreated":"2017-07-21T17:32:28Z","dateLastModified":"2022-08-11T15:31:12Z"},"responseFieldSpecifications":[{"fieldPath":"response.200","name":"response 200","dataType":"Object","isRequired":false,"isArray":false,"description":"The Enrollment object for a student into a StudyYear or SubjectOffering for a SchoolPeriod."},{"fieldPath":"response.200.enrollmentId","name":"enrollmentId","dataType":"Uuid","isRequired":true,"isArray":false,"description":"A unique identifier for this Enrollment object.\nThis is the GUID that Consumers will refer to when making API calls, or when needing to identify an object.\n"},{"fieldPath":"response.200.student","name":"student","dataType":"Object","isRequired":true,"isArray":false,"description":"The Student to which this enrollment object belongs."},{"fieldPath":"response.200.student.userMasterIdentifier","name":"userMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for a User.\nFor Students the ECK iD is used.\nFor Employees this value is empty. There is no primary identifier for Employees.\n(either userMasterIdentifier or userIds is required)\n"},{"fieldPath":"response.200.student.userIds","name":"userIds","dataType":"Array","isRequired":false,"isArray":true,"description":"A secondary identifier for a User. This value is used whenever the primary identifier is not available.\nFor Employees this value is mandatory.\n(either userMasterIdentifier or userIds is required)\n"},{"fieldPath":"response.200.student.userIds[*]","name":"userIds","dataType":"Object","isRequired":false,"isArray":false,"description":"A secondary identifier for a User. This value is used whenever the primary identifier is not available.\nFor Employees this value is mandatory.\n(either userMasterIdentifier or userIds is required)\n"},{"fieldPath":"response.200.student.userIds[*].userId","name":"userId","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200.student.userIds[*].userIdType","name":"userIdType","dataType":"Enum","isRequired":true,"isArray":false,"description":null,"allowedValues":["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]},{"fieldPath":"response.200.enrollmentType","name":"enrollmentType","dataType":"Enum","isRequired":true,"isArray":false,"description":"The type of enrollment, being one of:\n- study: an enrollment into a StudyOffering offered by the School.\n- subject: an enrollment into a SubjectOffering offered by the School.\n","allowedValues":["study","subject"]},{"fieldPath":"response.200.study","name":"study","dataType":"Uuid","isRequired":false,"isArray":false,"description":"A reference to the studyOfferingId of the StudyOffering in case this enrollment is of the enrollmentType \u0060study\u0060."},{"fieldPath":"response.200.studyPublicId","name":"studyPublicId","dataType":"Uuid","isRequired":false,"isArray":false,"description":"A reference to the public id of the StudyOffering in RIO in case this enrollment is of the enrollmentType \u0060study\u0060"},{"fieldPath":"response.200.studyYear","name":"studyYear","dataType":"Integer","isRequired":false,"isArray":false,"description":"The study year of this object in case the enrollment is of the enrollmentType \u0027study\u0027\n\nExample values are:\n - Basisschool: 0, 1, 2, 3, 4, 5, 6, 7 or 8\n - VMBO: 1, 2, 3 or 4\n - HAVO: 1, 2, 3, 4 or 5\n - VWO: 1, 2, 3, 4, 5 or 6\n"},{"fieldPath":"response.200.location","name":"location","dataType":"Object","isRequired":false,"isArray":false,"description":"A reference to a Location of a School."},{"fieldPath":"response.200.location.locationMasterIdentifier","name":"locationMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for a Location. For Locations the \u0060Onderwijslocatie\u0060 aka \u0060OL_CODE\u0060 is used.\n(either locationMasterIdentifier or locationIds is required)\n"},{"fieldPath":"response.200.location.locationIds","name":"locationIds","dataType":"Array","isRequired":false,"isArray":true,"description":"A secondary identifier for the Location. For Locations the \u0060Vestigingserkenning\u0060 aka \u0060VE_CODE\u0060 is used.\nThis value is used whenever the primary identifier is not available.\n(either locationMasterIdentifier or locationIds is required)\n"},{"fieldPath":"response.200.location.locationIds[*]","name":"locationIds","dataType":"Object","isRequired":false,"isArray":false,"description":"A secondary identifier for the Location. For Locations the \u0060Vestigingserkenning\u0060 aka \u0060VE_CODE\u0060 is used.\nThis value is used whenever the primary identifier is not available.\n(either locationMasterIdentifier or locationIds is required)\n"},{"fieldPath":"response.200.location.locationIds[*].locationId","name":"locationId","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200.location.locationIds[*].locationIdType","name":"locationIdType","dataType":"Enum","isRequired":true,"isArray":false,"description":null,"allowedValues":["VE_CODE"]},{"fieldPath":"response.200.location.name","name":"name","dataType":"String","isRequired":true,"isArray":false,"description":"A name for the Location."},{"fieldPath":"response.200.subject","name":"subject","dataType":"Uuid","isRequired":false,"isArray":false,"description":"A reference to the subjectOfferingId of the SubjectOffering in case this enrollment is of the enrollmentType \u0060subject\u0060."},{"fieldPath":"response.200.schoolPeriod","name":"schoolPeriod","dataType":"String","isRequired":true,"isArray":false,"description":"A reference to the schoolPeriodId of the SchoolPeriod where this enrollment is part of."},{"fieldPath":"response.200.beginDate","name":"beginDate","dataType":"Date","isRequired":true,"isArray":false,"description":"The start date on which the enrollment becomes active (inclusive). Format: YYYY-MM-DD (according to RFC3339)."},{"fieldPath":"response.200.endDate","name":"endDate","dataType":"Date","isRequired":false,"isArray":false,"description":"The end date on which the enrollment becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339)."},{"fieldPath":"response.200.status","name":"status","dataType":"Enum","isRequired":true,"isArray":false,"description":"The status field gives an indication to Consumers about the status of an object.\nConsumers can delete objects that are flagged \u0060tobedeleted\u0060 as such if they wish.\n\nThe status attribute is based on the [Base Class from OneRoster](https://www.imsglobal.org/sites/default/files/spec/oneroster/v1p2/rostering-informationmodel/OneRosterv1p2RosteringService_InfoModelv1p0.html#Data_Base).\n","allowedValues":["active","tobedeleted"]},{"fieldPath":"response.200.dateCreated","name":"dateCreated","dataType":"DateTime","isRequired":true,"isArray":false,"description":"Indicates the date and time the object was first created. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6."},{"fieldPath":"response.200.dateLastModified","name":"dateLastModified","dataType":"DateTime","isRequired":true,"isArray":false,"description":"Indicates the date and time the object was last modified. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6."}]}
Wizardvragen JSON
?
Meer informatie
[ { "PlaceholderKey": "supplier.baseUrl", "AnswerKey": "supplier.baseUrl", "QuestionText": "What is the supplier base URL for this API?", "HelpText": "Enter the full base URL including the scheme, for example https://supplier.example.nl/api.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Url", "IsRequired": true, "AllowReuse": true, "SortOrder": 1, "Options": null, "Validation": null }, { "PlaceholderKey": "path.KVTGETENROLLMENTSSCHOOLID.id", "AnswerKey": "path.KVTGETENROLLMENTSSCHOOLID.id", "QuestionText": "Path parameter: id", "HelpText": "Reference to the enrollmentId of the Enrollment object.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": true, "AllowReuse": true, "SortOrder": 10, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETENROLLMENTSSCHOOLID.orgMasterId", "AnswerKey": "query.KVTGETENROLLMENTSSCHOOLID.orgMasterId", "QuestionText": "Query parameter: orgMasterId", "HelpText": "The organisationMasterIdentifier of the school.\nThis parameter is used when the primary identifier for a school (being the \u0060OnderwijsaanbiederId\u0060) is available.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 11, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETENROLLMENTSSCHOOLID.orgId", "AnswerKey": "query.KVTGETENROLLMENTSSCHOOLID.orgId", "QuestionText": "Query parameter: orgId", "HelpText": "The organisationIdentifier (secondary identifier) of the school.\nThis parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 12, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETENROLLMENTSSCHOOLID.orgIdType", "AnswerKey": "query.KVTGETENROLLMENTSSCHOOLID.orgIdType", "QuestionText": "Query parameter: orgIdType", "HelpText": "The type of the organisationIdentifier.\nThis parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.\nThe following values are supported:\n- \u0060OIE_CODE\u0060: OnderwijsInstellingserkenningcode\n- \u0060BP_ID\u0060: Basispoort-generated identifier for the school\n- \u0060DD_ID\u0060: DigiDeliveryId generated by the Central Registration of Edu-iX\n- \u0060AS_ID\u0060: LAS-generated identifier (LAS-Key) for the school\n- \u0060V_ID\u0060: VestigingsId \u2013 BRIN6-format identifier, including dummy locations", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Selection", "IsRequired": false, "AllowReuse": true, "SortOrder": 13, "Options": [ "OIE_CODE", "BP_ID", "DD_ID", "AS_ID", "V_ID" ], "Validation": null }, { "PlaceholderKey": "oauth.KVTGETENROLLMENTSSCHOOLID.tokenEndpoint", "AnswerKey": "oauth.KVTGETENROLLMENTSSCHOOLID.tokenEndpoint", "QuestionText": "OAuth token endpoint", "HelpText": "Supplier token endpoint used to request the bearer token for this API call.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Url", "IsRequired": true, "AllowReuse": true, "SortOrder": 14, "Options": null, "Validation": null } ]
Opslaan
Annuleren