Search StudentPlacements

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

offset

integer

default:0

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

Body

application/json

Request body

filter

object

required

Filter criteria to search for specific records

Show child attributes

filter.orCondition

boolean

required

OrCondition decides if this filter is within an OR-condition or AND-condition

filter.equals

object

Equality filters for StudentPlacement

Show child attributes

filter.equals.id

string<uuid> | null

Unique identifier for the StudentPlacement

filter.equals.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.equals.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.equals.meta.createdBy

string<uuid> | null

User who created the resource

filter.equals.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

filter.equals.meta.updatedBy

string<uuid> | null

User who last updated the resource

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-15T10:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

filter.equals.external

object

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

Show child attributes

filter.equals.external.sourceID

string | null

The ID of the external source

filter.equals.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.equals.studentID

string<uuid> | null

The ID of the student the placement belongs to

filter.equals.schoolID

string<uuid> | null

The ID of the school the student is placed in

filter.equals.schoolType

enum<string>

The school type for the student, if not provided on Create, the school type will be fetched from the school.

Available options:

GR,

GRAN,

GY,

GYAN,

FS

filter.equals.schoolYear

enum<string>

The school year the student is placed in

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

filter.equals.hasChildcare

boolean | null

Whether the student has childcare

filter.equals.motherTongue

string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.equals.startDate

string<date> | null

The start date of the placement

filter.equals.endDate

string<date> | null

The end date of the placement

filter.equals.archiveYear

string | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

filter.equals.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

{
  "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",
  "startDate": "2024-01-15",
  "endDate": "2024-01-15",
  "archiveYear": "example",
  "archivedAt": "2024-01-15T10:30:00Z"
}

filter.notEquals

object

Inequality filters for StudentPlacement

Show child attributes

filter.notEquals.id

string<uuid> | null

Unique identifier for the StudentPlacement

filter.notEquals.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.notEquals.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.notEquals.meta.createdBy

string<uuid> | null

User who created the resource

filter.notEquals.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

filter.notEquals.meta.updatedBy

string<uuid> | null

User who last updated the resource

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-15T10:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

filter.notEquals.external

object

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

Show child attributes

filter.notEquals.external.sourceID

string | null

The ID of the external source

filter.notEquals.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.notEquals.studentID

string<uuid> | null

The ID of the student the placement belongs to

filter.notEquals.schoolID

string<uuid> | null

The ID of the school the student is placed in

filter.notEquals.schoolType

enum<string>

The school type for the student, if not provided on Create, the school type will be fetched from the school.

Available options:

GR,

GRAN,

GY,

GYAN,

FS

filter.notEquals.schoolYear

enum<string>

The school year the student is placed in

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

filter.notEquals.hasChildcare

boolean | null

Whether the student has childcare

filter.notEquals.motherTongue

string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.notEquals.startDate

string<date> | null

The start date of the placement

filter.notEquals.endDate

string<date> | null

The end date of the placement

filter.notEquals.archiveYear

string | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

filter.notEquals.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

{
  "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",
  "startDate": "2024-01-15",
  "endDate": "2024-01-15",
  "archiveYear": "example",
  "archivedAt": "2024-01-15T10:30:00Z"
}

filter.greaterThan

object

Greater than filters for StudentPlacement

Show child attributes

filter.greaterThan.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.greaterThan.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.greaterThan.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.greaterThan.external

object

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

filter.greaterThan.startDate

string<date> | null

The start date of the placement

filter.greaterThan.endDate

string<date> | null

The end date of the placement

filter.greaterThan.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

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

filter.smallerThan

object

Smaller than filters for StudentPlacement

Show child attributes

filter.smallerThan.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.smallerThan.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.smallerThan.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.smallerThan.external

object

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

filter.smallerThan.startDate

string<date> | null

The start date of the placement

filter.smallerThan.endDate

string<date> | null

The end date of the placement

filter.smallerThan.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

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

filter.greaterOrEqual

object

Greater than or equal filters for StudentPlacement

Show child attributes

filter.greaterOrEqual.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.greaterOrEqual.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.greaterOrEqual.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.greaterOrEqual.external

object

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

filter.greaterOrEqual.startDate

string<date> | null

The start date of the placement

filter.greaterOrEqual.endDate

string<date> | null

The end date of the placement

filter.greaterOrEqual.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

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

filter.smallerOrEqual

object

Smaller than or equal filters for StudentPlacement

Show child attributes

filter.smallerOrEqual.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.smallerOrEqual.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.smallerOrEqual.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.smallerOrEqual.external

object

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

filter.smallerOrEqual.startDate

string<date> | null

The start date of the placement

filter.smallerOrEqual.endDate

string<date> | null

The end date of the placement

filter.smallerOrEqual.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

Example:

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

filter.contains

object

Contains filters for StudentPlacement

Show child attributes

filter.contains.id

string<uuid>[]

Unique identifier for the StudentPlacement

filter.contains.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.contains.meta.createdBy

string<uuid>[]

User who created the resource

filter.contains.meta.updatedBy

string<uuid>[]

User who last updated the resource

Example:

{
  "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
  "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.contains.external

object

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

Show child attributes

filter.contains.external.sourceID

string[]

The ID of the external source

filter.contains.external.source

string[]

The source of the external information

Example:

{
  "sourceID": ["example"],
  "source": ["example"]
}

filter.contains.studentID

string<uuid>[]

The ID of the student the placement belongs to

filter.contains.schoolID

string<uuid>[]

The ID of the school the student is placed in

filter.contains.schoolType

enum<string>[]

The school type for the student, if not provided on Create, the school type will be fetched from the school.

The type of schooling the student is attending

Available options:

GR,

GRAN,

GY,

GYAN,

FS

filter.contains.schoolYear

enum<string>[]

The school year the student is placed in

The school year the student is attending

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

filter.contains.hasChildcare

boolean[]

Whether the student has childcare

filter.contains.motherTongue

string[]

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.contains.startDate

string<date>[]

The start date of the placement

filter.contains.endDate

string<date>[]

The end date of the placement

filter.contains.archiveYear

string[]

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

Example:

{
  "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"],
  "startDate": ["2024-01-15"],
  "endDate": ["2024-01-15"],
  "archiveYear": ["example"]
}

filter.notContains

object

Not contains filters for StudentPlacement

Show child attributes

filter.notContains.id

string<uuid>[]

Unique identifier for the StudentPlacement

filter.notContains.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.notContains.meta.createdBy

string<uuid>[]

User who created the resource

filter.notContains.meta.updatedBy

string<uuid>[]

User who last updated the resource

Example:

{
  "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
  "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.notContains.external

object

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

Show child attributes

filter.notContains.external.sourceID

string[]

The ID of the external source

filter.notContains.external.source

string[]

The source of the external information

Example:

{
  "sourceID": ["example"],
  "source": ["example"]
}

filter.notContains.studentID

string<uuid>[]

The ID of the student the placement belongs to

filter.notContains.schoolID

string<uuid>[]

The ID of the school the student is placed in

filter.notContains.schoolType

enum<string>[]

The school type for the student, if not provided on Create, the school type will be fetched from the school.

The type of schooling the student is attending

Available options:

GR,

GRAN,

GY,

GYAN,

FS

filter.notContains.schoolYear

enum<string>[]

The school year the student is placed in

The school year the student is attending

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

filter.notContains.hasChildcare

boolean[]

Whether the student has childcare

filter.notContains.motherTongue

string[]

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.notContains.startDate

string<date>[]

The start date of the placement

filter.notContains.endDate

string<date>[]

The end date of the placement

filter.notContains.archiveYear

string[]

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

Example:

{
  "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"],
  "startDate": ["2024-01-15"],
  "endDate": ["2024-01-15"],
  "archiveYear": ["example"]
}

filter.like

object

LIKE filters for StudentPlacement

Show child attributes

filter.like.meta

object

Metadata information for the StudentPlacement

filter.like.external

object

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

Show child attributes

filter.like.external.sourceID

string | null

The ID of the external source

filter.like.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.like.motherTongue

string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.like.archiveYear

string | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

Example:

{
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "motherTongue": "example",
  "archiveYear": "example"
}

filter.notLike

object

NOT LIKE filters for StudentPlacement

Show child attributes

filter.notLike.meta

object

Metadata information for the StudentPlacement

filter.notLike.external

object

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

Show child attributes

filter.notLike.external.sourceID

string | null

The ID of the external source

filter.notLike.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.notLike.motherTongue

string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.notLike.archiveYear

string | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

Example:

{
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "motherTongue": "example",
  "archiveYear": "example"
}

filter.null

object

Null filters for StudentPlacement

Show child attributes

filter.null.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.null.meta.createdBy

boolean | null

User who created the resource

filter.null.meta.updatedAt

boolean | null

Timestamp when the resource was last updated

filter.null.meta.updatedBy

boolean | null

User who last updated the resource

Example:

{
  "createdBy": true,
  "updatedAt": true,
  "updatedBy": true
}

filter.null.external

object

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

Show child attributes

filter.null.external.sourceID

boolean | null

The ID of the external source

filter.null.external.source

boolean | null

The source of the external information

Example:

{ "sourceID": true, "source": true }

filter.null.schoolYear

boolean | null

The school year the student is placed in

filter.null.motherTongue

boolean | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.null.endDate

boolean | null

The end date of the placement

filter.null.archiveYear

boolean | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

filter.null.archivedAt

boolean | null

The timestamp the placement was archived for the student

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "schoolYear": true,
  "motherTongue": true,
  "endDate": true,
  "archiveYear": true,
  "archivedAt": true
}

filter.notNull

object

Not null filters for StudentPlacement

Show child attributes

filter.notNull.meta

object

Metadata information for the StudentPlacement

Show child attributes

filter.notNull.meta.createdBy

boolean | null

User who created the resource

filter.notNull.meta.updatedAt

boolean | null

Timestamp when the resource was last updated

filter.notNull.meta.updatedBy

boolean | null

User who last updated the resource

Example:

{
  "createdBy": true,
  "updatedAt": true,
  "updatedBy": true
}

filter.notNull.external

object

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

Show child attributes

filter.notNull.external.sourceID

boolean | null

The ID of the external source

filter.notNull.external.source

boolean | null

The source of the external information

Example:

{ "sourceID": true, "source": true }

filter.notNull.schoolYear

boolean | null

The school year the student is placed in

filter.notNull.motherTongue

boolean | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

filter.notNull.endDate

boolean | null

The end date of the placement

filter.notNull.archiveYear

boolean | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

filter.notNull.archivedAt

boolean | null

The timestamp the placement was archived for the student

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "schoolYear": true,
  "motherTongue": true,
  "endDate": true,
  "archiveYear": true,
  "archivedAt": true
}

filter.nestedFilters

any[]

NestedFilters of the StudentPlacement, useful for more complex filters

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",
    "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",
    "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"],
    "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"],
    "startDate": ["2024-01-15"],
    "endDate": ["2024-01-15"],
    "archiveYear": ["example"]
  },
  "like": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "motherTongue": "example",
    "archiveYear": "example"
  },
  "notLike": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "motherTongue": "example",
    "archiveYear": "example"
  },
  "null": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "schoolYear": true,
    "motherTongue": true,
    "endDate": true,
    "archiveYear": true,
    "archivedAt": true
  },
  "notNull": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "schoolYear": true,
    "motherTongue": 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

data.id

string<uuid>

required

Unique identifier for the StudentPlacement

data.studentID

string<uuid>

required

The ID of the student the placement belongs to

data.schoolID

string<uuid>

required

The ID of the school the student is placed in

data.schoolType

enum<string>

required

The school type for the student, if not provided on Create, the school type will be fetched from the school.

Available options:

GR,

GRAN,

GY,

GYAN,

FS

Example:

"GR"

data.startDate

string<date>

required

The start date of the placement

data.meta

object

Metadata information for the StudentPlacement

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 placement 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.schoolYear

enum<string>

The school year the student is placed in

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

Example:

"1"

data.hasChildcare

boolean

default:false

Whether the student has childcare

data.motherTongue

string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

data.endDate

string<date> | null

The end date of the placement

data.archiveYear

string | null

The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

data.archivedAt

string<date-time> | null

The timestamp the placement was archived for the student

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 }

Getting started

Guides

Reference

Search StudentPlacements

Authorizations

Query Parameters

Body

Response