Search StudentPlacements

from datetime import date from meitner import Meitner, models from meitner.utils import parse_datetime 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.student_placements.search(filter_={ "equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "student_id": "123e4567-e89b-12d3-a456-426614174000", "school_id": "123e4567-e89b-12d3-a456-426614174000", "has_childcare": True, "mother_tongue": "example", "swedish_as_second_language": True, "mother_tongue_participates": True, "modern_language_in_school_choice": "example", "modern_language_in_language_choice": "example", "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archive_year": "example", "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "not_equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "student_id": "123e4567-e89b-12d3-a456-426614174000", "school_id": "123e4567-e89b-12d3-a456-426614174000", "has_childcare": True, "mother_tongue": "example", "swedish_as_second_language": True, "mother_tongue_participates": True, "modern_language_in_school_choice": "example", "modern_language_in_language_choice": "example", "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archive_year": "example", "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "greater_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "smaller_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "greater_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "smaller_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), }, "contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "student_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "school_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "has_childcare": [ True, ], "mother_tongue": [ "example", ], "swedish_as_second_language": [ True, ], "mother_tongue_participates": [ True, ], "modern_language_in_school_choice": [ "example", ], "modern_language_in_language_choice": [ "example", ], "start_date": [ date.fromisoformat("2024-01-15"), ], "end_date": [ date.fromisoformat("2024-01-15"), ], "archive_year": [ "example", ], }, "not_contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "student_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "school_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "has_childcare": [ True, ], "mother_tongue": [ "example", ], "swedish_as_second_language": [ True, ], "mother_tongue_participates": [ True, ], "modern_language_in_school_choice": [ "example", ], "modern_language_in_language_choice": [ "example", ], "start_date": [ date.fromisoformat("2024-01-15"), ], "end_date": [ date.fromisoformat("2024-01-15"), ], "archive_year": [ "example", ], }, "like": { "external": { "source_id": "example", "source": "example", }, "mother_tongue": "example", "modern_language_in_school_choice": "example", "modern_language_in_language_choice": "example", "archive_year": "example", }, "not_like": { "external": { "source_id": "example", "source": "example", }, "mother_tongue": "example", "modern_language_in_school_choice": "example", "modern_language_in_language_choice": "example", "archive_year": "example", }, "null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "school_year": True, "mother_tongue": True, "modern_language_alternative": True, "modern_language_in_school_choice": True, "modern_language_in_language_choice": True, "end_date": True, "archive_year": True, "archived_at": True, }, "not_null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "school_year": True, "mother_tongue": True, "modern_language_alternative": True, "modern_language_in_school_choice": True, "modern_language_in_language_choice": True, "end_date": True, "archive_year": True, "archived_at": True, }, "or_condition": True, }, 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" }, "studentID": "123e4567-e89b-12d3-a456-426614174000", "schoolID": "123e4567-e89b-12d3-a456-426614174000", "schoolType": "GR", "schoolYear": "1", "hasChildcare": true, "motherTongue": "SWE", "modernLanguageAlternative": "EN", "swedishAsSecondLanguage": false, "motherTongueParticipates": false, "modernLanguageInSchoolChoice": "deu", "modernLanguageInLanguageChoice": "fra", "startDate": "2024-08-01", "endDate": "2025-08-01", "archiveYear": "2024_2025", "archivedAt": "2024-08-01T00:00:00Z" } ], "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 StudentPlacements to return (default: 50) when searching StudentPlacements

Example:

1

offset

integer

default:0

The number of StudentPlacements to skip before starting to return results (default: 0) when searching StudentPlacements

Example:

0

Body

application/json

Request body

filter

object

required

Filter criteria to search for specific records

Show child attributes

Example:

{
  "equals": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-01-15T10:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "studentID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolID": "123e4567-e89b-12d3-a456-426614174000",
    "hasChildcare": true,
    "motherTongue": "example",
    "swedishAsSecondLanguage": true,
    "motherTongueParticipates": true,
    "modernLanguageInSchoolChoice": "example",
    "modernLanguageInLanguageChoice": "example",
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archiveYear": "example",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "notEquals": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-01-15T10:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "studentID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolID": "123e4567-e89b-12d3-a456-426614174000",
    "hasChildcare": true,
    "motherTongue": "example",
    "swedishAsSecondLanguage": true,
    "motherTongueParticipates": true,
    "modernLanguageInSchoolChoice": "example",
    "modernLanguageInLanguageChoice": "example",
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archiveYear": "example",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "greaterThan": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "smallerThan": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "greaterOrEqual": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "smallerOrEqual": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    "startDate": "2024-01-15",
    "endDate": "2024-01-15",
    "archivedAt": "2024-01-15T10:30:00Z"
  },
  "contains": {
    "id": ["123e4567-e89b-12d3-a456-426614174000"],
    "meta": {
      "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
      "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
    },
    "external": {
      "sourceID": ["example"],
      "source": ["example"]
    },
    "studentID": ["123e4567-e89b-12d3-a456-426614174000"],
    "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
    "hasChildcare": [true],
    "motherTongue": ["example"],
    "swedishAsSecondLanguage": [true],
    "motherTongueParticipates": [true],
    "modernLanguageInSchoolChoice": ["example"],
    "modernLanguageInLanguageChoice": ["example"],
    "startDate": ["2024-01-15"],
    "endDate": ["2024-01-15"],
    "archiveYear": ["example"]
  },
  "notContains": {
    "id": ["123e4567-e89b-12d3-a456-426614174000"],
    "meta": {
      "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
      "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
    },
    "external": {
      "sourceID": ["example"],
      "source": ["example"]
    },
    "studentID": ["123e4567-e89b-12d3-a456-426614174000"],
    "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
    "hasChildcare": [true],
    "motherTongue": ["example"],
    "swedishAsSecondLanguage": [true],
    "motherTongueParticipates": [true],
    "modernLanguageInSchoolChoice": ["example"],
    "modernLanguageInLanguageChoice": ["example"],
    "startDate": ["2024-01-15"],
    "endDate": ["2024-01-15"],
    "archiveYear": ["example"]
  },
  "like": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "motherTongue": "example",
    "modernLanguageInSchoolChoice": "example",
    "modernLanguageInLanguageChoice": "example",
    "archiveYear": "example"
  },
  "notLike": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "motherTongue": "example",
    "modernLanguageInSchoolChoice": "example",
    "modernLanguageInLanguageChoice": "example",
    "archiveYear": "example"
  },
  "null": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "schoolYear": true,
    "motherTongue": true,
    "modernLanguageAlternative": true,
    "modernLanguageInSchoolChoice": true,
    "modernLanguageInLanguageChoice": true,
    "endDate": true,
    "archiveYear": true,
    "archivedAt": true
  },
  "notNull": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "schoolYear": true,
    "motherTongue": true,
    "modernLanguageAlternative": true,
    "modernLanguageInSchoolChoice": true,
    "modernLanguageInLanguageChoice": true,
    "endDate": true,
    "archiveYear": true,
    "archivedAt": true
  },
  "orCondition": true
}

Response

Response for StudentPlacement Search operation - returns filtered StudentPlacement results

data

object[]

Array of StudentPlacement objects

Show child attributes

Example:

[
  {
    "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"
    },
    "studentID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolType": "GR",
    "schoolYear": "1",
    "hasChildcare": true,
    "motherTongue": "SWE",
    "modernLanguageAlternative": "EN",
    "swedishAsSecondLanguage": false,
    "motherTongueParticipates": false,
    "modernLanguageInSchoolChoice": "deu",
    "modernLanguageInLanguageChoice": "fra",
    "startDate": "2024-08-01",
    "endDate": "2025-08-01",
    "archiveYear": "2024_2025",
    "archivedAt": "2024-08-01T00:00:00Z"
  }
]

pagination

object

Pagination information

Show child attributes

Example:

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

Getting started

Guides

Reference

Search StudentPlacements

Authorizations

Query Parameters

Body

Response