Organisation.yaml

Organisation:
  type: object
  title: Organisation
  properties:
    id:
      type: string
      format: uuid
    meta:
      $ref: "common.yaml#/Meta"
    displayName:
      type: string
      description: Namn på organisationen
    organisationCode:
      type: string
      description: En kod för att identifiera organisationselementet inom organisationen.
    organisationType:
      $ref: "common.yaml#/components/schemas/OrganisationTypeEnum"
    organisationNumber:
      type: string
      description: >
        Identitetsbeteckning för juridiska personer såsom
        kommun eller bolag
    parentOrganisation:
      allOf:
        - $ref: "common.yaml#/OrganisationReference"
        - description: >
            Identifierare för en eventellt överliggande organisation.
            Kan ej peka på organisationer av typen _Skolenhet_.
    schoolUnitCode:
      type: string
      description: >
        Skolenhetskod. Identifierare för skolenheten enligt Skolverket.
        Används för de skolformer där skolverket bestämmer en
        skolenhetskod för varje enhet.
    schoolTypes:
      type: array
      uniqueItems: true
      description: Anges endas för organisationselement typen Skolenhet.
      items:
        $ref: "common.yaml#/components/schemas/SchoolTypesEnum"
    municipalityCode:
      type: string
      description: >
        Kommunkod. Län och kommunkod för den kommun där skolan är belägen,
        exempelvis 0180 där 01 anger länet och 80 anger kommunen.
    url:
      type: string
      format: uri
      description: >
        Länk till en websida med information om skolan eller organisationselementet.
    email:
      type: string
      format: email
      description: >
        Epost-adress till skolan eller organisationselementet.
    phoneNumber:
      type: string
      description: >
        Telefonnummer till en skolan eller organisationselementet.
    contactInfo:
      type: array
      items:
        type: object
        title: ContactInfo
        description: >
          Kontaktuppgifter till skolan eller organisationselementet.
          Kan användas för supportkontakt och andra publika kontaktuppgifter.
        properties:
          infoType:
            type: string
            title: Code_OrganisationContactInfoType
            description: >
              Typ av kontaktuppgift. Publika uppgifter avser uppgifter som kan visas för allmänheten,
              såsom adress och telefonnummer till skolan.
            enum:
              - Support
              - Publik
          info:
            type: string
            description: >
              Beskrivning i fritext av kontaktuppgifter till skolan eller organisationsenheten.
    startDate:
      type: string
      format: date
      description: >
        Startdatum för organisationensdelens giltighetstid
        (RFC 3339-format, t.ex. "2016-10-15"). Gäller för alla underliggande element som inte har ett mer restrektivt värde. Inkluderande.
    endDate:
      type: string
      format: date
      description: >
        Slutdatum för organisationensdelens giltighetstid
        (RFC 3339-format, t.ex. "2016-10-15"). Gäller för alla underliggande element som inte har ett mer restrektivt värde. Inkluderande.
  required:
    - id
    - meta
    - displayName
    - organisationType
  description: En skolhuvudman eller annan slags organisatorisk enhet.

OrganisationsArray:
  type: array
  items:
    $ref: "#/Organisation"

Organisations:
  type: object
  properties:
    data:
      type: array
      items:
        $ref: "#/Organisation"
    pageToken:
      type: string
      nullable: true
      description: >
        Om värdet är null finns inget mer att hämta på det token
        som skickades in som query parameter.
  required:
    - data