Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETSTUDENTSSCHOOL
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 all Student objects including basic information (identifiers and names) for a specified school.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/students/school","url":"{{supplier.baseUrl}}/students/school","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETSTUDENTSSCHOOL.orgMasterId}}","orgId":"{{query.KVTGETSTUDENTSSCHOOL.orgId}}","orgIdType":"{{query.KVTGETSTUDENTSSCHOOL.orgIdType}}","filterByOrgId":"{{query.KVTGETSTUDENTSSCHOOL.filterByOrgId}}","schoolPeriodId":"{{query.KVTGETSTUDENTSSCHOOL.schoolPeriodId}}","studyOfferingId":"{{query.KVTGETSTUDENTSSCHOOL.studyOfferingId}}","subjectOfferingId":"{{query.KVTGETSTUDENTSSCHOOL.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.\n\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 Students belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Students\nof the associated Onderwijsaanbieder are returned.\n\n- \u0060true\u0060: Only Students belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Students of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).\n\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.\n\nThis parameter is only relevant in combination with \u0060orgId\u0060 and \u0060orgIdType\u0060.\n When \u0060orgMasterId\u0060 is used, this parameter must be absent or \u0060false\u0060.\n\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.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all Student objects enrolled in 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 Student objects enrolled in a StudyOffering and its corresponding studyOfferingId."},{"fieldPath":"request.query.subjectOfferingId","name":"subjectOfferingId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request Student objects enrolled in a SubjectOffering and its corresponding subjectOfferingId."}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETSTUDENTSSCHOOL.tokenEndpoint}}","defaultTokenEndpoint":"https://api.example.com/oauth2/token","scopes":"eduv.student.basic eduv.student.demographics eduv.student.communication eduv.student.accessibility eduv.student.deliveryaddress","scheme":"OAuth2"}}
Expected result JSON
{"statusCode":200,"responseMustBeJson":true,"headers":{"Content-Type":"application/json"},"responseBody":[{"givenName":"Voorbeeldnaam","familyName":"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 Student object with its identifiers and name information.\n\nBased on the scopes additional attributes can be included in this object.\n\n### student.demographics\nDemographic data of a Student:\n- \u0060dateOfBirth\u0060\n- \u0060gender\u0060\n\n### student.communication\nCommunication data of the Student. For Students this is only the \u0060e-mail\u0060 address as provided by the School.\n\n### student.accessibility\n\u0060accessibility\u0060 and \u0060language\u0060 preferences for the Student. StudentAccessibility is an optional object for the Students API.\n- As an illustration the accessibility of AdditionalTestingTime is specified within this version.\n- Based on actual requirements from schools and suppliers, this list of preferences can be extended.\n- A possible next candidate might be the [Braille class](https://www.imsglobal.org/sites/default/files/spec/afa/3p0/information_model/imsafa3p0pnp_v1p0_InfoModel.html#Data_Braille).\n\n### student.deliveryaddress\nDelivery address data of a Student:\n- \u0060address\u0060\n- \u0060emailPrivate\u0060\n- \u0060emailsParents\u0060\n"},{"fieldPath":"response.200[*].userMasterIdentifier","name":"userMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for the Student.\nFor Students the ECK iD is used.\n"},{"fieldPath":"response.200[*].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.\n(either userMasterIdentifier or userIds is required)\n"},{"fieldPath":"response.200[*].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.\n(either userMasterIdentifier or userIds is required)\n"},{"fieldPath":"response.200[*].userIds[*].userId","name":"userId","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].userIds[*].userIdType","name":"userIdType","dataType":"Enum","isRequired":true,"isArray":false,"description":null,"allowedValues":["NEPPI","BPI","eduID","NEPRI","ASI"]},{"fieldPath":"response.200[*].givenName","name":"givenName","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].preferredFirstName","name":"preferredFirstName","dataType":"String","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].familyName","name":"familyName","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].familyNamePrefix","name":"familyNamePrefix","dataType":"String","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].dateOfBirth","name":"dateOfBirth","dataType":"Date","isRequired":false,"isArray":false,"description":"format: YYYY-MM-DD (according to RFC3339)"},{"fieldPath":"response.200[*].gender","name":"gender","dataType":"Enum","isRequired":false,"isArray":false,"description":"The gender of the Student. The following values are used:\n- \u0060female\u0060: gender is Female\n- \u0060male\u0060: gender is Male\n- \u0060other\u0060: gender that is known but which is not either Male or Female.\n- \u0060unspecified\u0060: unspecified as no data entry for this field has been made.\n","allowedValues":["female","male","other","unspecified"]},{"fieldPath":"response.200[*].email","name":"email","dataType":"String","isRequired":false,"isArray":false,"description":"E-mail address hosted by school (e.g. L123456@school.nl)."},{"fieldPath":"response.200[*].language","name":"language","dataType":"String","isRequired":false,"isArray":false,"description":"The language preference of the Student. Format according to [ISO639 Set 3 values](https://www.iso.org/standard/74575.html) for Language tags.\nOn [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) an example list can be found.\n"},{"fieldPath":"response.200[*].accessibility","name":"accessibility","dataType":"Array","isRequired":false,"isArray":true,"description":"Accessibility preferences for this student. Based on [IMS Global Access for All (AfA) Personal Needs and Preferences (PNP) Information model](https://www.imsglobal.org/sites/default/files/spec/afa/3p0/information_model/imsafa3p0pnp_v1p0_InfoModel.html)"},{"fieldPath":"response.200[*].accessibility[*]","name":"accessibility","dataType":"Object","isRequired":false,"isArray":false,"description":"The AdditionalTestingTime preference for a Student. Either \u0060time-multiplier\u0060, \u0060fixed-minutes\u0060 or \u0060unlimited\u0060 is used."},{"fieldPath":"response.200[*].accessibility[*].additionalTestingTime","name":"additionalTestingTime","dataType":"Object","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].accessibility[*].additionalTestingTime.time-multiplier","name":"time-multiplier","dataType":"Decimal","isRequired":false,"isArray":false,"description":"Providing the additional testing time as a multiplier of the set time."},{"fieldPath":"response.200[*].accessibility[*].additionalTestingTime.fixed-minutes","name":"fixed-minutes","dataType":"Integer","isRequired":false,"isArray":false,"description":"Providing the additional testing time as an additional number of minutes."},{"fieldPath":"response.200[*].accessibility[*].additionalTestingTime.unlimited","name":"unlimited","dataType":"String","isRequired":false,"isArray":false,"description":"Providing the additional testing time as an unlimited time."},{"fieldPath":"response.200[*].address","name":"address","dataType":"Object","isRequired":false,"isArray":false,"description":"The home address of the Student."},{"fieldPath":"response.200[*].address.street","name":"street","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].address.houseNumber","name":"houseNumber","dataType":"Integer","isRequired":true,"isArray":false,"description":"the house number"},{"fieldPath":"response.200[*].address.houseNumberSuffix","name":"houseNumberSuffix","dataType":"String","isRequired":false,"isArray":false,"description":"additions to the house number, e.g. A or -104"},{"fieldPath":"response.200[*].address.zipCode","name":"zipCode","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].address.city","name":"city","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].address.countryCode","name":"countryCode","dataType":"String","isRequired":false,"isArray":false,"description":"According to Alpha-2 code from ISO 3166, e.g. NL"},{"fieldPath":"response.200[*].address.country","name":"country","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].emailPrivate","name":"emailPrivate","dataType":"String","isRequired":false,"isArray":false,"description":"Private e-mail address of the student."},{"fieldPath":"response.200[*].emailsParents","name":"emailsParents","dataType":"Array","isRequired":false,"isArray":true,"description":null},{"fieldPath":"response.200[*].emailsParents[*]","name":"emailsParents","dataType":"String","isRequired":false,"isArray":false,"description":"E-mail address of a parent or the legal representative (e.g. guardian) of the Student."},{"fieldPath":"response.200[*].alias","name":"alias","dataType":"String","isRequired":false,"isArray":false,"description":"An additional field to distinct students on screen who carry the same name.\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.KVTGETSTUDENTSSCHOOL.orgMasterId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.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.KVTGETSTUDENTSSCHOOL.orgId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.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.KVTGETSTUDENTSSCHOOL.orgIdType", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.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.\n\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.KVTGETSTUDENTSSCHOOL.filterByOrgId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.filterByOrgId", "QuestionText": "Query parameter: filterByOrgId", "HelpText": "Controls whether the response is filtered to only include Students belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Students\nof the associated Onderwijsaanbieder are returned.\n\n- \u0060true\u0060: Only Students belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Students of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).\n\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.\n\nThis parameter is only relevant in combination with \u0060orgId\u0060 and \u0060orgIdType\u0060.\n When \u0060orgMasterId\u0060 is used, this parameter must be absent or \u0060false\u0060.\n\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.KVTGETSTUDENTSSCHOOL.schoolPeriodId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.schoolPeriodId", "QuestionText": "Query parameter: schoolPeriodId", "HelpText": "Optional filter to request all Student objects enrolled in a specified SchoolPeriod and its corresponding schoolPeriodId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 14, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDENTSSCHOOL.studyOfferingId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.studyOfferingId", "QuestionText": "Query parameter: studyOfferingId", "HelpText": "Optional filter to request all Student objects enrolled in a StudyOffering and its corresponding studyOfferingId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 15, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSTUDENTSSCHOOL.subjectOfferingId", "AnswerKey": "query.KVTGETSTUDENTSSCHOOL.subjectOfferingId", "QuestionText": "Query parameter: subjectOfferingId", "HelpText": "Optional filter to request Student objects enrolled in a SubjectOffering and its corresponding subjectOfferingId.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 16, "Options": null, "Validation": null }, { "PlaceholderKey": "oauth.KVTGETSTUDENTSSCHOOL.tokenEndpoint", "AnswerKey": "oauth.KVTGETSTUDENTSSCHOOL.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