List Students

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.students.list(limit=1, offset=0)

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "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"
      },
      "gender": "Female",
      "identityNumber": "20191216-1234",
      "identityTemporary": true,
      "firstName": "Lise",
      "lastName": "Meitner",
      "dateOfBirth": "2019-12-16",
      "address": {
        "postalAddress": "Dalvägen 14",
        "postalCode": "169 56",
        "postalCity": "Solna",
        "countryCode": "SWE",
        "municipalityCode": "0184"
      },
      "emailAddress1": "[email protected]",
      "emailAddress2": "[email protected]",
      "phoneNumber1": "+46701234567",
      "phoneNumber2": "example"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

GET

student

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.students.list(limit=1, offset=0)

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "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"
      },
      "gender": "Female",
      "identityNumber": "20191216-1234",
      "identityTemporary": true,
      "firstName": "Lise",
      "lastName": "Meitner",
      "dateOfBirth": "2019-12-16",
      "address": {
        "postalAddress": "Dalvägen 14",
        "postalCode": "169 56",
        "postalCity": "Solna",
        "countryCode": "SWE",
        "municipalityCode": "0184"
      },
      "emailAddress1": "[email protected]",
      "emailAddress2": "[email protected]",
      "phoneNumber1": "+46701234567",
      "phoneNumber2": "example"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

Authorizations

Client-ID

string

header

required

Client-Secret

string

header

required

Query Parameters

limit

integer

default:50

The maximum number of Students to return (default: 50) when listing Students

offset

integer

default:0

The number of Students to skip before starting to return results (default: 0) when listing Students

Response

Response for Student List operation - returns a paginated list of Student

data

object[]

Array of Student objects

Show child attributes

data.id

string<uuid>

required

Unique identifier for the Student

data.identityNumber

string

required

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

data.firstName

string

required

The first name of the student

data.lastName

string

required

The last name of the student

data.meta

object

Metadata information for the Student

Show child attributes

data.meta.createdAt

string<date-time>

required

Timestamp when the resource was created

data.meta.createdBy

string<uuid> | null

User who created the resource

data.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

data.meta.updatedBy

string<uuid> | null

User who last updated the resource

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"
}

data.external

object

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

Show child attributes

data.external.sourceID

string | null

The ID of the external source

data.external.source

string | null

The source of the external information

Example:

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

data.gender

enum<string>

The gender of the student

Available options:

Female,

Male,

Other

Example:

"Female"

data.identityTemporary

boolean

default:false

If the identity number is temporary for the student

data.dateOfBirth

string<date> | null

The date of birth of the student

data.address

object

The address of the student

Show child attributes

data.address.postalAddress

string | null

The postal address of the address

data.address.postalCode

string | null

The postal code of the address

data.address.postalCity

string | null

The city of the address

data.address.countryCode

string | null

The country code of the address

data.address.municipalityCode

string | null

The municipality code of the address

Example:

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

data.emailAddress1

string | null

The primary email address of the student, will be used for communication with the student 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.

data.emailAddress2

string | null

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

data.phoneNumber1

string | null

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

data.phoneNumber2

string | null

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

pagination

object

Pagination information

Show child attributes

pagination.offset

integer

required

Number of items to skip from the beginning of the result set

pagination.limit

integer

required

Maximum number of items to return in the result set

pagination.total

integer

required

Total number of items available for pagination

Example:

{ "offset": 0, "limit": 1, "total": 100 }

Update a Guardian Create a new Student

⌘I

Getting started

Guides

Reference

Authorizations

Query Parameters

Response