Create a new Guardian

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.create(identity_number="20191216-1234", first_name="Lise", last_name="Meitner", external={
        "source_id": "12345678",
    }, identity_temporary=True, address={
        "postal_address": "Dalvägen 14",
        "postal_code": "169 56",
        "postal_city": "Solna",
        "country_code": "SWE",
        "municipality_code": "0184",
    }, email_address1="[email protected]", email_address2="[email protected]", phone_number1="+46701234567", phone_number2="+46701234567", student_i_ds=[
        "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"
  ]
}

POST

guardian

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.create(identity_number="20191216-1234", first_name="Lise", last_name="Meitner", external={
        "source_id": "12345678",
    }, identity_temporary=True, address={
        "postal_address": "Dalvägen 14",
        "postal_code": "169 56",
        "postal_city": "Solna",
        "country_code": "SWE",
        "municipality_code": "0184",
    }, email_address1="[email protected]", email_address2="[email protected]", phone_number1="+46701234567", phone_number2="+46701234567", student_i_ds=[
        "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

Body

application/json

Request body

identityNumber

string

required

The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization.

Example:

"20191216-1234"

firstName

string

required

The first name of the guardian

Example:

"Lise"

lastName

string

required

The last name of the guardian

Example:

"Meitner"

external

object

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

Show child attributes

Example:

{ "sourceID": "12345678" }

identityTemporary

boolean

default:false

If the identity number is temporary for the guardian

Example:

true

address

object

The address of the guardian

Show child attributes

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.

Examples:

"[email protected]"

null

emailAddress2

string | null

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

Examples:

"[email protected]"

null

phoneNumber1

string | null

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

Examples:

"+46701234567"

null

phoneNumber2

string | null

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

Examples:

"+46701234567"

null

studentIDs

string<uuid>[]

The IDs of the students the guardian is responsible for.

Example:

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

Response

Response for Guardian Create operation - returns the created Guardian

Guardian holds the information about a guardian of a student.

string<uuid>

required

Unique identifier for the Guardian

Example:

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

identityNumber

string

required

The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization.

Example:

"20191216-1234"

firstName

string

required

The first name of the guardian

Example:

"Lise"

lastName

string

required

The last name of the guardian

Example:

"Meitner"

meta

object

Metadata information for the Guardian

Show child attributes

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.

Show child attributes

Example:

{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}

identityTemporary

boolean

default:false

If the identity number is temporary for the guardian

Example:

true

address

object

The address of the guardian

Show child attributes

Example:

{
  "postalAddress": "Dalvägen 14",
  "postalCode": "169 56",
  "postalCity": "Solna",
  "countryCode": "SWE",
  "municipalityCode": "0184"
}

emailAddress1

string | null

Examples:

"[email protected]"

null

emailAddress2

string | null

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

Examples:

"[email protected]"

null

phoneNumber1

string | null

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

Examples:

"+46701234567"

null

phoneNumber2

string | null

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

Examples:

"+46701234567"

null

studentIDs

string<uuid>[]

The IDs of the students the guardian is responsible for.

Example:

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

List Guardians Search Guardians

⌘I

Getting started

Guides

Reference

Authorizations

Body

Response