Skip to main content
PATCH
/
unit
/
{id}
Python (SDK)
from meitner import Meitner, models
import os


with Meitner(
    security=models.Security(
        option1=models.SecurityOption1(
            client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
            client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
        ),
    ),
) as m_client:

    res = m_client.units.update(id="123e4567-e89b-12d3-a456-426614174000", title="Norra distriktet", external={
        "source_id": "12345678",
    }, description="Norra grundskole- och förskoleenheten")

    # Handle response
    print(res)
{
  "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": "Norra distriktet",
  "description": "Norra grundskole- och förskoleenheten"
}

Documentation Index

Fetch the complete documentation index at: https://docs.meitner.se/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the Unit to update

Example:

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

Body

application/json

Request body

​
title
string
required

The title of the unit

Example:

"Norra distriktet"

​
external
object

External is the External-object used on Update and Create operations, since it should only be allowed to set SourceID for the unit, the Source-field is not included.

Example:
{ "sourceID": "12345678" }
​
description
string | null

The description of the unit

Examples:

"Norra grundskole- och förskoleenheten"

null

Response

Response for Unit Update operation - returns the updated Unit

The Unit resource represents an organizational unit that schools can belong to. This resource can be created, updated, listed, retrieved, and searched using the standard resource structure.

​
id
string<uuid>
required

Unique identifier for the Unit

Example:

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

​
title
string
required

The title of the unit

Example:

"Norra distriktet"

​
meta
object

Metadata information for the Unit

Example:
{
  "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
object

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

Example:
{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}
​
description
string | null

The description of the unit

Examples:

"Norra grundskole- och förskoleenheten"

null