Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETSTUDYOFFERINGSSCHOOL
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 StudyOffering objects for a specified School.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/studyofferings/school","url":"{{supplier.baseUrl}}/studyofferings/school","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.orgMasterId}}","orgId":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.orgId}}","orgIdType":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.orgIdType}}","filterByOrgId":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.filterByOrgId}}","studyCode":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.studyCode}}","schoolPeriodId":"{{query.KVTGETSTUDYOFFERINGSSCHOOL.schoolPeriodId}}"},"requestFieldSpecifications":[{"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"]},{"fieldPath":"request.query.filterByOrgId","name":"filterByOrgId","dataType":"Boolean","isRequired":false,"isArray":false,"description":"Controls whether the response is filtered to only include StudyOfferings belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all StudyOfferings\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only StudyOfferings belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All StudyOfferings of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).\nWhen omitted, a sector-specific default applies:\n- **PO (primary education):** defaults to \u0060true\u0060 \u2013 response is filtered to the specified identifier.\n- **VO (secondary education):** defaults to \u0060false\u0060 \u2013 response covers the full Onderwijsaanbieder scope.\nThis parameter is only relevant in combination with \u0060orgId\u0060 and \u0060orgIdType\u0060.\nWhen \u0060orgMasterId\u0060 is used, this parameter must be absent or \u0060false\u0060.\nIt is the responsibility of the consuming party to verify whether the Source supports\nfiltering via this parameter before using it.\n"},{"fieldPath":"request.query.studyCode","name":"studyCode","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all StudyOffering objects of a specified studyCode."},{"fieldPath":"request.query.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all StudyOffering objects within a specified SchoolPeriod and its corresponding schoolPeriodId."}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETSTUDYOFFERINGSSCHOOL.tokenEndpoint}}","defaultTokenEndpoint":"https://api.example.com/oauth2/token","scopes":"eduv.education","scheme":"OAuth2"}}
Expected result JSON
{"statusCode":200,"responseMustBeJson":true,"headers":{"Content-Type":"application/json"},"responseBody":[{"studyOfferingId":"11111111-1111-1111-1111-111111111111","studyOfferingName":"Voorbeeldnaam","status":"active","dateCreated":"2017-07-21T17:32:28Z","dateLastModified":"2022-08-11T15:31:12Z"}],"responseFieldSpecifications":[{"fieldPath":"response.200","name":"response 200","dataType":"Array","isRequired":false,"isArray":true,"description":"OK"},{"fieldPath":"response.200[*]","name":"response 200","dataType":"Object","isRequired":false,"isArray":false,"description":"The StudyOffering object with its identifiers, name, and metadata information."},{"fieldPath":"response.200[*].studyOfferingId","name":"studyOfferingId","dataType":"Uuid","isRequired":true,"isArray":false,"description":"A unique identifier for this StudyOffering 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[*].studyOfferingName","name":"studyOfferingName","dataType":"String","isRequired":true,"isArray":false,"description":"The name given by the School for this StudyOffering."},{"fieldPath":"response.200[*].studyName","name":"studyName","dataType":"String","isRequired":false,"isArray":false,"description":"Official name of the study.\n- primary education: the \u0060po-opleidingseenheden in RIO korte naam\u0060 name as specified in [Waardenlijst Opleidingseenheden po](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n- secondary education: the \u0060vo-opleidingseenheden in RIO korte naam\u0060 name as specified in [Waardenlijst Opleidingseenheden vo](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n"},{"fieldPath":"response.200[*].studyCode","name":"studyCode","dataType":"String","isRequired":false,"isArray":false,"description":"Accepteert 4 cijfers (0011) of 4 cijfers, een \u0027O\u0027, en weer 4 cijfers (1000O0020).\nPrimair onderwijs (BO \u0026 SO): opleidingseenheid code (9 karakters) conform waardelijst RIO po https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/\nVoortgezet onderwijs (VO \u0026 VSO): erkende opleidingscode (4 karakters) conform Regeling Codetabellen VO, VSO en MBO https://wetten.overheid.nl/BWBR0048579/2025-08-28/?g=2025-08-28\u0026z=2025-08-28#BijlageIa\n","pattern":"^(\\d{4}|\\d{4}O\\d{4})$"},{"fieldPath":"response.200[*].studyCharacteristics","name":"studyCharacteristics","dataType":"Array","isRequired":false,"isArray":true,"description":"Official characteristic of the study.\n- primary education: the \u0060po-opleidingskenmerken\u0060 name as specified in [Waardenlijst Opleidingseenheden po](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n- secondary education: the \u0060vo-opleidingskenmerken\u0060 name as specified in [Waardenlijst Opleidingseenheden vo](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n"},{"fieldPath":"response.200[*].studyCharacteristics[*]","name":"studyCharacteristics","dataType":"String","isRequired":false,"isArray":false,"description":"Official characteristic of the study.\n- primary education: the \u0060po-opleidingskenmerken\u0060 name as specified in [Waardenlijst Opleidingseenheden po](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n- secondary education: the \u0060vo-opleidingskenmerken\u0060 name as specified in [Waardenlijst Opleidingseenheden vo](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n"},{"fieldPath":"response.200[*].studyLevel","name":"studyLevel","dataType":"Object","isRequired":false,"isArray":false,"description":"Official level of the study.\nPrimary and secondary education studyLevels are based on the \u0060Niveau\u0060 as specified in [SLO curriculum](https://opendata.slo.nl/curriculum/2023/api/v1/niveau/)\n"},{"fieldPath":"response.200[*].studyLevel.studyLevelId","name":"studyLevelId","dataType":"String","isRequired":false,"isArray":false,"description":"The uuid of the level.","pattern":"^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$"},{"fieldPath":"response.200[*].studyLevel.studyLevelPrefix","name":"studyLevelPrefix","dataType":"String","isRequired":false,"isArray":false,"description":"The prefix of the level","pattern":"^[0-9]*$","minLength":4,"maxLength":4},{"fieldPath":"response.200[*].studyLevel.studyLevelName","name":"studyLevelName","dataType":"String","isRequired":false,"isArray":false,"description":"The name of the level."},{"fieldPath":"response.200[*].studyYear","name":"studyYear","dataType":"Integer","isRequired":false,"isArray":false,"description":"The study year of this object.\n\nExample values are:\n- Basisschool: 0, 1, 2, 3, 4, 5, 6, 7 or 8\n- VMBO: 0, 1, 2, 3 or 4\n- HAVO: 0, 1, 2, 3, 4 or 5\n- VWO: 0, 1, 2, 3, 4, 5 or 6\n"},{"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": "query.KVTGETSTUDYOFFERINGSSCHOOL.orgMasterId", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.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": 10, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.orgId", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.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": 11, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.orgIdType", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.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": 12, "Options": [ "OIE_CODE", "BP_ID", "DD_ID", "AS_ID", "V_ID" ], "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.filterByOrgId", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.filterByOrgId", "QuestionText": "Query parameter: filterByOrgId", "HelpText": "Controls whether the response is filtered to only include StudyOfferings belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all StudyOfferings\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only StudyOfferings belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All StudyOfferings of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).\nWhen omitted, a sector-specific default applies:\n- **PO (primary education):** defaults to \u0060true\u0060 \u2013 response is filtered to the specified identifier.\n- **VO (secondary education):** defaults to \u0060false\u0060 \u2013 response covers the full Onderwijsaanbieder scope.\nThis parameter is only relevant in combination with \u0060orgId\u0060 and \u0060orgIdType\u0060.\nWhen \u0060orgMasterId\u0060 is used, this parameter must be absent or \u0060false\u0060.\nIt is the responsibility of the consuming party to verify whether the Source supports\nfiltering via this parameter before using it.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Boolean", "IsRequired": false, "AllowReuse": true, "SortOrder": 13, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.studyCode", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.studyCode", "QuestionText": "Query parameter: studyCode", "HelpText": "Optional filter to request all StudyOffering objects of a specified studyCode.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 14, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.schoolPeriodId", "AnswerKey": "query.KVTGETSTUDYOFFERINGSSCHOOL.schoolPeriodId", "QuestionText": "Query parameter: schoolPeriodId", "HelpText": "Optional filter to request all StudyOffering objects within a specified SchoolPeriod and its corresponding schoolPeriodId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 15, "Options": null, "Validation": null }, { "PlaceholderKey": "oauth.KVTGETSTUDYOFFERINGSSCHOOL.tokenEndpoint", "AnswerKey": "oauth.KVTGETSTUDYOFFERINGSSCHOOL.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": 16, "Options": null, "Validation": null } ]
Opslaan
Annuleren