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


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

    res = m_client.guardians.get(id="123e4567-e89b-12d3-a456-426614174000")

    # 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"
  },
  "identityNumber": "20191216-1234",
  "identityTemporary": true,
  "firstName": "Lise",
  "lastName": "Meitner",
  "address": {
    "postalAddress": "Dalvägen 14",
    "postalCode": "169 56",
    "postalCity": "Solna",
    "countryCode": "SWE",
    "municipalityCode": "0184"
  },
  "emailAddress1": "[email protected]",
  "emailAddress2": "[email protected]",
  "phoneNumber1": "+46701234567",
  "phoneNumber2": "+46701234567",
  "studentIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Authorizations

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the Guardian to retrieve

Response

Response for Guardian Get operation - returns the requested Guardian

Guardian holds the information about a guardian of a student.

​
id
string<uuid>
required

Unique identifier for the Guardian

​
identityNumber
string
required

The identity number of the guardian, must be unique within the organization.

​
firstName
string
required

The first name of the guardian

​
lastName
string
required

The last name of the guardian

​
meta
object

Metadata information for the Guardian

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 guardian from another system, used for third-party integration tracking.

Example:
{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}
​
identityTemporary
boolean
default:false

If the identity number is temporary for the guardian

​
address
object

The address of the guardian

Example:
{
  "postalAddress": "Dalvägen 14",
  "postalCode": "169 56",
  "postalCity": "Solna",
  "countryCode": "SWE",
  "municipalityCode": "0184"
}
​
emailAddress1
string | null

The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

​
emailAddress2
string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

​
phoneNumber1
string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

​
phoneNumber2
string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

​
studentIDs
string<uuid>[]

The IDs of the students the guardian is responsible for.