> ## Documentation Index > Fetch the complete documentation index at: https://docs.meitner.se/llms.txt > Use this file to discover all available pages before exploring further. # Search Guardians > Search for `Guardians` with filtering capabilities. ## OpenAPI ````yaml https://spec.speakeasy.com/meitner-2u8/api/directory-api-with-code-samples post /guardian/_search openapi: 3.1.0 info: title: Directory API description: Generated API documentation contact: name: Meitner url: https://meitner.se email: support@meitner.se license: name: Proprietary - Licensed to Authorized Customers Only url: https://meitner.se version: v1 servers: - url: https://api.meitner.se/directory/v1 description: Server to use in production x-speakeasy-server-id: production - url: https://api.staging.meitner.se/directory/v1 description: Server to use when building and testing the API x-speakeasy-server-id: staging security: - ClientCredentials: [] ClientSecret: [] - OAuth2: [] tags: - name: School description: > The `School` resource represents a school where daily operations occur. A school must exist before you can create StudentPlacements, EmployeePlacements, or Groups. This resource can be created, updated, listed, retrieved, and searched using the standard resource structure. - name: Group description: Group holds the information about a group of students. - name: Employee description: >- Employee holds the personal information about an employee in the organization. - name: EmployeePlacement description: >- EmployeePlacement holds the information about an employee's placement in a school. - name: Guardian description: Guardian holds the information about a guardian of a student. - name: Student description: >- Student holds the personal information about a student, information about the school is stored in the StudentPlacement-resource. - name: StudentPlacement description: >- StudentPlacement holds the placement information about a student in a specific school. - name: AuditEvent description: AuditEvent holds the information about an audit event. - name: GradeElementary description: > GradeElementary represents a grade awarded to a student in elementary school (Swedish: grundskola). Grades are scoped to the organization of the API key used. The SubjectCode field uses the subject code as defined by the Swedish school authorities (e.g. "MA" for Mathematics). - name: GradeUpperSecondary description: > GradeUpperSecondary represents a grade awarded to a student in upper secondary school (Swedish: gymnasieskola). Grades are scoped to the organization of the API key used. The CourseCode field uses the national course code as defined by the Swedish school authorities (e.g. "MATMAT01a"). - name: Unit description: > The `Unit` resource represents an organizational unit that schools can belong to. This resource can be created, updated, listed, retrieved, and searched using the standard resource structure. paths: /guardian/_search: post: tags: - Guardian summary: Search Guardians description: Search for `Guardians` with filtering capabilities. operationId: GuardianSearch parameters: - name: limit in: query description: >- The maximum number of Guardians to return (default: 50) when searching Guardians required: false schema: type: integer examples: - 1 default: 50 - name: offset in: query description: >- The number of Guardians to skip before starting to return results (default: 0) when searching Guardians required: false schema: type: integer examples: - 0 default: 0 requestBody: $ref: '#/components/requestBodies/GuardianSearch' responses: '200': $ref: '#/components/responses/GuardianSearch' description: >- Response for Guardian Search operation - returns filtered Guardian results '400': $ref: '#/components/responses/Error400ResponseBody' description: >- Bad Request error for Guardian Search operation - request contains invalid parameters '401': $ref: '#/components/responses/Error401ResponseBody' description: >- Unauthorized error for Guardian Search operation - authentication required '403': $ref: '#/components/responses/Error403ResponseBody' description: >- Forbidden error for Guardian Search operation - insufficient permissions '404': $ref: '#/components/responses/Error404ResponseBody' description: >- Not Found error for Guardian Search operation - resource does not exist '409': $ref: '#/components/responses/Error409ResponseBody' description: >- Conflict error for Guardian Search operation - request conflicts with current state '422': $ref: '#/components/responses/GuardianSearch422ResponseBody' description: >- Validation error for Guardian Search operation - request data failed validation '429': $ref: '#/components/responses/Error429ResponseBody' description: Rate Limit error for Guardian Search operation - too many requests '500': $ref: '#/components/responses/Error500ResponseBody' description: >- Internal Server error for Guardian Search operation - unexpected server error x-codeSamples: - lang: csharp label: Csharp (SDK) source: >- using Meitner; using Meitner.Models.Components; using System; using System.Collections.Generic; var sdk = new MeitnerSDK(security: new Security() { Option1 = new SecurityOption1() { ClientCredentials = "", ClientSecret = "", }, }); Models.Requests.GuardianSearchResponse? res = await sdk.Guardians.SearchAsync( guardianSearch: new GuardianSearchRequestBody() { Filter = new GuardianSearchFilter() { Equals = new GuardianSearchEquals() { Id = "123e4567-e89b-12d3-a456-426614174000", Meta = new GuardianSearchEqualsMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), CreatedBy = "123e4567-e89b-12d3-a456-426614174000", UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedBy = "123e4567-e89b-12d3-a456-426614174000", }, External = new GuardianSearchEqualsExternal() { SourceID = "example", Source = "example", }, IdentityNumber = "example", IdentityTemporary = true, FirstName = "example", LastName = "example", Address = new GuardianSearchEqualsAddress() { PostalAddress = "example", PostalCode = "example", PostalCity = "example", CountryCode = "example", MunicipalityCode = "example", }, EmailAddress1 = "example", EmailAddress2 = "example", PhoneNumber1 = "example", PhoneNumber2 = "example", StudentIDs = "123e4567-e89b-12d3-a456-426614174000", }, NotEquals = new GuardianSearchNotEquals() { Id = "123e4567-e89b-12d3-a456-426614174000", Meta = new GuardianSearchNotEqualsMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), CreatedBy = "123e4567-e89b-12d3-a456-426614174000", UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedBy = "123e4567-e89b-12d3-a456-426614174000", }, External = new GuardianSearchNotEqualsExternal() { SourceID = "example", Source = "example", }, IdentityNumber = "example", IdentityTemporary = true, FirstName = "example", LastName = "example", Address = new GuardianSearchNotEqualsAddress() { PostalAddress = "example", PostalCode = "example", PostalCity = "example", CountryCode = "example", MunicipalityCode = "example", }, EmailAddress1 = "example", EmailAddress2 = "example", PhoneNumber1 = "example", PhoneNumber2 = "example", StudentIDs = "123e4567-e89b-12d3-a456-426614174000", }, GreaterThan = new GuardianSearchGreaterThan() { Meta = new GuardianSearchGreaterThanMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, }, SmallerThan = new GuardianSearchSmallerThan() { Meta = new GuardianSearchSmallerThanMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, }, GreaterOrEqual = new GuardianSearchGreaterOrEqual() { Meta = new GuardianSearchGreaterOrEqualMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, }, SmallerOrEqual = new GuardianSearchSmallerOrEqual() { Meta = new GuardianSearchSmallerOrEqualMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, }, Contains = new GuardianSearchContains() { Id = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Meta = new GuardianSearchContainsMeta() { CreatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, UpdatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, External = new GuardianSearchContainsExternal() { SourceID = new List() { "example", }, Source = new List() { "example", }, }, IdentityNumber = new List() { "example", }, IdentityTemporary = new List() { true, }, FirstName = new List() { "example", }, LastName = new List() { "example", }, Address = new GuardianSearchContainsAddress() { PostalAddress = new List() { "example", }, PostalCode = new List() { "example", }, PostalCity = new List() { "example", }, CountryCode = new List() { "example", }, MunicipalityCode = new List() { "example", }, }, EmailAddress1 = new List() { "example", }, EmailAddress2 = new List() { "example", }, PhoneNumber1 = new List() { "example", }, PhoneNumber2 = new List() { "example", }, StudentIDs = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, NotContains = new GuardianSearchNotContains() { Id = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Meta = new GuardianSearchNotContainsMeta() { CreatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, UpdatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, External = new GuardianSearchNotContainsExternal() { SourceID = new List() { "example", }, Source = new List() { "example", }, }, IdentityNumber = new List() { "example", }, IdentityTemporary = new List() { true, }, FirstName = new List() { "example", }, LastName = new List() { "example", }, Address = new GuardianSearchNotContainsAddress() { PostalAddress = new List() { "example", }, PostalCode = new List() { "example", }, PostalCity = new List() { "example", }, CountryCode = new List() { "example", }, MunicipalityCode = new List() { "example", }, }, EmailAddress1 = new List() { "example", }, EmailAddress2 = new List() { "example", }, PhoneNumber1 = new List() { "example", }, PhoneNumber2 = new List() { "example", }, StudentIDs = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, Like = new GuardianSearchLike() { External = new GuardianSearchLikeExternal() { SourceID = "example", Source = "example", }, IdentityNumber = "example", FirstName = "example", LastName = "example", Address = new GuardianSearchLikeAddress() { PostalAddress = "example", PostalCode = "example", PostalCity = "example", CountryCode = "example", MunicipalityCode = "example", }, EmailAddress1 = "example", EmailAddress2 = "example", PhoneNumber1 = "example", PhoneNumber2 = "example", }, NotLike = new GuardianSearchNotLike() { External = new GuardianSearchNotLikeExternal() { SourceID = "example", Source = "example", }, IdentityNumber = "example", FirstName = "example", LastName = "example", Address = new GuardianSearchNotLikeAddress() { PostalAddress = "example", PostalCode = "example", PostalCity = "example", CountryCode = "example", MunicipalityCode = "example", }, EmailAddress1 = "example", EmailAddress2 = "example", PhoneNumber1 = "example", PhoneNumber2 = "example", }, Null = new GuardianSearchNull() { Meta = new GuardianSearchNullMeta() { CreatedBy = true, UpdatedAt = true, UpdatedBy = true, }, External = new GuardianSearchNullExternal() { SourceID = true, Source = true, }, Address = new GuardianSearchNullAddress() { PostalAddress = true, PostalCode = true, PostalCity = true, CountryCode = true, MunicipalityCode = true, }, EmailAddress1 = true, EmailAddress2 = true, PhoneNumber1 = true, PhoneNumber2 = true, StudentIDs = true, }, NotNull = new GuardianSearchNotNull() { Meta = new GuardianSearchNotNullMeta() { CreatedBy = true, UpdatedAt = true, UpdatedBy = true, }, External = new GuardianSearchNotNullExternal() { SourceID = true, Source = true, }, Address = new GuardianSearchNotNullAddress() { PostalAddress = true, PostalCode = true, PostalCity = true, CountryCode = true, MunicipalityCode = true, }, EmailAddress1 = true, EmailAddress2 = true, PhoneNumber1 = true, PhoneNumber2 = true, StudentIDs = true, }, OrCondition = true, }, }, limit: 1, offset: 0 ); while(res != null) { // handle items res = await res.Next!(); } - lang: python label: Python (SDK) source: |- from meitner import Meitner, models from meitner.utils import parse_datetime import os with Meitner( security=models.Security( option1=models.SecurityOption1( client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""), client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""), ), ), ) as m_client: res = m_client.guardians.search(filter_={ "equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "identity_number": "example", "identity_temporary": True, "first_name": "example", "last_name": "example", "address": { "postal_address": "example", "postal_code": "example", "postal_city": "example", "country_code": "example", "municipality_code": "example", }, "email_address1": "example", "email_address2": "example", "phone_number1": "example", "phone_number2": "example", "student_i_ds": "123e4567-e89b-12d3-a456-426614174000", }, "not_equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "identity_number": "example", "identity_temporary": True, "first_name": "example", "last_name": "example", "address": { "postal_address": "example", "postal_code": "example", "postal_city": "example", "country_code": "example", "municipality_code": "example", }, "email_address1": "example", "email_address2": "example", "phone_number1": "example", "phone_number2": "example", "student_i_ds": "123e4567-e89b-12d3-a456-426614174000", }, "greater_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, }, "smaller_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, }, "greater_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, }, "smaller_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, }, "contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "identity_number": [ "example", ], "identity_temporary": [ True, ], "first_name": [ "example", ], "last_name": [ "example", ], "address": { "postal_address": [ "example", ], "postal_code": [ "example", ], "postal_city": [ "example", ], "country_code": [ "example", ], "municipality_code": [ "example", ], }, "email_address1": [ "example", ], "email_address2": [ "example", ], "phone_number1": [ "example", ], "phone_number2": [ "example", ], "student_i_ds": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "not_contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "identity_number": [ "example", ], "identity_temporary": [ True, ], "first_name": [ "example", ], "last_name": [ "example", ], "address": { "postal_address": [ "example", ], "postal_code": [ "example", ], "postal_city": [ "example", ], "country_code": [ "example", ], "municipality_code": [ "example", ], }, "email_address1": [ "example", ], "email_address2": [ "example", ], "phone_number1": [ "example", ], "phone_number2": [ "example", ], "student_i_ds": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "like": { "external": { "source_id": "example", "source": "example", }, "identity_number": "example", "first_name": "example", "last_name": "example", "address": { "postal_address": "example", "postal_code": "example", "postal_city": "example", "country_code": "example", "municipality_code": "example", }, "email_address1": "example", "email_address2": "example", "phone_number1": "example", "phone_number2": "example", }, "not_like": { "external": { "source_id": "example", "source": "example", }, "identity_number": "example", "first_name": "example", "last_name": "example", "address": { "postal_address": "example", "postal_code": "example", "postal_city": "example", "country_code": "example", "municipality_code": "example", }, "email_address1": "example", "email_address2": "example", "phone_number1": "example", "phone_number2": "example", }, "null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "address": { "postal_address": True, "postal_code": True, "postal_city": True, "country_code": True, "municipality_code": True, }, "email_address1": True, "email_address2": True, "phone_number1": True, "phone_number2": True, "student_i_ds": True, }, "not_null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "address": { "postal_address": True, "postal_code": True, "postal_city": True, "country_code": True, "municipality_code": True, }, "email_address1": True, "email_address2": True, "phone_number1": True, "phone_number2": True, "student_i_ds": True, }, "or_condition": True, }, limit=1, offset=0) while res is not None: # Handle items res = res.next() components: requestBodies: GuardianSearch: description: Request body content: application/json: schema: type: object properties: filter: allOf: - $ref: '#/components/schemas/GuardianFilter' examples: - equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 like: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example notLike: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true orCondition: true description: Filter criteria to search for specific records required: - filter examples: requestExample: summary: Request body example value: filter: equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 like: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example notLike: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true orCondition: true required: true responses: GuardianSearch: description: >- Response for Guardian Search operation - returns filtered Guardian results headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: data: type: array examples: - - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 987fcdeb-51a2-43d1-b567-123456789abc updatedAt: '2024-01-15T14:45:00Z' updatedBy: 987fcdeb-51a2-43d1-b567-123456789abc external: sourceID: '12345678' source: ExternalIntegrationAPI identityNumber: 20191216-1234 identityTemporary: true firstName: Lise lastName: Meitner address: postalAddress: Dalvägen 14 postalCode: 169 56 postalCity: Solna countryCode: SWE municipalityCode: '0184' emailAddress1: lise@meitner.se emailAddress2: lise@gmail.com phoneNumber1: '+46701234567' phoneNumber2: '+46701234567' studentIDs: - 123e4567-e89b-12d3-a456-426614174000 items: allOf: - $ref: '#/components/schemas/Guardian' description: Array of Guardian objects pagination: allOf: - $ref: '#/components/schemas/Pagination' examples: - offset: 0 limit: 1 total: 100 description: Pagination information examples: responseExample: summary: Response body example value: data: - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 987fcdeb-51a2-43d1-b567-123456789abc updatedAt: '2024-01-15T14:45:00Z' updatedBy: 987fcdeb-51a2-43d1-b567-123456789abc external: sourceID: '12345678' source: ExternalIntegrationAPI identityNumber: 20191216-1234 identityTemporary: true firstName: Lise lastName: Meitner address: postalAddress: Dalvägen 14 postalCode: 169 56 postalCity: Solna countryCode: SWE municipalityCode: '0184' emailAddress1: lise@meitner.se emailAddress2: lise@gmail.com phoneNumber1: '+46701234567' phoneNumber2: '+46701234567' studentIDs: - 123e4567-e89b-12d3-a456-426614174000 pagination: offset: 0 limit: 1 total: 100 Error400ResponseBody: description: Bad Request - The request was malformed or contained invalid parameters headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Bad Request error example value: error: code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 Error401ResponseBody: description: Unauthorized - The request is missing valid authentication credentials headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Unauthorized error example value: error: code: Unauthorized message: Authentication credentials are missing or invalid requestID: 550e8400-e29b-41d4-a716-446655440000 Error403ResponseBody: description: >- Forbidden - Request is authenticated, but the user is not allowed to perform the operation headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Forbidden error example value: error: code: Forbidden message: You do not have permission to perform this operation requestID: 550e8400-e29b-41d4-a716-446655440000 Error404ResponseBody: description: Not Found - The requested resource does not exist headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Not Found error example value: error: code: NotFound message: The requested resource could not be found requestID: 550e8400-e29b-41d4-a716-446655440000 Error409ResponseBody: description: Conflict - The request could not be completed due to a conflict headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Conflict error example value: error: code: Conflict message: The request conflicts with the current state of the resource requestID: 550e8400-e29b-41d4-a716-446655440000 GuardianSearch422ResponseBody: description: >- Validation error for Guardian Search operation - request data failed validation headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: UnprocessableEntity message: Validation failed for Guardian Search endpoint requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: validationError: summary: Validation error example value: error: code: UnprocessableEntity message: Validation failed for Guardian Search endpoint requestID: 550e8400-e29b-41d4-a716-446655440000 Error429ResponseBody: description: Too Many Requests - When the rate limit has been exceeded headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Rate Limited error example value: error: code: RateLimited message: Too many requests - rate limit exceeded requestID: 550e8400-e29b-41d4-a716-446655440000 Error500ResponseBody: description: Internal Server Error - An unexpected server error occurred headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Internal Server error example value: error: code: Internal message: An unexpected server error occurred requestID: 550e8400-e29b-41d4-a716-446655440000 schemas: GuardianFilter: type: object properties: equals: allOf: - $ref: '#/components/schemas/GuardianFilterEquals' examples: - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 - null description: Equality filters for Guardian nullable: true notEquals: allOf: - $ref: '#/components/schemas/GuardianFilterEquals' examples: - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 - null description: Inequality filters for Guardian nullable: true greaterThan: allOf: - $ref: '#/components/schemas/GuardianFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Greater than filters for Guardian nullable: true smallerThan: allOf: - $ref: '#/components/schemas/GuardianFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Smaller than filters for Guardian nullable: true greaterOrEqual: allOf: - $ref: '#/components/schemas/GuardianFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Greater than or equal filters for Guardian nullable: true smallerOrEqual: allOf: - $ref: '#/components/schemas/GuardianFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Smaller than or equal filters for Guardian nullable: true contains: allOf: - $ref: '#/components/schemas/GuardianFilterContains' examples: - id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 - null description: Contains filters for Guardian nullable: true notContains: allOf: - $ref: '#/components/schemas/GuardianFilterContains' examples: - id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 - null description: Not contains filters for Guardian nullable: true like: allOf: - $ref: '#/components/schemas/GuardianFilterLike' examples: - external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example - null description: LIKE filters for Guardian nullable: true notLike: allOf: - $ref: '#/components/schemas/GuardianFilterLike' examples: - external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example - null description: NOT LIKE filters for Guardian nullable: true 'null': allOf: - $ref: '#/components/schemas/GuardianFilterNull' examples: - meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true - null description: Null filters for Guardian nullable: true notNull: allOf: - $ref: '#/components/schemas/GuardianFilterNull' examples: - meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true - null description: Not null filters for Guardian nullable: true orCondition: type: boolean examples: - true description: >- OrCondition decides if this filter is within an OR-condition or AND-condition nestedFilters: type: array examples: - - equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example identityNumber: example identityTemporary: true firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example studentIDs: 123e4567-e89b-12d3-a456-426614174000 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example identityNumber: - example identityTemporary: - true firstName: - example lastName: - example address: postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example emailAddress1: - example emailAddress2: - example phoneNumber1: - example phoneNumber2: - example studentIDs: - 123e4567-e89b-12d3-a456-426614174000 like: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example notLike: external: sourceID: example source: example identityNumber: example firstName: example lastName: example address: postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example emailAddress1: example emailAddress2: example phoneNumber1: example phoneNumber2: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true address: postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true emailAddress1: true emailAddress2: true phoneNumber1: true phoneNumber2: true studentIDs: true orCondition: true items: allOf: - $ref: '#/components/schemas/GuardianFilter' description: NestedFilters of the Guardian, useful for more complex filters required: - orCondition description: Filter object for Guardian Guardian: type: object properties: id: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: Unique identifier for the Guardian meta: allOf: - $ref: '#/components/schemas/Meta' examples: - createdAt: '2024-01-15T10:30:00Z' createdBy: 987fcdeb-51a2-43d1-b567-123456789abc updatedAt: '2024-01-15T14:45:00Z' updatedBy: 987fcdeb-51a2-43d1-b567-123456789abc description: Metadata information for the Guardian external: allOf: - $ref: '#/components/schemas/External' examples: - sourceID: '12345678' source: ExternalIntegrationAPI - null description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true identityNumber: type: string examples: - 20191216-1234 description: >- The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. identityTemporary: type: boolean examples: - true description: If the identity number is temporary for the guardian default: false firstName: type: string examples: - Lise description: The first name of the guardian lastName: type: string examples: - Meitner description: The last name of the guardian address: allOf: - $ref: '#/components/schemas/Address' examples: - postalAddress: Dalvägen 14 postalCode: 169 56 postalCity: Solna countryCode: SWE municipalityCode: '0184' description: The address of the guardian emailAddress1: type: string examples: - lise@meitner.se - null description: > The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization. nullable: true emailAddress2: type: string examples: - lise@gmail.com - null description: >- The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true phoneNumber1: type: string examples: - '+46701234567' - null description: >- The primary phone number of the guardian, will be used for communication with the guardian from the system. nullable: true phoneNumber2: type: string examples: - '+46701234567' - null description: >- The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true studentIDs: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: The IDs of the students the guardian is responsible for. required: - id - identityNumber - firstName - lastName description: Guardian holds the information about a guardian of a student. Pagination: type: object properties: offset: type: integer examples: - 0 description: Number of items to skip from the beginning of the result set limit: type: integer examples: - 1 description: Maximum number of items to return in the result set total: type: integer examples: - 100 description: Total number of items available for pagination required: - offset - limit - total description: Pagination parameters for controlling result sets in list operations Error: type: object properties: code: allOf: - $ref: '#/components/schemas/ErrorCode' description: The specific error code indicating the type of error message: type: string examples: - example description: Human-readable error message providing additional details requestID: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 description: >- Unique identifier for the request that generated this error, used for logging and debugging required: - code - message - requestID description: >- Standard error response object containing error code, message, and request ID GuardianFilterEquals: type: object properties: id: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: Unique identifier for the Guardian nullable: true meta: allOf: - $ref: '#/components/schemas/MetaFilterEquals' examples: - createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 - null description: Metadata information for the Guardian nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterEquals' examples: - sourceID: example source: example - null description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true identityNumber: type: string examples: - example - null description: >- The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. nullable: true identityTemporary: type: boolean examples: - true - null description: If the identity number is temporary for the guardian nullable: true firstName: type: string examples: - example - null description: The first name of the guardian nullable: true lastName: type: string examples: - example - null description: The last name of the guardian nullable: true address: allOf: - $ref: '#/components/schemas/AddressFilterEquals' examples: - postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example - null description: The address of the guardian nullable: true emailAddress1: type: string examples: - example - null description: > The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization. nullable: true emailAddress2: type: string examples: - example - null description: >- The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true phoneNumber1: type: string examples: - example - null description: >- The primary phone number of the guardian, will be used for communication with the guardian from the system. nullable: true phoneNumber2: type: string examples: - example - null description: >- The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true studentIDs: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: The IDs of the students the guardian is responsible for. nullable: true description: Equality/Inequality filter fields for Guardian GuardianFilterRange: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterRange' examples: - createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Metadata information for the Guardian nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterRange' description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true address: allOf: - $ref: '#/components/schemas/AddressFilterRange' description: The address of the guardian nullable: true description: Range filter fields for Guardian GuardianFilterContains: type: object properties: id: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: Unique identifier for the Guardian meta: allOf: - $ref: '#/components/schemas/MetaFilterContains' examples: - createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 - null description: Metadata information for the Guardian nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterContains' examples: - sourceID: - example source: - example - null description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true identityNumber: type: array examples: - - example items: type: string description: >- The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. identityTemporary: type: array examples: - - true items: type: boolean description: If the identity number is temporary for the guardian firstName: type: array examples: - - example items: type: string description: The first name of the guardian lastName: type: array examples: - - example items: type: string description: The last name of the guardian address: allOf: - $ref: '#/components/schemas/AddressFilterContains' examples: - postalAddress: - example postalCode: - example postalCity: - example countryCode: - example municipalityCode: - example - null description: The address of the guardian nullable: true emailAddress1: type: array examples: - - example items: type: string description: > The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization. emailAddress2: type: array examples: - - example items: type: string description: >- The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. phoneNumber1: type: array examples: - - example items: type: string description: >- The primary phone number of the guardian, will be used for communication with the guardian from the system. phoneNumber2: type: array examples: - - example items: type: string description: >- The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. studentIDs: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: The IDs of the students the guardian is responsible for. description: Contains filter fields for Guardian GuardianFilterLike: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterLike' description: Metadata information for the Guardian nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterLike' examples: - sourceID: example source: example - null description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true identityNumber: type: string examples: - example - null description: >- The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. nullable: true firstName: type: string examples: - example - null description: The first name of the guardian nullable: true lastName: type: string examples: - example - null description: The last name of the guardian nullable: true address: allOf: - $ref: '#/components/schemas/AddressFilterLike' examples: - postalAddress: example postalCode: example postalCity: example countryCode: example municipalityCode: example - null description: The address of the guardian nullable: true emailAddress1: type: string examples: - example - null description: > The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization. nullable: true emailAddress2: type: string examples: - example - null description: >- The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true phoneNumber1: type: string examples: - example - null description: >- The primary phone number of the guardian, will be used for communication with the guardian from the system. nullable: true phoneNumber2: type: string examples: - example - null description: >- The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true description: LIKE filter fields for Guardian GuardianFilterNull: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterNull' examples: - createdBy: true updatedAt: true updatedBy: true - null description: Metadata information for the Guardian nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterNull' examples: - sourceID: true source: true - null description: >- External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking. nullable: true address: allOf: - $ref: '#/components/schemas/AddressFilterNull' examples: - postalAddress: true postalCode: true postalCity: true countryCode: true municipalityCode: true - null description: The address of the guardian nullable: true emailAddress1: type: boolean examples: - true - null description: > The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization. nullable: true emailAddress2: type: boolean examples: - true - null description: >- The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true phoneNumber1: type: boolean examples: - true - null description: >- The primary phone number of the guardian, will be used for communication with the guardian from the system. nullable: true phoneNumber2: type: boolean examples: - true - null description: >- The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. nullable: true studentIDs: type: boolean examples: - true - null description: The IDs of the students the guardian is responsible for. nullable: true description: Null filter fields for Guardian Meta: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' format: date-time description: Timestamp when the resource was created createdBy: type: string examples: - 987fcdeb-51a2-43d1-b567-123456789abc - null format: uuid description: User who created the resource nullable: true updatedAt: type: string examples: - '2024-01-15T14:45:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true updatedBy: type: string examples: - 987fcdeb-51a2-43d1-b567-123456789abc - null format: uuid description: User who last updated the resource nullable: true required: - createdAt description: >- Meta contains information about the creation and modification of a resource for auditing purposes External: type: object properties: sourceID: type: string examples: - '12345678' - null description: The ID of the external source nullable: true source: type: string examples: - ExternalIntegrationAPI - null description: The source of the external information nullable: true description: >- External is a reusable object that can be used to store external information from another system, used for third-party integration tracking. Address: type: object properties: postalAddress: type: string examples: - Dalvägen 14 - null description: The postal address of the address nullable: true postalCode: type: string examples: - 169 56 - null description: >- The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. nullable: true postalCity: type: string examples: - Solna - null description: The city of the address nullable: true countryCode: type: string examples: - SWE - null description: >- The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). nullable: true municipalityCode: type: string examples: - '0184' - null description: >- The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. nullable: true description: >- Address is a reusable object that can be used to store address information. ErrorCode: type: string enum: - BadRequest - Unauthorized - Forbidden - NotFound - Conflict - UnprocessableEntity - RateLimited - Internal description: Standard error codes used in API responses MetaFilterEquals: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was created nullable: true createdBy: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: User who created the resource nullable: true updatedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true updatedBy: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: User who last updated the resource nullable: true description: Equality/Inequality filter fields for Meta ExternalFilterEquals: type: object properties: sourceID: type: string examples: - example - null description: The ID of the external source nullable: true source: type: string examples: - example - null description: The source of the external information nullable: true description: Equality/Inequality filter fields for External AddressFilterEquals: type: object properties: postalAddress: type: string examples: - example - null description: The postal address of the address nullable: true postalCode: type: string examples: - example - null description: >- The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. nullable: true postalCity: type: string examples: - example - null description: The city of the address nullable: true countryCode: type: string examples: - example - null description: >- The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). nullable: true municipalityCode: type: string examples: - example - null description: >- The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. nullable: true description: Equality/Inequality filter fields for Address MetaFilterRange: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was created nullable: true updatedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true description: Range filter fields for Meta ExternalFilterRange: type: object description: Range filter fields for External AddressFilterRange: type: object description: Range filter fields for Address MetaFilterContains: type: object properties: createdBy: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: User who created the resource updatedBy: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: User who last updated the resource description: Contains filter fields for Meta ExternalFilterContains: type: object properties: sourceID: type: array examples: - - example items: type: string description: The ID of the external source source: type: array examples: - - example items: type: string description: The source of the external information description: Contains filter fields for External AddressFilterContains: type: object properties: postalAddress: type: array examples: - - example items: type: string description: The postal address of the address postalCode: type: array examples: - - example items: type: string description: >- The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. postalCity: type: array examples: - - example items: type: string description: The city of the address countryCode: type: array examples: - - example items: type: string description: >- The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). municipalityCode: type: array examples: - - example items: type: string description: >- The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. description: Contains filter fields for Address MetaFilterLike: type: object description: LIKE filter fields for Meta ExternalFilterLike: type: object properties: sourceID: type: string examples: - example - null description: The ID of the external source nullable: true source: type: string examples: - example - null description: The source of the external information nullable: true description: LIKE filter fields for External AddressFilterLike: type: object properties: postalAddress: type: string examples: - example - null description: The postal address of the address nullable: true postalCode: type: string examples: - example - null description: >- The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. nullable: true postalCity: type: string examples: - example - null description: The city of the address nullable: true countryCode: type: string examples: - example - null description: >- The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). nullable: true municipalityCode: type: string examples: - example - null description: >- The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. nullable: true description: LIKE filter fields for Address MetaFilterNull: type: object properties: createdBy: type: boolean examples: - true - null description: User who created the resource nullable: true updatedAt: type: boolean examples: - true - null description: Timestamp when the resource was last updated nullable: true updatedBy: type: boolean examples: - true - null description: User who last updated the resource nullable: true description: Null filter fields for Meta ExternalFilterNull: type: object properties: sourceID: type: boolean examples: - true - null description: The ID of the external source nullable: true source: type: boolean examples: - true - null description: The source of the external information nullable: true description: Null filter fields for External AddressFilterNull: type: object properties: postalAddress: type: boolean examples: - true - null description: The postal address of the address nullable: true postalCode: type: boolean examples: - true - null description: >- The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. nullable: true postalCity: type: boolean examples: - true - null description: The city of the address nullable: true countryCode: type: boolean examples: - true - null description: >- The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). nullable: true municipalityCode: type: boolean examples: - true - null description: >- The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. nullable: true description: Null filter fields for Address securitySchemes: ClientCredentials: type: apiKey name: Client-ID in: header ClientSecret: type: apiKey name: Client-Secret in: header OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: /oauth/token scopes: {} ````