Skip to main content
GET
/
organisations
Hämta en lista med organisationer.
curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/organisations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    },
    {
      "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"
    }
  ],
  "pageToken": "pageToken"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
parent
string<uuid>[]

Begränsa urvalet till utpekade organisations-ID:n.

​
schoolUnitCode
string[]

Begränsa urvalet till de skolenheter som har den angivna Skolenhetskoden. En Identifierare för skolenheten enligt Skolverket.

​
organisationCode
string[]

Begränsa urvalet till de organisationselement som har den angivna koden.

​
municipalityCode
string

Begränsa urvalet till de organisationselement som har angiven kommunkod.

​
type
enum<string>[]

Begränsa urvalet till utpekade typ.

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
​
schoolTypes
enum<string>[]

Begränsa urvalet till de organisationselement som har den angivna skolformen.

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
​
startDate.onOrBefore
string<date>

Begränsa urvalet till organisationselement som har ett startDate värde innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

​
startDate.onOrAfter
string<date>

Begränsa urvalet till organisationselement som har ett startDate värde på eller efter det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

​
endDate.onOrBefore
string<date>

Begränsa urvalet till organisationselement som har ett endDate värde innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

​
endDate.onOrAfter
string<date>

Begränsa urvalet till organisationselement som har ett endDate värde på eller efter det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

​
meta.created.before
string<date-time>

Endast poster skapade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.

​
meta.created.after
string<date-time>

Endast poster skapade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.

​
meta.modified.before
string<date-time>

Endast poster modifierade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.

​
meta.modified.after
string<date-time>

Endast poster modifierade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.

​
expandReferenceNames
boolean

Returnera displayName för alla refererade objekt.

​
sortkey
enum<string>
Available options:
ModifiedDesc,
DisplayNameAsc
​
limit
integer

Antal poster som ska visas i resultatet. Utelämnas det så returnas så många poster som möjligt av servern, se pageToken.

Required range: x >= 1
​
pageToken
string

Ett opakt värde som servern givit som svar på en tidigare ställd fråga. Kan inte komibineras med andra filter men väl med limit.

Response

Anropet lyckades.

​
data
Organisation · object[]
required
​
pageToken
string | null

Om värdet är null finns inget mer att hämta på det token som skickades in som query parameter.