Hämta många organisationer baserat på en lista av ID:n.

curl --request POST \
  --url https://ss12000.staging.meitner.se/api/v1/organisations/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "d544563a-747a-42d3-8d37-415a101537fa"
  ],
  "schoolUnitCodes": [
    "55512387"
  ],
  "organisationCodes": [
    "F2311"
  ]
}
'

[
  {
    "address": {
      "country": "country",
      "countyCode": 0,
      "streetAddress": "streetAddress",
      "postalCode": "postalCode",
      "locality": "locality",
      "type": "Besöksadress",
      "municipalityCode": 6,
      "realEstateDesignation": "realEstateDesignation"
    },
    "contactInfo": [
      {
        "infoType": "Support",
        "info": "info"
      },
      {
        "infoType": "Support",
        "info": "info"
      }
    ],
    "endDate": "2000-01-23T00:00:00.000Z",
    "displayName": "displayName",
    "municipalityCode": "municipalityCode",
    "url": "https://openapi-generator.tech",
    "organisationType": null,
    "schoolTypes": [
      null,
      null
    ],
    "phoneNumber": "phoneNumber",
    "organisationCode": "organisationCode",
    "meta": {
      "created": "2000-01-23T04:56:07.000Z",
      "modified": "2000-01-23T04:56:07.000Z"
    },
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "parentOrganisation": null,
    "organisationNumber": "organisationNumber",
    "schoolUnitCode": "schoolUnitCode",
    "email": "email",
    "startDate": "2000-01-23T00:00:00.000Z"
  }
]

POST

organisations

lookup

Hämta många organisationer baserat på en lista av ID:n.

curl --request POST \
  --url https://ss12000.staging.meitner.se/api/v1/organisations/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "d544563a-747a-42d3-8d37-415a101537fa"
  ],
  "schoolUnitCodes": [
    "55512387"
  ],
  "organisationCodes": [
    "F2311"
  ]
}
'

[
  {
    "address": {
      "country": "country",
      "countyCode": 0,
      "streetAddress": "streetAddress",
      "postalCode": "postalCode",
      "locality": "locality",
      "type": "Besöksadress",
      "municipalityCode": 6,
      "realEstateDesignation": "realEstateDesignation"
    },
    "contactInfo": [
      {
        "infoType": "Support",
        "info": "info"
      },
      {
        "infoType": "Support",
        "info": "info"
      }
    ],
    "endDate": "2000-01-23T00:00:00.000Z",
    "displayName": "displayName",
    "municipalityCode": "municipalityCode",
    "url": "https://openapi-generator.tech",
    "organisationType": null,
    "schoolTypes": [
      null,
      null
    ],
    "phoneNumber": "phoneNumber",
    "organisationCode": "organisationCode",
    "meta": {
      "created": "2000-01-23T04:56:07.000Z",
      "modified": "2000-01-23T04:56:07.000Z"
    },
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "parentOrganisation": null,
    "organisationNumber": "organisationNumber",
    "schoolUnitCode": "schoolUnitCode",
    "email": "email",
    "startDate": "2000-01-23T00:00:00.000Z"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

expandReferenceNames

boolean

Returnera displayName för alla refererade objekt.

Body

application/json

ids

string<uuid>[]

schoolUnitCodes

string[]

organisationCodes

string[]

Response

Anropet lyckades.

string<uuid>

required

meta

Meta · object

required

Show child attributes

meta.created

string<date-time>

required

Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00").

meta.modified

string<date-time>

required

Datum och tid för när entiteten senast uppdaterades (RFC 3339 format tex "2015-12-12T10:30:00+01:00"). Tidpunkten avser den senaste tidpunkt när något av de attribut som direkt tillhör entiteten har ändrats. Attribut som kan tas fram med parametrarna expand eller expandReferenceNames räknas inte som ett attribut till entiteten, och ska således inte påverka detta värde.

Example:

{
  "created": "2000-01-23T04:56:07.000Z",
  "modified": "2000-01-23T04:56:07.000Z"
}

displayName

string

required

Namn på organisationen

organisationType

enum<string>

required

Typ av organisation. Notera att Stadsdel är deprekerad och kommer tas bort i nästa version. Rimlig synonym är Förvaltning.

Available options:

Huvudman,

Verksamhetsområde,

Förvaltning,

Rektorsområde,

Skola,

Skolenhet,

Varumärke,

Bolag,

Övrigt

organisationCode

string

En kod för att identifiera organisationselementet inom organisationen.

organisationNumber

string

Identitetsbeteckning för juridiska personer såsom kommun eller bolag

parentOrganisation

OrganisationReference · object

Identifierare för en eventellt överliggande organisation. Kan ej peka på organisationer av typen Skolenhet.

Show child attributes

parentOrganisation.id

string<uuid>

required

parentOrganisation.displayName

string

Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".

schoolUnitCode

string

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

enum<string>[]

Anges endas för organisationselement typen Skolenhet.

Följande värden används för att beskriva skolform:

FS - Förskola
FKLASS - Förskoleklass
FTH - Fritidshem
OPPFTH - Öppen fritidsverksamhet
GR - Grundskola
GRS - Grundsärskola
TR - Träningsskolan
SP - Specialskola
SAM - Sameskola
GY - Gymnasieskola
GYS - Gymnasiesärskola
VUX - Kommunal vuxenutbildning
VUXSFI - Kommunal vuxenutbildning i svenska för invandrare
VUXGR - Kommunal vuxenutbildning på grundläggande nivå
VUXGY - Kommunal vuxenutbildning på gymnasial nivå
VUXSARGR - Kommunal vuxenutbildning som särskild utbildning på grundläggande nivå
VUXSARTR - Kommunal vuxenutbildning som särskild utbildning som motsvarar träningsskolan
VUXSARGY - Kommunal vuxenutbildning som särskild utbildning på gymnasial nivå
SFI - Utbildning i svenska för invandrare
SARVUX - Särskild utbildning för vuxna
SARVUXGR - Särskild utbildning för vuxna på grundläggande nivå
SARVUXGY - Särskild utbildning för vuxna på gymnasial nivå
SFI - Kommunal vuxenutbildning i svenska för invandrare
KU - Kulturskola
YH - Yrkeshögskola
FHS - Folkhögskola
STF - Studieförbund
KKU - Konst- och kulturutbildning
HS - Högskola
ABU - Arbetsmarknadsutbildning
AU - Annan undervisning

Available options:

FS,

FKLASS,

FTH,

OPPFTH,

GR,

GRS,

TR,

SP,

SAM,

GY,

GYS,

VUX,

VUXSFI,

VUXGR,

VUXGY,

VUXSARGR,

VUXSARTR,

VUXSARGY,

SFI,

SARVUX,

SARVUXGR,

SARVUXGY,

KU,

YH,

FHS,

STF,

KKU,

HS,

ABU,

AU

address

object

Organisationens postadress

Show child attributes

address.streetAddress

string

required

Gatuadress.

address.locality

string

required

Postort.

address.postalCode

string

required

Postadress.

address.type

enum<string>

Available options:

Besöksadress,

Leveransadress,

Postadress,

Fakturaadress

address.countyCode

integer

Län, kod

address.municipalityCode

integer

Kommun, kod

address.realEstateDesignation

string

Fastighetsbeteckning

address.country

string

Land.

Example:

{
  "country": "country",
  "countyCode": 0,
  "streetAddress": "streetAddress",
  "postalCode": "postalCode",
  "locality": "locality",
  "type": "Besöksadress",
  "municipalityCode": 6,
  "realEstateDesignation": "realEstateDesignation"
}

municipalityCode

string

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

string<uri>

Länk till en websida med information om skolan eller organisationselementet.

string<email>

Epost-adress till skolan eller organisationselementet.

phoneNumber

string

Telefonnummer till en skolan eller organisationselementet.

contactInfo

ContactInfo · object[]

Show child attributes

contactInfo.infoType

enum<string>

Typ av kontaktuppgift. Publika uppgifter avser uppgifter som kan visas för allmänheten, såsom adress och telefonnummer till skolan.

Available options:

Support,

Publik

contactInfo.info

string

Beskrivning i fritext av kontaktuppgifter till skolan eller organisationsenheten.

startDate

string<date>

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

string<date>

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.

Hämta en lista med organisationer.Hämta en organisation baserat på ID

⌘I

Getting started

Reference

Authorizations

Query Parameters

Body

Response