Edu-V portaal (beheer)
Gerrit Bergsma
Beheer
Gebruikers
Deelnemers
Onderhoud
Privacy
Testcases
KVTGETEMPLOYEESSCHOOL
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 Employee objects including basic information (identifiers and names) for a specified school.
Regressietest
Handmatige testcase
Action JSON
{"method":"GET","path":"/employees/school","url":"{{supplier.baseUrl}}/employees/school","headers":{"Accept":"application/json"},"query":{"orgMasterId":"{{query.KVTGETEMPLOYEESSCHOOL.orgMasterId}}","orgId":"{{query.KVTGETEMPLOYEESSCHOOL.orgId}}","orgIdType":"{{query.KVTGETEMPLOYEESSCHOOL.orgIdType}}","filterByOrgId":"{{query.KVTGETEMPLOYEESSCHOOL.filterByOrgId}}","schoolPeriodId":"{{query.KVTGETEMPLOYEESSCHOOL.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 Employees belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Employees\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only Employees belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Employees 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.schoolPeriodId","name":"schoolPeriodId","dataType":"String","isRequired":false,"isArray":false,"description":"Optional filter to request all Employee objects within a specified SchoolPeriod and its corresponding schoolPeriodId."}],"oauth":{"tokenEndpoint":"{{oauth.KVTGETEMPLOYEESSCHOOL.tokenEndpoint}}","defaultTokenEndpoint":"https://api.example.com/oauth2/token","scopes":"eduv.employee.basic eduv.employee.communication eduv.employee.roles","scheme":"OAuth2"}}
Expected result JSON
{"statusCode":200,"responseMustBeJson":true,"headers":{"Content-Type":"application/json"},"responseBody":[{"userIds":[{"userId":"SAMPLE-ID-001","userIdType":"NEPPI"}],"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 Employee object with its identifiers and name information.\n\nBased on the scopes additional attributes can be included in this object.\n\n### employee.communication\nCommunication data of the Employee. For Employees this is the \u0060e-mail\u0060 address, \u0060phone\u0060 number or \u0060mobile\u0060 phone number as provided by the School.\n\n### employee.roles\n\u0060organisationRoles\u0060 of the Employee within the school.\n"},{"fieldPath":"response.200[*].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[*].userIds","name":"userIds","dataType":"Array","isRequired":true,"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[*].userIds[*]","name":"userIds","dataType":"Object","isRequired":true,"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[*].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","eckId"]},{"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[*].email","name":"email","dataType":"String","isRequired":false,"isArray":false,"description":"E-mail address hosted by school (e.g. L123456@school.nl)."},{"fieldPath":"response.200[*].phone","name":"phone","dataType":"String","isRequired":false,"isArray":false,"description":"Phone number as provided by the school."},{"fieldPath":"response.200[*].mobile","name":"mobile","dataType":"String","isRequired":false,"isArray":false,"description":"Mobile phone number as provided by the school."},{"fieldPath":"response.200[*].organisationRoles","name":"organisationRoles","dataType":"Array","isRequired":false,"isArray":true,"description":"The organisation roles the Employee has within the organisation."},{"fieldPath":"response.200[*].organisationRoles[*]","name":"organisationRoles","dataType":"Object","isRequired":false,"isArray":false,"description":"The organisation roles the Employee has within the organisation."},{"fieldPath":"response.200[*].organisationRoles[*].organisation","name":"organisation","dataType":"Object","isRequired":true,"isArray":false,"description":"A reference to a School organisation."},{"fieldPath":"response.200[*].organisationRoles[*].organisation.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[*].organisationRoles[*].organisation.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[*].organisationRoles[*].organisation.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[*].organisationRoles[*].organisation.organisationIds[*].organisationId","name":"organisationId","dataType":"String","isRequired":true,"isArray":false,"description":null},{"fieldPath":"response.200[*].organisationRoles[*].organisation.organisationIds[*].organisationIdType","name":"organisationIdType","dataType":"Enum","isRequired":true,"isArray":false,"description":null,"allowedValues":["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]},{"fieldPath":"response.200[*].organisationRoles[*].organisationRole","name":"organisationRole","dataType":"Enum","isRequired":true,"isArray":false,"description":"The organisation role the Employee has within the organisation.","allowedValues":["administratief-medewerker","applicatiebeheerder","begeleider","invalkracht","ibp-er","leermiddelencoordinator","leraar","mentor","onderwijsbestuurder","onderwijsdirecteur","stagiair"]},{"fieldPath":"response.200[*].organisationRoles[*].beginDate","name":"beginDate","dataType":"Date","isRequired":true,"isArray":false,"description":"The start date on which the role becomes active (inclusive). Format: YYYY-MM-DD (according to RFC3339)."},{"fieldPath":"response.200[*].organisationRoles[*].endDate","name":"endDate","dataType":"Date","isRequired":false,"isArray":false,"description":"The end date on which the role becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339)."},{"fieldPath":"response.200[*].alias","name":"alias","dataType":"String","isRequired":false,"isArray":false,"description":"An additional field to distinct employees 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: Conform openapi in ZULU time zoals gespecificeerd 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: Conform openapi in ZULU time zoals gespecificeerd 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.KVTGETEMPLOYEESSCHOOL.orgMasterId", "AnswerKey": "query.KVTGETEMPLOYEESSCHOOL.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.KVTGETEMPLOYEESSCHOOL.orgId", "AnswerKey": "query.KVTGETEMPLOYEESSCHOOL.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.KVTGETEMPLOYEESSCHOOL.orgIdType", "AnswerKey": "query.KVTGETEMPLOYEESSCHOOL.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.KVTGETEMPLOYEESSCHOOL.filterByOrgId", "AnswerKey": "query.KVTGETEMPLOYEESSCHOOL.filterByOrgId", "QuestionText": "Query parameter: filterByOrgId", "HelpText": "Controls whether the response is filtered to only include Employees belonging to the\nspecific organisation identified by \u0060orgId\u0060 and \u0060orgIdType\u0060, or whether all Employees\nof the associated Onderwijsaanbieder are returned.\n- \u0060true\u0060: Only Employees belonging to the specified secondary identifier are returned.\n- \u0060false\u0060: All Employees 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.KVTGETEMPLOYEESSCHOOL.schoolPeriodId", "AnswerKey": "query.KVTGETEMPLOYEESSCHOOL.schoolPeriodId", "QuestionText": "Query parameter: schoolPeriodId", "HelpText": "Optional filter to request all Employee objects within 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": "oauth.KVTGETEMPLOYEESSCHOOL.tokenEndpoint", "AnswerKey": "oauth.KVTGETEMPLOYEESSCHOOL.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": 15, "Options": null, "Validation": null } ]
Opslaan
Annuleren