Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
School

Get a School

Retrieves the School with the given ID.

get/school/{id}

Path parameters

idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the School to retrieve

Response

Response for School Get operation - returns the requested School

idstring uuid required

Unique identifier for the School

titlestring required

The title of the school

unitIDstring uuid nullable

The ID of the Unit the school belongs to. Null if the school is not assigned to a Unit.

unitCodestring nullable

The School Unit Code provided by SCB, is used in reports and printed on grade documents

csnSchoolCodestring nullable

The School Code provided by CSN, required for reports to CSN

municipalityCodestring nullable

Municipality code of the school, is used in reports and printed on grade documents

schoolType'GR' | 'GY' | 'FS' required

The type of schooling provided at the school

Example response

{
  "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"
  },
  "title": "Meitner Grundskola",
  "unitID": "123e4567-e89b-12d3-a456-426614174000",
  "unitCode": "12345678",
  "csnSchoolCode": "12345",
  "municipalityCode": "0184"
}