Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETGROUPSSCHOOL
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 Group objects for a specified School.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/groups/school","url":"{{supplier.baseUrl}}/groups/school","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETGROUPSSCHOOL.orgMasterId}}","orgId":"{{query.KVTGETGROUPSSCHOOL.orgId}}","orgIdType":"{{query.KVTGETGROUPSSCHOOL.orgIdType}}","filterByOrgId":"{{query.KVTGETGROUPSSCHOOL.filterByOrgId}}","groupType":"{{query.KVTGETGROUPSSCHOOL.groupType}}","schoolPeriodId":"{{query.KVTGETGROUPSSCHOOL.schoolPeriodId}}","studyOfferingId":"{{query.KVTGETGROUPSSCHOOL.studyOfferingId}}","subjectOfferingId":"{{query.KVTGETGROUPSSCHOOL.subjectOfferingId}}"},"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 Groups belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Groups\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only Groups belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Groups 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.groupType","name":"groupType","dataType":"Enum","isRequired":false,"isArray":false,"description":"Optional filter to request all Group objects for a specified groupType.","allowedValues":["class","lesson-group"]},{"fieldPath":"request.query.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all Group objects within a specified SchoolPeriod and its corresponding schoolPeriodId."},{"fieldPath":"request.query.studyOfferingId","name":"studyOfferingId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all Group objects for a StudyOffering and its corresponding studyOfferingId."},{"fieldPath":"request.query.subjectOfferingId","name":"subjectOfferingId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all Group objects for a SubjectOffering and its corresponding subjectOfferingId."}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETGROUPSSCHOOL.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":[{"groupId":"3EFDC9BE-9127-4008-8809-8A24165315AF","groupName":"Voorbeeldnaam","groupType":"class","students":[{"userMasterIdentifier":"SAMPLE-ID-001","userIds":[{"userId":"SAMPLE-ID-001","userIdType":"NEPPI"}]}],"assignments":["sample-value"],"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":"Array","isRequired":false,"isArray":true,"description":"OK"},{"fieldPath":"response.200[*]","name":"response 200","dataType":"Object","isRequired":false,"isArray":false,"description":"The Group object in which Students follow their education and Employees are assigned to within a SchoolPeriod."},{"fieldPath":"response.200[*].groupId","name":"groupId","dataType":"String","isRequired":true,"isArray":false,"description":"A unique identifier for this Group 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[*].groupName","name":"groupName","dataType":"String","isRequired":true,"isArray":false,"description":"The name of this Group."},{"fieldPath":"response.200[*].groupType","name":"groupType","dataType":"Enum","isRequired":true,"isArray":false,"description":"The type of group, being one of:\n- class: a \u0060stamgroep\u0060 where students are rostered into for their StudyOffering(s)\n- lesson-group: a \u0060lesgroep\u0060 where students are rostered into to follow a SubjectOffering.\n","allowedValues":["class","lesson-group"]},{"fieldPath":"response.200[*].students","name":"students","dataType":"Array","isRequired":true,"isArray":true,"description":"The Students which are member of this group."},{"fieldPath":"response.200[*].students[*]","name":"students","dataType":"Object","isRequired":true,"isArray":false,"description":"The Students which are member of this group."},{"fieldPath":"response.200[*].students[*].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[*].students[*].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[*].students[*].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[*].students[*].userIds[*].userId","name":"userId","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].students[*].userIds[*].userIdType","name":"userIdType","dataType":"Enum","isRequired":true,"isArray":false,"description":null,"allowedValues":["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]},{"fieldPath":"response.200[*].assignments","name":"assignments","dataType":"Array","isRequired":true,"isArray":true,"description":"The Assignments of Employees that are assigned to this group."},{"fieldPath":"response.200[*].assignments[*]","name":"assignments","dataType":"String","isRequired":true,"isArray":false,"description":"A reference to the assignmentId of the Assignment for this group."},{"fieldPath":"response.200[*].schoolPeriod","name":"schoolPeriod","dataType":"String","isRequired":true,"isArray":false,"description":"A reference to the schoolPeriodId of the SchoolPeriod where this group is part of."},{"fieldPath":"response.200[*].beginDate","name":"beginDate","dataType":"Date","isRequired":true,"isArray":false,"description":"The start date on which the group 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 group 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": "query.KVTGETGROUPSSCHOOL.orgMasterId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.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.KVTGETGROUPSSCHOOL.orgId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.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.KVTGETGROUPSSCHOOL.orgIdType", "AnswerKey": "query.KVTGETGROUPSSCHOOL.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.KVTGETGROUPSSCHOOL.filterByOrgId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.filterByOrgId", "QuestionText": "Query parameter: filterByOrgId", "HelpText": "Controls whether the response is filtered to only include Groups belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Groups\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only Groups belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Groups 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.KVTGETGROUPSSCHOOL.groupType", "AnswerKey": "query.KVTGETGROUPSSCHOOL.groupType", "QuestionText": "Query parameter: groupType", "HelpText": "Optional filter to request all Group objects for a specified groupType.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Selection", "IsRequired": false, "AllowReuse": true, "SortOrder": 14, "Options": [ "class", "lesson-group" ], "Validation": null }, { "PlaceholderKey": "query.KVTGETGROUPSSCHOOL.schoolPeriodId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.schoolPeriodId", "QuestionText": "Query parameter: schoolPeriodId", "HelpText": "Optional filter to request all Group 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": "query.KVTGETGROUPSSCHOOL.studyOfferingId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.studyOfferingId", "QuestionText": "Query parameter: studyOfferingId", "HelpText": "Optional filter to request all Group objects for a StudyOffering and its corresponding studyOfferingId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 16, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETGROUPSSCHOOL.subjectOfferingId", "AnswerKey": "query.KVTGETGROUPSSCHOOL.subjectOfferingId", "QuestionText": "Query parameter: subjectOfferingId", "HelpText": "Optional filter to request all Group objects for a SubjectOffering and its corresponding subjectOfferingId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 17, "Options": null, "Validation": null }, { "PlaceholderKey": "oauth.KVTGETGROUPSSCHOOL.tokenEndpoint", "AnswerKey": "oauth.KVTGETGROUPSSCHOOL.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": 18, "Options": null, "Validation": null } ]
Opslaan
Annuleren