Search EmployeePlacements

Authorizations

Client-ID

string

header

required

Client-Secret

string

header

required

Query Parameters

limit

integer

default:50

The maximum number of EmployeePlacements to return (default: 50) when searching EmployeePlacements

offset

integer

default:0

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

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 EmployeePlacement

Show child attributes

filter.equals.id

string<uuid> | null

Unique identifier for the EmployeePlacement

filter.equals.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.employeeID

string<uuid> | null

The ID of the employee the placement belongs to

filter.equals.schoolID

string<uuid> | null

The ID of the school the placement belongs to

filter.equals.signature

string | null

The signature of the employee

filter.equals.title

string | null

The title of the employee

filter.equals.roles

enum<string>

The roles of the employee

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

filter.equals.startDate

string<date> | null

The start date of the placement for the employee

filter.equals.endDate

string<date> | null

The end date of the placement for the employee

filter.equals.archiveYear

string | null

The year the placement was archived for the employee, 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 employee

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"
  },
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "signature": "example",
  "title": "example",
  "startDate": "2024-01-15",
  "endDate": "2024-01-15",
  "archiveYear": "example",
  "archivedAt": "2024-01-15T10:30:00Z"
}

filter.notEquals

object

Inequality filters for EmployeePlacement

Show child attributes

filter.notEquals.id

string<uuid> | null

Unique identifier for the EmployeePlacement

filter.notEquals.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.employeeID

string<uuid> | null

The ID of the employee the placement belongs to

filter.notEquals.schoolID

string<uuid> | null

The ID of the school the placement belongs to

filter.notEquals.signature

string | null

The signature of the employee

filter.notEquals.title

string | null

The title of the employee

filter.notEquals.roles

enum<string>

The roles of the employee

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

filter.notEquals.startDate

string<date> | null

The start date of the placement for the employee

filter.notEquals.endDate

string<date> | null

The end date of the placement for the employee

filter.notEquals.archiveYear

string | null

The year the placement was archived for the employee, 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 employee

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"
  },
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "signature": "example",
  "title": "example",
  "startDate": "2024-01-15",
  "endDate": "2024-01-15",
  "archiveYear": "example",
  "archivedAt": "2024-01-15T10:30:00Z"
}

filter.greaterThan

object

Greater than filters for EmployeePlacement

Show child attributes

filter.greaterThan.meta

object

Metadata information for the EmployeePlacement

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 guardian from another system, used for third-party integration tracking.

filter.greaterThan.startDate

string<date> | null

The start date of the placement for the employee

filter.greaterThan.endDate

string<date> | null

The end date of the placement for the employee

filter.greaterThan.archivedAt

string<date-time> | null

The timestamp the placement was archived for the employee

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 EmployeePlacement

Show child attributes

filter.smallerThan.meta

object

Metadata information for the EmployeePlacement

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 guardian from another system, used for third-party integration tracking.

filter.smallerThan.startDate

string<date> | null

The start date of the placement for the employee

filter.smallerThan.endDate

string<date> | null

The end date of the placement for the employee

filter.smallerThan.archivedAt

string<date-time> | null

The timestamp the placement was archived for the employee

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 EmployeePlacement

Show child attributes

filter.greaterOrEqual.meta

object

Metadata information for the EmployeePlacement

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 guardian from another system, used for third-party integration tracking.

filter.greaterOrEqual.startDate

string<date> | null

The start date of the placement for the employee

filter.greaterOrEqual.endDate

string<date> | null

The end date of the placement for the employee

filter.greaterOrEqual.archivedAt

string<date-time> | null

The timestamp the placement was archived for the employee

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 EmployeePlacement

Show child attributes

filter.smallerOrEqual.meta

object

Metadata information for the EmployeePlacement

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 guardian from another system, used for third-party integration tracking.

filter.smallerOrEqual.startDate

string<date> | null

The start date of the placement for the employee

filter.smallerOrEqual.endDate

string<date> | null

The end date of the placement for the employee

filter.smallerOrEqual.archivedAt

string<date-time> | null

The timestamp the placement was archived for the employee

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 EmployeePlacement

Show child attributes

filter.contains.id

string<uuid>[]

Unique identifier for the EmployeePlacement

filter.contains.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.employeeID

string<uuid>[]

The ID of the employee the placement belongs to

filter.contains.schoolID

string<uuid>[]

The ID of the school the placement belongs to

filter.contains.signature

string[]

The signature of the employee

filter.contains.title

string[]

The title of the employee

filter.contains.roles

enum<string>[]

The roles of the employee

The role of the employee in the placement

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

filter.contains.startDate

string<date>[]

The start date of the placement for the employee

filter.contains.endDate

string<date>[]

The end date of the placement for the employee

filter.contains.archiveYear

string[]

The year the placement was archived for the employee, 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"]
  },
  "employeeID": ["123e4567-e89b-12d3-a456-426614174000"],
  "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
  "signature": ["example"],
  "title": ["example"],
  "startDate": ["2024-01-15"],
  "endDate": ["2024-01-15"],
  "archiveYear": ["example"]
}

filter.notContains

object

Not contains filters for EmployeePlacement

Show child attributes

filter.notContains.id

string<uuid>[]

Unique identifier for the EmployeePlacement

filter.notContains.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.employeeID

string<uuid>[]

The ID of the employee the placement belongs to

filter.notContains.schoolID

string<uuid>[]

The ID of the school the placement belongs to

filter.notContains.signature

string[]

The signature of the employee

filter.notContains.title

string[]

The title of the employee

filter.notContains.roles

enum<string>[]

The roles of the employee

The role of the employee in the placement

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

filter.notContains.startDate

string<date>[]

The start date of the placement for the employee

filter.notContains.endDate

string<date>[]

The end date of the placement for the employee

filter.notContains.archiveYear

string[]

The year the placement was archived for the employee, 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"]
  },
  "employeeID": ["123e4567-e89b-12d3-a456-426614174000"],
  "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
  "signature": ["example"],
  "title": ["example"],
  "startDate": ["2024-01-15"],
  "endDate": ["2024-01-15"],
  "archiveYear": ["example"]
}

filter.like

object

LIKE filters for EmployeePlacement

Show child attributes

filter.like.meta

object

Metadata information for the EmployeePlacement

filter.like.external

object

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

Show child attributes

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.signature

string | null

The signature of the employee

filter.like.title

string | null

The title of the employee

filter.like.archiveYear

string | null

The year the placement was archived for the employee, 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"
  },
  "signature": "example",
  "title": "example",
  "archiveYear": "example"
}

filter.notLike

object

NOT LIKE filters for EmployeePlacement

Show child attributes

filter.notLike.meta

object

Metadata information for the EmployeePlacement

filter.notLike.external

object

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

Show child attributes

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.signature

string | null

The signature of the employee

filter.notLike.title

string | null

The title of the employee

filter.notLike.archiveYear

string | null

The year the placement was archived for the employee, 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"
  },
  "signature": "example",
  "title": "example",
  "archiveYear": "example"
}

filter.null

object

Null filters for EmployeePlacement

Show child attributes

filter.null.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.signature

boolean | null

The signature of the employee

filter.null.title

boolean | null

The title of the employee

filter.null.roles

boolean | null

The roles of the employee

filter.null.endDate

boolean | null

The end date of the placement for the employee

filter.null.archiveYear

boolean | null

The year the placement was archived for the employee, 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 employee

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "signature": true,
  "title": true,
  "roles": true,
  "endDate": true,
  "archiveYear": true,
  "archivedAt": true
}

filter.notNull

object

Not null filters for EmployeePlacement

Show child attributes

filter.notNull.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.signature

boolean | null

The signature of the employee

filter.notNull.title

boolean | null

The title of the employee

filter.notNull.roles

boolean | null

The roles of the employee

filter.notNull.endDate

boolean | null

The end date of the placement for the employee

filter.notNull.archiveYear

boolean | null

The year the placement was archived for the employee, 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 employee

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "signature": true,
  "title": true,
  "roles": true,
  "endDate": true,
  "archiveYear": true,
  "archivedAt": true
}

filter.nestedFilters

any[]

NestedFilters of the EmployeePlacement, 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"
    },
    "employeeID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolID": "123e4567-e89b-12d3-a456-426614174000",
    "signature": "example",
    "title": "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"
    },
    "employeeID": "123e4567-e89b-12d3-a456-426614174000",
    "schoolID": "123e4567-e89b-12d3-a456-426614174000",
    "signature": "example",
    "title": "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"]
    },
    "employeeID": ["123e4567-e89b-12d3-a456-426614174000"],
    "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
    "signature": ["example"],
    "title": ["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"]
    },
    "employeeID": ["123e4567-e89b-12d3-a456-426614174000"],
    "schoolID": ["123e4567-e89b-12d3-a456-426614174000"],
    "signature": ["example"],
    "title": ["example"],
    "startDate": ["2024-01-15"],
    "endDate": ["2024-01-15"],
    "archiveYear": ["example"]
  },
  "like": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "signature": "example",
    "title": "example",
    "archiveYear": "example"
  },
  "notLike": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "signature": "example",
    "title": "example",
    "archiveYear": "example"
  },
  "null": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "signature": true,
    "title": true,
    "roles": true,
    "endDate": true,
    "archiveYear": true,
    "archivedAt": true
  },
  "notNull": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "signature": true,
    "title": true,
    "roles": true,
    "endDate": true,
    "archiveYear": true,
    "archivedAt": true
  },
  "orCondition": true
}

Response

Response for EmployeePlacement Search operation - returns filtered EmployeePlacement results

data

object[]

Array of EmployeePlacement objects

Show child attributes

data.id

string<uuid>

required

Unique identifier for the EmployeePlacement

data.employeeID

string<uuid>

required

The ID of the employee the placement belongs to

data.schoolID

string<uuid>

required

The ID of the school the placement belongs to

data.startDate

string<date>

required

The start date of the placement for the employee

data.meta

object

Metadata information for the EmployeePlacement

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 guardian 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.signature

string | null

The signature of the employee

data.title

string | null

The title of the employee

data.roles

enum<string>[]

The roles of the employee

The role of the employee in the placement

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

data.endDate

string<date> | null

The end date of the placement for the employee

data.archiveYear

string | null

The year the placement was archived for the employee, 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 employee

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 EmployeePlacements

Authorizations

Query Parameters

Body

Response