Skip to main content
GET
Csharp (SDK)

Authorizations

Client-ID
string
header
required
Client-Secret
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the School to retrieve

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Response for School Get operation - returns the requested School

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.

id
string<uuid>
required

Unique identifier for the School

Example:

"123e4567-e89b-12d3-a456-426614174000"

title
string
required

The title of the school

Example:

"Meitner Grundskola"

schoolType
enum<string>
required

Type of schooling provided at the school

Available options:
GR,
GY,
FS
Example:

"GR"

meta
object

Metadata information for the School

Example:
external
object | null

External is a reusable object that can be used to store external information about the school from another system, used for third-party integration tracking.

Example:
unitID
string<uuid> | null

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

Examples:

"123e4567-e89b-12d3-a456-426614174000"

null

unitCode
string | null

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

Examples:

"12345678"

null

csnSchoolCode
string | null

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

Examples:

"12345"

null

municipalityCode
string | null

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

Examples:

"0184"

null