Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETSCHOOLPERIODSSCHOOLID
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 a SchoolPeriod object based on its schoolPeriodId.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/schoolperiods/school/{{path.KVTGETSCHOOLPERIODSSCHOOLID.id}}","url":"{{supplier.baseUrl}}/schoolperiods/school/{{path.KVTGETSCHOOLPERIODSSCHOOLID.id}}","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETSCHOOLPERIODSSCHOOLID.orgMasterId}}","orgId":"{{query.KVTGETSCHOOLPERIODSSCHOOLID.orgId}}","orgIdType":"{{query.KVTGETSCHOOLPERIODSSCHOOLID.orgIdType}}"},"requestFieldSpecifications":[{"fieldPath":"request.path.id","name":"id","dataType":"String","isRequired":true,"isArray":false,"description":"Reference to the schoolPeriodId of the SchoolPeriod 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.KVTGETSCHOOLPERIODSSCHOOLID.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":{"schoolPeriodId":"SAMPLE-ID-001","title":"2024-2025","startDate":"2024-08-31","endDate":"2025-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 SchoolPeriod object with its title startDate and endDate."},{"fieldPath":"response.200.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":true,"isArray":false,"description":"A unique identifier for this SchoolPeriod object.\nFor a full schoolyear this identifier has the format \u0022beginyear-endyear\u0022, for example \u00222024-2025\u0022. Otherwise this identifier is a UUID.\nThis is the UUID that Consumers will refer to when making API calls, or when needing to identify an object.\n"},{"fieldPath":"response.200.title","name":"title","dataType":"String","isRequired":true,"isArray":false,"description":"The name of the SchoolPeriod."},{"fieldPath":"response.200.type","name":"type","dataType":"Enum","isRequired":false,"isArray":false,"description":"The type of SchoolPeriod. An enumerated value is used:\n- gradingPeriod: Denotes a period over which some grade/result is to be awarded.\n- schoolYear: Denotes the school year.\n- semester: Denotes a semester period. Typically there are two semesters per schoolYear.\n- term: Denotes a term period. Typically there are three terms per schoolYear.\n\nENUM values are corresponding the OneRoster [AcademicSession SessionType](https://www.imsglobal.org/sites/default/files/spec/oneroster/v1p2/rostering-informationmodel/OneRosterv1p2RosteringService_InfoModelv1p0.html#Union_SessionTypeEnumExt).\n","allowedValues":["gradingPeriod","schoolYear","semester","term"]},{"fieldPath":"response.200.superSchoolPeriod","name":"superSchoolPeriod","dataType":"String","isRequired":false,"isArray":false,"description":"The link to a hierarchically higher Schoolperiod object. For example for a semester this is the schoolYear."},{"fieldPath":"response.200.subSchoolPeriods","name":"subSchoolPeriods","dataType":"Array","isRequired":false,"isArray":true,"description":"The link to hierarchically lower Schoolperiod objects. For example for a schoolYear these are its semesters."},{"fieldPath":"response.200.subSchoolPeriods[*]","name":"subSchoolPeriods","dataType":"String","isRequired":false,"isArray":false,"description":"The link to a child Schoolperiod object. For example for a schoolYear this is the semester."},{"fieldPath":"response.200.startDate","name":"startDate","dataType":"Date","isRequired":true,"isArray":false,"description":"The start date for the SchoolPeriod (inclusive). Format: YYYY-MM-DD (according to RFC3339)."},{"fieldPath":"response.200.endDate","name":"endDate","dataType":"Date","isRequired":true,"isArray":false,"description":"The end date for the SchoolPeriod (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.KVTGETSCHOOLPERIODSSCHOOLID.id", "AnswerKey": "path.KVTGETSCHOOLPERIODSSCHOOLID.id", "QuestionText": "Path parameter: id", "HelpText": "Reference to the schoolPeriodId of the SchoolPeriod object.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": true, "AllowReuse": true, "SortOrder": 10, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETSCHOOLPERIODSSCHOOLID.orgMasterId", "AnswerKey": "query.KVTGETSCHOOLPERIODSSCHOOLID.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.KVTGETSCHOOLPERIODSSCHOOLID.orgId", "AnswerKey": "query.KVTGETSCHOOLPERIODSSCHOOLID.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.KVTGETSCHOOLPERIODSSCHOOLID.orgIdType", "AnswerKey": "query.KVTGETSCHOOLPERIODSSCHOOLID.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.KVTGETSCHOOLPERIODSSCHOOLID.tokenEndpoint", "AnswerKey": "oauth.KVTGETSCHOOLPERIODSSCHOOLID.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