Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETSUBJECTOFFERINGSSCHOOL
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 SubjectOffering objects for a specified School.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/subjectofferings/school","url":"{{supplier.baseUrl}}/subjectofferings/school","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.orgMasterId}}","orgId":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.orgId}}","orgIdType":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.orgIdType}}","filterByOrgId":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.filterByOrgId}}","subjectCode":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.subjectCode}}","studyOfferingId":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.studyOfferingId}}","schoolPeriodId":"{{query.KVTGETSUBJECTOFFERINGSSCHOOL.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 SubjectOfferings belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all SubjectOfferings\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only SubjectOfferings belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All SubjectOfferings 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.subjectCode","name":"subjectCode","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all SubjectOffering objects of a specified subjectCode."},{"fieldPath":"request.query.studyOfferingId","name":"studyOfferingId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all SubjectOffering objects offered within a Study and its corresponding studyOfferingId."},{"fieldPath":"request.query.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all SubjectOffering objects within a specified SchoolPeriod and its corresponding schoolPeriodId."}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETSUBJECTOFFERINGSSCHOOL.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":[{"subjectOfferingId":"11111111-1111-1111-1111-111111111111","subjectOfferingName":"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 SubjectOffering object with its identifiers, name, and metadata information."},{"fieldPath":"response.200[*].subjectOfferingId","name":"subjectOfferingId","dataType":"Uuid","isRequired":true,"isArray":false,"description":"A unique identifier for this SubjectOffering 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[*].subjectOfferingName","name":"subjectOfferingName","dataType":"String","isRequired":true,"isArray":false,"description":"The name given by the School to this SubjectOffering."},{"fieldPath":"response.200[*].subjectOfferingAbbr","name":"subjectOfferingAbbr","dataType":"String","isRequired":false,"isArray":false,"description":"Abbreviation of the SubjectOffering name."},{"fieldPath":"response.200[*].subjectCode","name":"subjectCode","dataType":"String","isRequired":false,"isArray":false,"description":"Official code of the subject.\n- primary education: the \u0060vakcode\u0060 as specified in [Waardenlijst Vakken po](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n- secondary education: the \u0060vakcode\u0060 as specified in [Waardenlijst Vakken vo](https://www.edustandaard.nl/standaard_werkgroepen/beheergroep-waardenlijsten-rio/) is used.\n\nNote: The value list is not yet available. As Edu-V we are working on a standardized list of subject codes in cooperation with the Edustandaard working committee.\n"},{"fieldPath":"response.200[*].studyOfferings","name":"studyOfferings","dataType":"Array","isRequired":false,"isArray":true,"description":null},{"fieldPath":"response.200[*].studyOfferings[*]","name":"studyOfferings","dataType":"String","isRequired":false,"isArray":false,"description":"Reference to a studyOfferingId of the StudyOffering object where this SubjectOffering is part of."},{"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.KVTGETSUBJECTOFFERINGSSCHOOL.orgMasterId", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.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.KVTGETSUBJECTOFFERINGSSCHOOL.orgId", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.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.KVTGETSUBJECTOFFERINGSSCHOOL.orgIdType", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.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.KVTGETSUBJECTOFFERINGSSCHOOL.filterByOrgId", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.filterByOrgId", "QuestionText": "Query parameter: filterByOrgId", "HelpText": "Controls whether the response is filtered to only include SubjectOfferings belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all SubjectOfferings\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only SubjectOfferings belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All SubjectOfferings 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.KVTGETSUBJECTOFFERINGSSCHOOL.subjectCode", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.subjectCode", "QuestionText": "Query parameter: subjectCode", "HelpText": "Optional filter to request all SubjectOffering objects of a specified subjectCode.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 14, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.studyOfferingId", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.studyOfferingId", "QuestionText": "Query parameter: studyOfferingId", "HelpText": "Optional filter to request all SubjectOffering objects offered within a Study and its corresponding studyOfferingId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 15, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.schoolPeriodId", "AnswerKey": "query.KVTGETSUBJECTOFFERINGSSCHOOL.schoolPeriodId", "QuestionText": "Query parameter: schoolPeriodId", "HelpText": "Optional filter to request all SubjectOffering objects within a specified SchoolPeriod and its corresponding schoolPeriodId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 16, "Options": null, "Validation": null }, { "PlaceholderKey": "oauth.KVTGETSUBJECTOFFERINGSSCHOOL.tokenEndpoint", "AnswerKey": "oauth.KVTGETSUBJECTOFFERINGSSCHOOL.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": 17, "Options": null, "Validation": null } ]
Opslaan
Annuleren