from datetime import date
from meitner import Meitner, models
from meitner.utils import parse_datetime
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.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",
},
"identity_number": "example",
"identity_temporary": True,
"first_name": "example",
"last_name": "example",
"date_of_birth": date.fromisoformat("2024-01-15"),
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"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",
},
"identity_number": "example",
"identity_temporary": True,
"first_name": "example",
"last_name": "example",
"date_of_birth": date.fromisoformat("2024-01-15"),
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"greater_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"smaller_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"greater_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"smaller_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"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",
],
},
"identity_number": [
"example",
],
"identity_temporary": [
True,
],
"first_name": [
"example",
],
"last_name": [
"example",
],
"date_of_birth": [
date.fromisoformat("2024-01-15"),
],
"address": {
"postal_address": [
"example",
],
"postal_code": [
"example",
],
"postal_city": [
"example",
],
"country_code": [
"example",
],
"municipality_code": [
"example",
],
},
"email_address1": [
"example",
],
"email_address2": [
"example",
],
"phone_number1": [
"example",
],
"phone_number2": [
"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",
],
},
"identity_number": [
"example",
],
"identity_temporary": [
True,
],
"first_name": [
"example",
],
"last_name": [
"example",
],
"date_of_birth": [
date.fromisoformat("2024-01-15"),
],
"address": {
"postal_address": [
"example",
],
"postal_code": [
"example",
],
"postal_city": [
"example",
],
"country_code": [
"example",
],
"municipality_code": [
"example",
],
},
"email_address1": [
"example",
],
"email_address2": [
"example",
],
"phone_number1": [
"example",
],
"phone_number2": [
"example",
],
},
"like": {
"external": {
"source_id": "example",
"source": "example",
},
"identity_number": "example",
"first_name": "example",
"last_name": "example",
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"not_like": {
"external": {
"source_id": "example",
"source": "example",
},
"identity_number": "example",
"first_name": "example",
"last_name": "example",
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"gender": True,
"date_of_birth": True,
"address": {
"postal_address": True,
"postal_code": True,
"postal_city": True,
"country_code": True,
"municipality_code": True,
},
"email_address1": True,
"email_address2": True,
"phone_number1": True,
"phone_number2": True,
},
"not_null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"gender": True,
"date_of_birth": True,
"address": {
"postal_address": True,
"postal_code": True,
"postal_city": True,
"country_code": True,
"municipality_code": True,
},
"email_address1": True,
"email_address2": True,
"phone_number1": True,
"phone_number2": 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"
},
"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
}
}Search Students
Search for Students with filtering capabilities.
from datetime import date
from meitner import Meitner, models
from meitner.utils import parse_datetime
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.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",
},
"identity_number": "example",
"identity_temporary": True,
"first_name": "example",
"last_name": "example",
"date_of_birth": date.fromisoformat("2024-01-15"),
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"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",
},
"identity_number": "example",
"identity_temporary": True,
"first_name": "example",
"last_name": "example",
"date_of_birth": date.fromisoformat("2024-01-15"),
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"greater_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"smaller_than": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"greater_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"smaller_or_equal": {
"meta": {
"created_at": parse_datetime("2024-01-15T10:30:00Z"),
"updated_at": parse_datetime("2024-01-15T10:30:00Z"),
},
"date_of_birth": date.fromisoformat("2024-01-15"),
},
"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",
],
},
"identity_number": [
"example",
],
"identity_temporary": [
True,
],
"first_name": [
"example",
],
"last_name": [
"example",
],
"date_of_birth": [
date.fromisoformat("2024-01-15"),
],
"address": {
"postal_address": [
"example",
],
"postal_code": [
"example",
],
"postal_city": [
"example",
],
"country_code": [
"example",
],
"municipality_code": [
"example",
],
},
"email_address1": [
"example",
],
"email_address2": [
"example",
],
"phone_number1": [
"example",
],
"phone_number2": [
"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",
],
},
"identity_number": [
"example",
],
"identity_temporary": [
True,
],
"first_name": [
"example",
],
"last_name": [
"example",
],
"date_of_birth": [
date.fromisoformat("2024-01-15"),
],
"address": {
"postal_address": [
"example",
],
"postal_code": [
"example",
],
"postal_city": [
"example",
],
"country_code": [
"example",
],
"municipality_code": [
"example",
],
},
"email_address1": [
"example",
],
"email_address2": [
"example",
],
"phone_number1": [
"example",
],
"phone_number2": [
"example",
],
},
"like": {
"external": {
"source_id": "example",
"source": "example",
},
"identity_number": "example",
"first_name": "example",
"last_name": "example",
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"not_like": {
"external": {
"source_id": "example",
"source": "example",
},
"identity_number": "example",
"first_name": "example",
"last_name": "example",
"address": {
"postal_address": "example",
"postal_code": "example",
"postal_city": "example",
"country_code": "example",
"municipality_code": "example",
},
"email_address1": "example",
"email_address2": "example",
"phone_number1": "example",
"phone_number2": "example",
},
"null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"gender": True,
"date_of_birth": True,
"address": {
"postal_address": True,
"postal_code": True,
"postal_city": True,
"country_code": True,
"municipality_code": True,
},
"email_address1": True,
"email_address2": True,
"phone_number1": True,
"phone_number2": True,
},
"not_null": {
"meta": {
"created_by": True,
"updated_at": True,
"updated_by": True,
},
"external": {
"source_id": True,
"source": True,
},
"gender": True,
"date_of_birth": True,
"address": {
"postal_address": True,
"postal_code": True,
"postal_city": True,
"country_code": True,
"municipality_code": True,
},
"email_address1": True,
"email_address2": True,
"phone_number1": True,
"phone_number2": 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"
},
"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
}
}Query Parameters
The maximum number of Students to return (default: 50) when searching Students
The number of Students to skip before starting to return results (default: 0) when searching Students
Body
Request body
Filter criteria to search for specific records
Show child attributes
Show child attributes
OrCondition decides if this filter is within an OR-condition or AND-condition
Equality filters for Student
Show child attributes
Show child attributes
Unique identifier for the Student
Metadata information for the Student
Show child attributes
Show child attributes
Timestamp when the resource was created
User who created the resource
Timestamp when the resource was last updated
User who last updated the resource
{
"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 is a reusable object that can be used to store external information about the student from another system, used for third-party integration tracking.
{
"sourceID": "example",
"source": "example"
}The gender of the student
Female, Male, Other The identity number of the student, must be unique within the organization.
If the identity number is temporary for the student
The first name of the student
The last name of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"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"
},
"identityNumber": "example",
"identityTemporary": true,
"firstName": "example",
"lastName": "example",
"dateOfBirth": "2024-01-15",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
}Inequality filters for Student
Show child attributes
Show child attributes
Unique identifier for the Student
Metadata information for the Student
Show child attributes
Show child attributes
Timestamp when the resource was created
User who created the resource
Timestamp when the resource was last updated
User who last updated the resource
{
"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 is a reusable object that can be used to store external information about the student from another system, used for third-party integration tracking.
{
"sourceID": "example",
"source": "example"
}The gender of the student
Female, Male, Other The identity number of the student, must be unique within the organization.
If the identity number is temporary for the student
The first name of the student
The last name of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"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"
},
"identityNumber": "example",
"identityTemporary": true,
"firstName": "example",
"lastName": "example",
"dateOfBirth": "2024-01-15",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
}Greater than filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
The date of birth of the student
The address of the student
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
}Smaller than filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
The date of birth of the student
The address of the student
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
}Greater than or equal filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
The date of birth of the student
The address of the student
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
}Smaller than or equal filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}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.
The date of birth of the student
The address of the student
{
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
}Contains filters for Student
Show child attributes
Show child attributes
Unique identifier for the Student
Metadata information for the Student
{
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}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.
{
"sourceID": ["example"],
"source": ["example"]
}The gender of the student
The gender of the person
Female, Male, Other The identity number of the student, must be unique within the organization.
If the identity number is temporary for the student
The first name of the student
The last name of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"identityNumber": ["example"],
"identityTemporary": [true],
"firstName": ["example"],
"lastName": ["example"],
"dateOfBirth": ["2024-01-15"],
"address": {
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
},
"emailAddress1": ["example"],
"emailAddress2": ["example"],
"phoneNumber1": ["example"],
"phoneNumber2": ["example"]
}Not contains filters for Student
Show child attributes
Show child attributes
Unique identifier for the Student
Metadata information for the Student
{
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}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.
{
"sourceID": ["example"],
"source": ["example"]
}The gender of the student
The gender of the person
Female, Male, Other The identity number of the student, must be unique within the organization.
If the identity number is temporary for the student
The first name of the student
The last name of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"id": ["123e4567-e89b-12d3-a456-426614174000"],
"meta": {
"createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
"updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
},
"external": {
"sourceID": ["example"],
"source": ["example"]
},
"identityNumber": ["example"],
"identityTemporary": [true],
"firstName": ["example"],
"lastName": ["example"],
"dateOfBirth": ["2024-01-15"],
"address": {
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
},
"emailAddress1": ["example"],
"emailAddress2": ["example"],
"phoneNumber1": ["example"],
"phoneNumber2": ["example"]
}LIKE filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
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.
{
"sourceID": "example",
"source": "example"
}The identity number of the student, must be unique within the organization.
The first name of the student
The last name of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"external": {
"sourceID": "example",
"source": "example"
},
"identityNumber": "example",
"firstName": "example",
"lastName": "example",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
}NOT LIKE filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
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.
{
"sourceID": "example",
"source": "example"
}The identity number of the student, must be unique within the organization.
The first name of the student
The last name of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"external": {
"sourceID": "example",
"source": "example"
},
"identityNumber": "example",
"firstName": "example",
"lastName": "example",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
}Null filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdBy": true,
"updatedAt": true,
"updatedBy": true
}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.
{ "sourceID": true, "source": true }The gender of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"gender": true,
"dateOfBirth": true,
"address": {
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
},
"emailAddress1": true,
"emailAddress2": true,
"phoneNumber1": true,
"phoneNumber2": true
}Not null filters for Student
Show child attributes
Show child attributes
Metadata information for the Student
{
"createdBy": true,
"updatedAt": true,
"updatedBy": true
}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.
{ "sourceID": true, "source": true }The gender of the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
{
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"gender": true,
"dateOfBirth": true,
"address": {
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
},
"emailAddress1": true,
"emailAddress2": true,
"phoneNumber1": true,
"phoneNumber2": true
}NestedFilters of the Student, useful for more complex filters
{
"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"
},
"identityNumber": "example",
"identityTemporary": true,
"firstName": "example",
"lastName": "example",
"dateOfBirth": "2024-01-15",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
},
"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"
},
"identityNumber": "example",
"identityTemporary": true,
"firstName": "example",
"lastName": "example",
"dateOfBirth": "2024-01-15",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"dateOfBirth": "2024-01-15"
},
"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"]
},
"identityNumber": ["example"],
"identityTemporary": [true],
"firstName": ["example"],
"lastName": ["example"],
"dateOfBirth": ["2024-01-15"],
"address": {
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
},
"emailAddress1": ["example"],
"emailAddress2": ["example"],
"phoneNumber1": ["example"],
"phoneNumber2": ["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"]
},
"identityNumber": ["example"],
"identityTemporary": [true],
"firstName": ["example"],
"lastName": ["example"],
"dateOfBirth": ["2024-01-15"],
"address": {
"postalAddress": ["example"],
"postalCode": ["example"],
"postalCity": ["example"],
"countryCode": ["example"],
"municipalityCode": ["example"]
},
"emailAddress1": ["example"],
"emailAddress2": ["example"],
"phoneNumber1": ["example"],
"phoneNumber2": ["example"]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"identityNumber": "example",
"firstName": "example",
"lastName": "example",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"identityNumber": "example",
"firstName": "example",
"lastName": "example",
"address": {
"postalAddress": "example",
"postalCode": "example",
"postalCity": "example",
"countryCode": "example",
"municipalityCode": "example"
},
"emailAddress1": "example",
"emailAddress2": "example",
"phoneNumber1": "example",
"phoneNumber2": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"gender": true,
"dateOfBirth": true,
"address": {
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
},
"emailAddress1": true,
"emailAddress2": true,
"phoneNumber1": true,
"phoneNumber2": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": { "sourceID": true, "source": true },
"gender": true,
"dateOfBirth": true,
"address": {
"postalAddress": true,
"postalCode": true,
"postalCity": true,
"countryCode": true,
"municipalityCode": true
},
"emailAddress1": true,
"emailAddress2": true,
"phoneNumber1": true,
"phoneNumber2": true
},
"orCondition": true
}Response
Response for Student Search operation - returns filtered Student results
Array of Student objects
Show child attributes
Show child attributes
Unique identifier for the Student
The identity number of the student, must be unique within the organization.
The first name of the student
The last name of the student
Metadata information for the Student
Show child attributes
Show child attributes
Timestamp when the resource was created
User who created the resource
Timestamp when the resource was last updated
User who last updated the resource
{
"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 is a reusable object that can be used to store external information about the student from another system, used for third-party integration tracking.
{
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
}The gender of the student
Female, Male, Other "Female"
If the identity number is temporary for the student
The date of birth of the student
The address of the student
Show child attributes
Show child attributes
The postal address of the address
The postal code of the address
The city of the address
The country code of the address
The municipality code of the address
{
"postalAddress": "Dalvägen 14",
"postalCode": "169 56",
"postalCity": "Solna",
"countryCode": "SWE",
"municipalityCode": "0184"
}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.
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
The primary phone number of the student, will be used for communication with the student from the system.
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
Pagination information
{ "offset": 0, "limit": 1, "total": 100 }