Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETORGANISATIONS
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 registered Organisation objects based on the specified School. This endpoint can be used to gather all relevant organisations within the `Administratiesysteem onderwijsdeelnemer` for the specified school of board.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/organisations","url":"{{supplier.baseUrl}}/organisations","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETORGANISATIONS.orgMasterId}}","orgId":"{{query.KVTGETORGANISATIONS.orgId}}","orgIdType":"{{query.KVTGETORGANISATIONS.orgIdType}}","boardMasterId":"{{query.KVTGETORGANISATIONS.boardMasterId}}","boardId":"{{query.KVTGETORGANISATIONS.boardId}}","boardIdType":"{{query.KVTGETORGANISATIONS.boardIdType}}","name":"{{query.KVTGETORGANISATIONS.name}}"},"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.boardMasterId","name":"boardMasterId","dataType":"String","isRequired":false,"isArray":false,"description":"The organisationMasterIdentifier of the Board.\nThis parameter is used when the primary identifier for a board (being the \u0060OnderwijsbestuurId\u0060) is available.\n"},{"fieldPath":"request.query.boardId","name":"boardId","dataType":"String","isRequired":false,"isArray":false,"description":"The boardIdentifier (secondary identifier) of a board.\nThis parameter is used in combination with the boardIdType when the organisationMasterIdentifier of the Board is not available.\n"},{"fieldPath":"request.query.boardIdType","name":"boardIdType","dataType":"Enum","isRequired":false,"isArray":false,"description":"The type of the boardIdentifier.\nThis parameter is used in combination with the boardId when the organisationMasterIdentifier of the Board is not available.\n","allowedValues":["BGE_CODE"]},{"fieldPath":"request.query.name","name":"name","dataType":"String","isRequired":false,"isArray":false,"description":"The name of the school.\n"}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETORGANISATIONS.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":[{"name":"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 Organisation object with its identifiers, name, board and locations information."},{"fieldPath":"response.200[*].organisationMasterIdentifier","name":"organisationMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for a School. For Schools the \u0060OnderwijsaanbiederId\u0060 is used.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].organisationIds","name":"organisationIds","dataType":"Array","isRequired":false,"isArray":true,"description":"A secondary identifier for the School. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].organisationIds[*]","name":"organisationIds","dataType":"Object","isRequired":false,"isArray":false,"description":"A secondary identifier for the School. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].organisationIds[*].organisationId","name":"organisationId","dataType":"String","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].organisationIds[*].organisationIdType","name":"organisationIdType","dataType":"Enum","isRequired":false,"isArray":false,"description":null,"allowedValues":["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]},{"fieldPath":"response.200[*].name","name":"name","dataType":"String","isRequired":true,"isArray":false,"description":"The name of the School."},{"fieldPath":"response.200[*].boards","name":"boards","dataType":"Array","isRequired":false,"isArray":true,"description":"The Boards this School belongs to."},{"fieldPath":"response.200[*].boards[*]","name":"boards","dataType":"Object","isRequired":false,"isArray":false,"description":"A reference to a School Board organisation."},{"fieldPath":"response.200[*].boards[*].organisationMasterIdentifier","name":"organisationMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for a School Board. For boards the \u0060OnderwijsbestuurId\u0060 is used.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].boards[*].organisationIds","name":"organisationIds","dataType":"Array","isRequired":false,"isArray":true,"description":"A secondary identifier for the School Board. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].boards[*].organisationIds[*]","name":"organisationIds","dataType":"Object","isRequired":false,"isArray":false,"description":"A secondary identifier for the School Board. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].boards[*].organisationIds[*].organisationId","name":"organisationId","dataType":"String","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].boards[*].organisationIds[*].organisationIdType","name":"organisationIdType","dataType":"Enum","isRequired":false,"isArray":false,"description":null,"allowedValues":["BGE_CODE"]},{"fieldPath":"response.200[*].boards[*].name","name":"name","dataType":"String","isRequired":false,"isArray":false,"description":"The name of the School Board."},{"fieldPath":"response.200[*].locations","name":"locations","dataType":"Array","isRequired":false,"isArray":true,"description":"A list of all school locations of this organisation."},{"fieldPath":"response.200[*].locations[*]","name":"locations","dataType":"Object","isRequired":false,"isArray":false,"description":"A reference to a School location."},{"fieldPath":"response.200[*].locations[*].locationMasterIdentifier","name":"locationMasterIdentifier","dataType":"String","isRequired":false,"isArray":false,"description":"The primary identifier for the School location. For School locations the \u0060Onderwijslocatiecode\u0060 is used.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].locations[*].locationIds","name":"locationIds","dataType":"Array","isRequired":false,"isArray":true,"description":"A secondary identifier for the School location. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].locations[*].locationIds[*]","name":"locationIds","dataType":"Object","isRequired":false,"isArray":false,"description":"A secondary identifier for the School location. This value is used whenever the primary identifier is not available.\n(either organisationMasterIdentifier or organisationIds is required)\n"},{"fieldPath":"response.200[*].locations[*].locationIds[*].locationId","name":"locationId","dataType":"String","isRequired":false,"isArray":false,"description":null},{"fieldPath":"response.200[*].locations[*].locationIds[*].locationIdType","name":"locationIdType","dataType":"Enum","isRequired":false,"isArray":false,"description":null,"allowedValues":["VE_CODE"]},{"fieldPath":"response.200[*].locations[*].name","name":"name","dataType":"String","isRequired":false,"isArray":false,"description":"The name of the School location."},{"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 first created. 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.KVTGETORGANISATIONS.orgMasterId", "AnswerKey": "query.KVTGETORGANISATIONS.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.KVTGETORGANISATIONS.orgId", "AnswerKey": "query.KVTGETORGANISATIONS.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.KVTGETORGANISATIONS.orgIdType", "AnswerKey": "query.KVTGETORGANISATIONS.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.KVTGETORGANISATIONS.boardMasterId", "AnswerKey": "query.KVTGETORGANISATIONS.boardMasterId", "QuestionText": "Query parameter: boardMasterId", "HelpText": "The organisationMasterIdentifier of the Board.\nThis parameter is used when the primary identifier for a board (being the \u0060OnderwijsbestuurId\u0060) is available.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 13, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETORGANISATIONS.boardId", "AnswerKey": "query.KVTGETORGANISATIONS.boardId", "QuestionText": "Query parameter: boardId", "HelpText": "The boardIdentifier (secondary identifier) of a board.\nThis parameter is used in combination with the boardIdType when the organisationMasterIdentifier of the Board is not available.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 14, "Options": null, "Validation": null }, { "PlaceholderKey": "query.KVTGETORGANISATIONS.boardIdType", "AnswerKey": "query.KVTGETORGANISATIONS.boardIdType", "QuestionText": "Query parameter: boardIdType", "HelpText": "The type of the boardIdentifier.\nThis parameter is used in combination with the boardId when the organisationMasterIdentifier of the Board is not available.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Selection", "IsRequired": false, "AllowReuse": true, "SortOrder": 15, "Options": [ "BGE_CODE" ], "Validation": null }, { "PlaceholderKey": "query.KVTGETORGANISATIONS.name", "AnswerKey": "query.KVTGETORGANISATIONS.name", "QuestionText": "Query parameter: name", "HelpText": "The name of the school.", "GroupName": null, "TargetTransactionRole": null, "TargetVersion": null, "FieldType": "Text", "IsRequired": false, "AllowReuse": true, "SortOrder": 16, "Options": null, "Validation": null }, { "PlaceholderKey": "oauth.KVTGETORGANISATIONS.tokenEndpoint", "AnswerKey": "oauth.KVTGETORGANISATIONS.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