/enrollments/school - Association (P) - Edu-V Compliance Testlab

Veldspecificaties

46 items

Veld	Beschrijving	Type	Verplicht	Beperkingen
`request.query.orgMasterId`	orgMasterId	Tekenreeks	Nee	-
`request.query.orgId`	orgId	Tekenreeks	Nee	-
`request.query.orgIdType`	orgIdType	Keuzelijst	Nee	-
`request.query.filterByOrgId`	filterByOrgId	Boolean	Nee	-
`request.query.enrollmentType`	enrollmentType	Keuzelijst	Nee	-
`request.query.schoolPeriodId`	schoolPeriodId	Tekenreeks	Nee	-
`request.query.studyOfferingId`	studyOfferingId	Tekenreeks	Nee	-
`request.query.subjectOfferingId`	subjectOfferingId	Tekenreeks	Nee	-
`response.200`	response 200 The Enrollment object for a student into a StudyYear or SubjectOffering for a SchoolPeriod.	Object	Nee	-
`response.200.enrollmentId`	enrollmentId A unique identifier for this Enrollment object. This is the GUID that Consumers will refer to when making API calls, or when needing to identify an object.	Tekenreeks	Ja	-
`response.200.student`	student The Student to which this enrollment object belongs.	Object	Ja	UserReference
`response.200.student.userMasterIdentifier`	userMasterIdentifier The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)	Tekenreeks	Nee	-
`response.200.student.userIds`	userIds A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)	Lijst[]	Nee	-
`response.200.student.userIds[*]`	userIds A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)	Object	Nee	-
`response.200.student.userIds[*].userId`	userId	Tekenreeks	Ja	-
`response.200.student.userIds[*].userIdType`	userIdType	Keuzelijst	Ja	toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
`response.200.enrollmentType`	enrollmentType The type of enrollment, being one of: - study: an enrollment into a StudyOffering offered by the School. - subject: an enrollment into a SubjectOffering offered by the School.	Keuzelijst	Ja	toegestaan ["study","subject"]
`response.200.study`	study A reference to the studyOfferingId of the StudyOffering in case this enrollment is of the enrollmentType `study`.	Tekenreeks	Nee	-
`response.200.studyPublicId`	studyPublicId A reference to the public id of the StudyOffering in RIO in case this enrollment is of the enrollmentType `study`	Tekenreeks	Nee	-
`response.200.studyYear`	studyYear The study year of this object in case the enrollment is of the enrollmentType 'study' Example values are: - Basisschool: 0, 1, 2, 3, 4, 5, 6, 7 or 8 - VMBO: 1, 2, 3 or 4 - HAVO: 1, 2, 3, 4 or 5 - VWO: 1, 2, 3, 4, 5 or 6	Geheel getal	Nee	-
`response.200.location`	location The Location to which this enrollment object belongs.	Object	Nee	LocationReference
`response.200.location.locationMasterIdentifier`	locationMasterIdentifier The primary identifier for a Location. For Locations the `Onderwijslocatie` aka `OL_CODE` is used. (either locationMasterIdentifier or locationIds is required)	Tekenreeks	Nee	-
`response.200.location.locationIds`	locationIds A secondary identifier for the Location. For Locations the `Vestigingserkenning` aka `VE_CODE` is used. This value is used whenever the primary identifier is not available. (either locationMasterIdentifier or locationIds is required)	Lijst[]	Nee	-
`response.200.location.locationIds[*]`	locationIds A secondary identifier for the Location. For Locations the `Vestigingserkenning` aka `VE_CODE` is used. This value is used whenever the primary identifier is not available. (either locationMasterIdentifier or locationIds is required)	Object	Nee	-
`response.200.location.locationIds[*].locationId`	locationId	Tekenreeks	Ja	-
`response.200.location.locationIds[*].locationIdType`	locationIdType	Keuzelijst	Ja	toegestaan ["VE_CODE"]
`response.200.location.name`	name A name for the Location.	Tekenreeks	Ja	-
`response.200.subject`	subject A reference to the subjectOfferingId of the SubjectOffering in case this enrollment is of the enrollmentType `subject`.	Tekenreeks	Nee	-
`response.200.schoolPeriod`	schoolPeriod A reference to the schoolPeriodId of the SchoolPeriod where this enrollment is part of.	Tekenreeks	Ja	-
`response.200.beginDate`	beginDate The start date on which the enrollment becomes active (inclusive). Format: YYYY-MM-DD (according to RFC3339).	Datum	Ja	-
`response.200.endDate`	endDate The end date on which the enrollment becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339).	Datum	Nee	-
`response.200.status`	status The status field gives an indication to Consumers about the status of an object. Consumers can delete objects that are flagged `tobedeleted` as such if they wish. The status attribute is based on the Base Class from OneRoster.	Keuzelijst	Ja	toegestaan ["study","subject"]
`response.200.dateCreated`	dateCreated 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.	Datum/tijd	Ja	-
`response.200.dateLastModified`	dateLastModified 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.	Datum/tijd	Ja	-
`response.400`	response 400 Functional status code and status message.	Object	Nee	-
`response.400.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.400.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.401`	response 401 Functional status code and status message.	Object	Nee	-
`response.401.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.401.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.403`	response 403 Functional status code and status message.	Object	Nee	-
`response.403.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.403.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-
`response.404`	response 404 Functional status code and status message.	Object	Nee	-
`response.404.status`	status See functional status codes within the Documentation.	Geheel getal	Ja	-
`response.404.statusMessage`	statusMessage See functional status messages within the Documentation.	Tekenreeks	Nee	-

Verwachte statuscodes

5 items

Code	Betekenis	Uitkomst
`200`	OK	Succes
`400`	Bad Request	Fout
`401`	Unauthorized	Fout
`403`	Forbidden	Fout
`404`	Not Found	Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /enrollments/school:
    parameters:
      - schema:
          type: string
        name: orgMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the school.
          This parameter is used when the primary identifier for a school (being the `OnderwijsaanbiederId`) is available.
      - schema:
          type: string
        name: orgId
        in: query
        required: false
        description: |
          The organisationIdentifier (secondary identifier) of the school.
          This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.
      - schema:
          type: string
          example: DD_ID
          enum:
            - OIE_CODE
            - BP_ID
            - DD_ID
            - AS_ID
            - V_ID
        name: orgIdType
        in: query
        required: false
        description: |
          The type of the organisationIdentifier.
          This parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.
          The following values are supported:
          - `OIE_CODE`: OnderwijsInstellingserkenningcode
          - `BP_ID`: Basispoort-generated identifier for the school
          - `DD_ID`: DigiDeliveryId generated by the Central Registration of Edu-iX
          - `AS_ID`: LAS-generated identifier (LAS-Key) for the school
          - `V_ID`: VestigingsId – BRIN6-format identifier, including dummy locations
      - schema:
          type: boolean
        name: filterByOrgId
        in: query
        required: false
        description: |
          Controls whether the response is filtered to only include Enrollments belonging to the
          specific organisation identified by `orgId` and `orgIdType`, or whether all Enrollments
          of the associated Onderwijsaanbieder are returned.
          - `true`: Only Enrollments belonging to the specified secondary identifier are returned.
          - `false`: All Enrollments of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).
          When omitted, a sector-specific default applies:
          - **PO (primary education):** defaults to `true` – response is filtered to the specified identifier.
          - **VO (secondary education):** defaults to `false` – response covers the full Onderwijsaanbieder scope.
          This parameter is only relevant in combination with `orgId` and `orgIdType`.
          When `orgMasterId` is used, this parameter must be absent or `false`.
          It is the responsibility of the consuming party to verify whether the Source supports
          filtering via this parameter before using it.
      - schema:
          type: string
          enum:
            - study
            - subject
        name: enrollmentType
        in: query
        required: false
        description: 'Optional filter to request all Enrollment objects for a specified enrollmentType.'
      - schema:
          type: string
        name: schoolPeriodId
        in: query
        required: false
        description: 'Optional filter to request all Enrollment objects within a specified SchoolPeriod and its corresponding schoolPeriodId.'
      - schema:
          type: string
        name: studyOfferingId
        in: query
        required: false
        description: 'Optional filter to request all Enrollment objects into a StudyOffering and its corresponding studyOfferingId.'
      - schema:
          type: string
        name: subjectOfferingId
        in: query
        required: false
        description: 'Optional filter to request all Enrollment objects into a SubjectOffering and its corresponding subjectOfferingId.'
    get:
      summary: Get Enrollments for School
      x-tags:
        - Enrollment
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: get-enrollments-for-school
      description: 'Request Enrollment objects for a specified School.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Enrollment'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.association