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

Veldspecificaties

28 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	-
`response.200`	response 200 The SchoolPeriod object with its title startDate and endDate.	Object	Nee	-
`response.200.schoolPeriodId`	schoolPeriodId A unique identifier for this SchoolPeriod object. For a full schoolyear this identifier has the format "beginyear-endyear", for example "2024-2025". Otherwise this identifier is a UUID. This is the UUID that Consumers will refer to when making API calls, or when needing to identify an object.	Tekenreeks	Ja	-
`response.200.title`	title The name of the SchoolPeriod.	Tekenreeks	Ja	-
`response.200.type`	type The type of SchoolPeriod. An enumerated value is used: - gradingPeriod: Denotes a period over which some grade/result is to be awarded. - schoolYear: Denotes the school year. - semester: Denotes a semester period. Typically there are two semesters per schoolYear. - term: Denotes a term period. Typically there are three terms per schoolYear. ENUM values are corresponding the OneRoster AcademicSession SessionType.	Keuzelijst	Nee	toegestaan ["gradingPeriod","schoolYear","semester","term"]
`response.200.superSchoolPeriod`	superSchoolPeriod The link to a hierarchically higher Schoolperiod object. For example for a semester this is the schoolYear.	Tekenreeks	Nee	-
`response.200.subSchoolPeriods`	subSchoolPeriods The link to hierarchically lower Schoolperiod objects. For example for a schoolYear these are its semesters.	Lijst[]	Nee	-
`response.200.subSchoolPeriods[*]`	subSchoolPeriods The link to hierarchically lower Schoolperiod objects. For example for a schoolYear these are its semesters.	Object	Nee	-
`response.200.startDate`	startDate The start date for the SchoolPeriod (inclusive). Format: YYYY-MM-DD (according to RFC3339).	Datum	Ja	-
`response.200.endDate`	endDate The end date for the SchoolPeriod (exclusive). Format: YYYY-MM-DD (according to RFC3339).	Datum	Ja	-
`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 ["gradingPeriod","schoolYear","semester","term"]
`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.

  /schoolperiods/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 SchoolPeriods belonging to the
          specific organisation identified by `orgId` and `orgIdType`, or whether all SchoolPeriods
          of the associated Onderwijsaanbieder are returned.
          - `true`: Only SchoolPeriods belonging to the specified secondary identifier are returned.
          - `false`: All SchoolPeriods 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.
    get:
      summary: 'Get SchoolPeriods for School'
      x-tags:
        - SchoolPeriod
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: get-school-periods-for-school
      description: 'Request SchoolPeriod objects for a specified School.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SchoolPeriod'
        '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