API docs by Redocly

Sentral REST API (v25.1.0-p5)

Download OpenAPI specification:Download

REST API documentation for Sentral

Activity

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activities

Retrieves a page of instances of activity.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venue. [optional] [default: null] [example: "venue"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns activities which endDate happens on and after the provided value. Together with toDate it can be used to only return activities that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns activities which startDate happens on and before the provided value. Together with fromDate it can be used to only return activities that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity

Retrieves a single instance of activity.

path Parameters
id
required
number

Number ID of the 'activity' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venue. [optional] [default: null] [example: "venue"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Activity Cycles

Retrieves a page of cycleInstance related to activity via relation cycles.

path Parameters
id
required
number

Number ID of the 'activity', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Activity Instances

Retrieves all of activityInstance related to activity via relation instances.

path Parameters
id
required
number

Number ID of the 'activity', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: activity. [optional] [default: null] [example: "activity"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Related Sport Events

Retrieves a page of activitySportEvent related to activity via relation sportEvents.

path Parameters
id
required
number

Number ID of the 'activity', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venues, grounds, coaches, vehicles, teams. [optional] [default: null] [example: "venues"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A category for an activity.

Get Activity Categories

Retrieves a page of instances of activityCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Category

Retrieves a single instance of activityCategory.

path Parameters
id
required
number

Number ID of the 'activityCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Activity Instance

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activity Instances

Retrieves a page of instances of activityInstance.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: activity. [optional] [default: null] [example: "activity"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

activityIds
string

String Comma-separated list of activity relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns activity instances which activity relation's endDate happens on and after the provided value. Together with toDate it can be used to only return activity instances that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns activity instances which activity relation's startDate happens on and before the provided value. Together with fromDate it can be used to only return activity instances that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Instance

Retrieves a single instance of activityInstance.

path Parameters
id
required
number

Number ID of the 'activityInstance' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: activity. [optional] [default: null] [example: "activity"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Instance Responses

Retrieves a page of activityResponse related to activityInstance via relation responses.

path Parameters
id
required
number

Number ID of the 'activityInstance', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentId
string

[Deprecated] Use studentIds instead. String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post Activity Instance Response

Adds a new activityResponse to a published activityInstance.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

activityResponse

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalNotes → String {DESCRIPTION-MISSING} [optional] [example: "Response was delivered via snail mail"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • medicalDetails → String {DESCRIPTION-MISSING} [optional] [example: "None"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • emergencyContactDetails → String {DESCRIPTION-MISSING} [optional] [example: "Mother, Jane Doe, +48 123-123-123"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • consentedBy → String {DESCRIPTION-MISSING} [optional] [example: "Mother"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • permissionGiven → String {DESCRIPTION-MISSING} [example: "Yes"] Value constraints: Allowed values: "Unknown", "Yes", "No", "Excluded"
    • isPaid → Boolean {DESCRIPTION-MISSING} [example: FALSE]
  • Relationships
    • student → [required] [single] expected type is student.
    • coreConsentor → [optional] [single] expected type is corePerson. Only one of coreConsentor and enrolmentConsentor must be provided - the operation will fail if both are in the payload.
    • enrolmentConsentor → [optional] [single] expected type is person. Only one of coreConsentor and enrolmentConsentor must be provided - the operation will fail if both are in the payload.
path Parameters
id
required
number

Number ID of the 'activityInstance' to which a detail should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Instance Rolls

Retrieves all of activityRoll related to activityInstance via relation rolls.

path Parameters
id
required
number

Number ID of the 'activityInstance', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Position

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

{DESCRIPTION-MISSING}

Get Activity Positions

Retrieves a page of instances of activityPosition.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Position

Retrieves a single instance of activityPosition.

path Parameters
id
required
number

Number ID of the 'activityPosition' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Activity Position Group

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activity Position Groups

Retrieves a page of instances of activityPositionGroup.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Position Group

Retrieves a single instance of activityPositionGroup.

path Parameters
id
required
number

Number ID of the 'activityPositionGroup' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Position Group Positions

Retrieves a page of activityPosition related to activityPositionGroup via relation positions.

path Parameters
id
required
number

Number ID of the 'activityPositionGroup', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Sport Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activity Sport Events

Retrieves a page of instances of activitySportEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venues, grounds, coaches, vehicles, teams. [optional] [default: null] [example: "venues"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

activityIds
string

String Comma-separated list of activity relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns events which endDate happens on and after the provided value. Together with toDate it can be used to only return events that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Filter the results to only returns events which startDate happens on and before the provided value. Together with fromDate it can be used to only return events that are active in a date range. [optional] [default: null] [example: "2018-01-04"]

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event

Retrieves a single instance of activitySportEvent.

path Parameters
id
required
number

Number ID of the 'activitySportEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venues, grounds, coaches, vehicles, teams. [optional] [default: null] [example: "venues"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Sport Event Coaches

Retrieves a page of staff related to activitySportEvent via relation coaches.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event Grounds

Retrieves a page of venueGrounds related to activitySportEvent via relation grounds.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event Teams

Retrieves a page of activityTeam related to activitySportEvent via relation teams.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: teamMembers, teamMemberPositions. [optional] [default: null] [example: "teamMembers"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event Transport Events

Retrieves a page of activityTransportEvent related to activitySportEvent via relation transportEvents.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event Vehicles

Retrieves a page of activityVehicle related to activitySportEvent via relation vehicles.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Sport Event Venues

Retrieves a page of venue related to activitySportEvent via relation venues.

path Parameters
id
required
number

Number ID of the 'activitySportEvent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: grounds. [optional] [default: null] [example: "grounds"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Team

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activity Teams

Retrieves a page of instances of activityTeam.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: teamMembers, teamMemberPositions. [optional] [default: null] [example: "teamMembers"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

activityIds
string

String Comma-separated list of activity relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of student IDs to filter by, linked through teamMembers; in other words will inly retrieve teams that have those students assigned to them.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Team

Retrieves a single instance of activityTeam.

path Parameters
id
required
number

Number ID of the 'activityTeam' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: teamMembers, teamMemberPositions. [optional] [default: null] [example: "teamMembers"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Team Coaches

Retrieves a page of staff related to activityTeam via relation coaches.

path Parameters
id
required
number

Number ID of the 'activityTeam', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Team Related Members

Retrieves a page of activityTeamMember related to activityTeam via relation teamMembers.

path Parameters
id
required
number

Number ID of the 'activityTeam', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Activity Team Member

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A definition of a student assigned to a team with additional information about their position and which `cycleInstance` and `activityInstance` they belong to. Keep in mind that team members have to be linked separately for each activity instance! They are link to `attendeeLink` and `cycleInstance` which determine the `activityInstance` they are part of.

Get Activity Activity Team Members

Retrieves a page of instances of activityTeamMember.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

positionIds
string

String Comma-separated list of position relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

attendeeLinkIds
string

String Comma-separated list of attendeeLink relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

teamIds
string

String Comma-separated list of team relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

cycleInstanceIds
string

String Comma-separated list of cycleInstance relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

sportEventIds
string

String Comma-separated list of activitySportEvent relation, linked through team IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Activity Team Member

Retrieves a single instance of activityTeamMember.

path Parameters
id
required
number

Number ID of the 'activityTeamMember' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Activity Transport Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A specific usage of a vehicle for an event.

Get Activity Transport Events

Retrieves a page of instances of activityTransportEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Transport Event

Retrieves a single instance of activityTransportEvent.

path Parameters
id
required
number

Number ID of the 'activityTransportEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Activity Vehicle

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A vehicle used for an event.

Get Activity Vehicles

Retrieves a page of instances of activityVehicle.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Vehicle

Retrieves a single instance of activityVehicle.

path Parameters
id
required
number

Number ID of the 'activityVehicle' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Attendee Link Student

Retrieves a single instance of student, the relation student of attendeeLink.

path Parameters
id
required
number

Number ID of the 'attendeeLink' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cycle Instance

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

{DESCRIPTION-MISSING}

Get Cycle Instances

Retrieves a page of instances of cycleInstance.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Cycle Instance

Retrieves a single instance of cycleInstance.

path Parameters
id
required
number

Number ID of the 'cycleInstance' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Roll

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Activity Rolls

Retrieves a page of instances of activityRoll.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Activity Roll

Retrieves a single instance of activityRoll.

path Parameters
id
required
number

Number ID of the 'activityRoll' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Activity Roll Activity Instance

Retrieves a single instance of activityInstance, the relation activityInstance of activityRoll.

path Parameters
id
required
number

Number ID of the 'activityRoll' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: activity. [optional] [default: null] [example: "activity"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Venue

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Venues

Retrieves a page of instances of venue.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: grounds. [optional] [default: null] [example: "grounds"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Venue

Retrieves a single instance of venue.

path Parameters
id
required
number

Number ID of the 'venue' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: grounds. [optional] [default: null] [example: "grounds"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Venue Related Grounds

Retrieves a page of venueGrounds related to venue via relation grounds.

path Parameters
id
required
number

Number ID of the 'venue', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Venue Grounds

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Specifc place or area in a venue.

Get Venue Grounds

Retrieves a page of instances of venueGrounds.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Venue Ground

Retrieves a single instance of venueGrounds.

path Parameters
id
required
number

Number ID of the 'venueGrounds' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Venue Group

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Venue Groups

Retrieves a page of instances of venueGroup.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Venue Group

Retrieves a single instance of venueGroup.

path Parameters
id
required
number

Number ID of the 'venueGroup' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Venue Group Venues

Retrieves a page of venue related to venueGroup via relation venues.

path Parameters
id
required
number

Number ID of the 'venueGroup', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: grounds. [optional] [default: null] [example: "grounds"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Absence

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Absence

Creates a new absence

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

absence

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • date → Date (Y-m-d, eg. 2019-12-31) Date of the absence [example: "2018-08-01"]
    • type → String Type of the absence [example: "whole"] Value constraints: Allowed values: "whole", "early", "timed", "late"
    • start → Time (H:i:s, eg 23:59:59) Start time of the absence. [optional] [example: "8:00"]
    • end → Time (H:i:s, eg 23:59:59) End time of the absence [optional] [example: "15:00"]
    • comment → String Comment for the absence [optional] [example: "Doctor appointment"]
  • Relationships
    • reason → [optional] [single] expected type is absenceReason.
    • coreStudent → [required] [single] expected type is coreStudent.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Absences

Retrieves a page of instances of absence.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 366 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentId
string

String Comma-separated list of enrolmentStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

year
string

String Comma-separated list of years from which absences to return (matches the year of the date attribute). [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

dates
string

String Comma-separated list of date values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Absence

Removes existing 'absence'.

path Parameters
id
required
number

Number ID of the referenced 'absence' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Absence

Retrieves a single instance of absence.

path Parameters
id
required
number

Number ID of the 'absence' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Absence Relationship To Response

Removes a link between an 'absence' and 'incomingMessage' which form a response to former from a guardian.

path Parameters
id
required
number

Number ID of 'absence' of which response should be removed. [example: 1]

messageId
required
number

Number ID of the 'incomingMessage' belonging to the 'absence' to which link should be removed. [example: 1]

Responses

Post Absence Response

Adds a response to an absence by creating a new outgoing message in the system and linking it through to the absence.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

incomingMessage

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • message → String The message that was sent that contains the explanation for absence. [example: ""] Value constraints: Length must be at most 1 characters, inclusive
    • type → String Type of the message delivery mechanism. [example: "sms"] Value constraints: Allowed values: "sms", "email", "phone", "letter", "portal"
    • isUnsolicited → Boolean Whether the message was unsolicited. [example: FALSE]
  • No relationships
path Parameters
id
required
number

Number ID of the absence to which a new response should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Absence Responses

Retrieves all of incomingMessage related to absence via relation responses.

path Parameters
id
required
number

Number ID of the 'absence', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post Staff Absence

Creates a new staff absence.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffAbsence

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • type → String {DESCRIPTION-MISSING} [example: "whole"] Value constraints: Allowed values: "whole", "early", "late", "timed"
    • startDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [example: "2018-01-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [example: "2018-01-02"]
    • startTime → Time (H:i:s, eg 23:59:59) {DESCRIPTION-MISSING} [optional] [default: null] [example: "08:15:00"]
    • endTime → Time (H:i:s, eg 23:59:59) {DESCRIPTION-MISSING} [optional] [default: null] [example: "16:30:00"]
    • reason → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "Struck down by flu"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "Pending confirmation from a doctor"] Value constraints: Length must be between 65025 and 0 characters, inclusive
    • hasReceivedMedicalCertificate → Boolean {DESCRIPTION-MISSING} [optional] [default: false] [example: FALSE]
    • externalSource → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "PAPER-RECORDS"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • externalId → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "P/73/112"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • Relationships
    • staff → [required] [single] expected type is staff.
    • leaveType → [required] [single] expected type is staffAbsenceLeaveType.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Absences

Retrieves a page of instances of staffAbsence.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Absence

Retrieves a single instance of staffAbsence.

path Parameters
id
required
number

Number ID of the 'staffAbsence' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Staff Absence Attachment

Adds a new 'staffAbsenceAttachment' to a 'staffAbsence'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'attachment'.

path Parameters
id
required
number

Number ID of the 'staffAbsence' to which the attachment should be added. [example: 1]

query Parameters
uploaderId
required
number

Number ID of the administrativeUser who uploaded the file, corresponds to relation uploader in the resulting model. [example: "13"]

displayName
required
string

String Displayed name of the file. [example: "Learning plan"] Value constraints: Length must be between 100 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Absence Related Attachments

Retrieves a page of staffAbsenceAttachment related to staffAbsence via relation attachments.

path Parameters
id
required
number

Number ID of the 'staffAbsence', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Absence Reason

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Reason for an absence

Get Absence Reasons

Retrieves a page of instances of absenceReason.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Absence Reason

Retrieves a single instance of absenceReason.

path Parameters
id
required
number

Number ID of the 'absenceReason' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attendance

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Information about student attendance on a specific day.

Get Attendances

Retrieves a page of instances of attendance.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 366 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentId
number

Number ID of the student whose attendances should be returned. [optional] [default: null]

year
number

Number Year from which attendances should be returned. [optional] [default: null] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Attendance

Retrieves a single instance of attendance.

path Parameters
id
required
number

Number ID of the 'attendance' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Day Roll

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Roll submission information for a specific day and rollclass. Unlike `dayRoll` it neither depends on `enrolments`'s rollclass, nor is a 'virtual' model - this model represents data that exists in the database.

Submit Core Day Roll

Submits a coreDayRoll, which closes off a roll for the given class for the given date

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

coreDayRoll

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • date → Date (Y-m-d, eg. 2019-12-31) Date for which to submit the roll. Must be a school day. [example: "2019-02-27"]
  • Relationships
    • coreRollclass → [required] [single] expected type is coreRollclass. Rollclass for which to submit the roll
    • submitter → [required] [single] expected type is coreAdministrativeUser. User who submitted the roll
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Core Day Rolls

Retrieves a page of instances of coreDayRoll.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: absences. [optional] [default: null] [example: "absences"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 3660 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

coreRollclassIds
string

String Comma-separated list of coreRollclass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years in date attribute to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Day Roll

Retrieves a single instance of coreDayRoll.

path Parameters
id
required
number

Number ID of the 'coreDayRoll' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: absences. [optional] [default: null] [example: "absences"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Day Roll

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about roll on a specific day.

Get Rolls

Retrieves a page of instances of dayRoll.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

year
number

Number Academic Year from which rolls should be returned. [optional] [default: Defaults to current year if not provided.]

term
number

Number Term whose rolls should be returned. [optional] [default: null] Value constraints: Minimum value: 0 [inclusive]

week
number

Number Term week whose rolls should be returned. [optional] [default: null] Value constraints: Minimum value: 0 [inclusive]

rollclassId
number

Number ID of enrolment rollclass by which to filter [optional] [default: null] Value constraints: Minimum value: 0 [inclusive]

date
number

Number If provided it will return only rolls that happen in the week of this date. If no other date filter is provided this is set to current server date. [optional] [default: Current date] Value constraints: Minimum value: 0 [inclusive]

coreRollclassIds
string

String Comma-separated list of coreRollclass IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{}

Get Roll

Retrieves a single instance of dayRoll.

path Parameters
id
required
string

String id of roll to retrieve which is a compound of rollclass ID and date in Ymd format separated by a dash. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{}

Future Absence

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Future Absence

Creates a new future absence

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

futureAbsence

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • startDate → Date (Y-m-d, eg. 2019-12-31) The start date of the planned absence. Must be the same date or earlier than endDate. [example: "2018-08-01"] Value constraints: Minimum value: yesterday [inclusive]
    • endDate → Date (Y-m-d, eg. 2019-12-31) The end date of the planned absence. Must be the same date or later than startDate. [example: "2018-08-08"] Value constraints: Minimum value: today [inclusive]
    • startTime → Time (H:i:s, eg 23:59:59) Start time of the planned absence. Will be ignored if the futureAbsence's type is either 'whole' or 'early'. Can't be earlier than school start time for the given student and date. [example: "8:00"]
    • endTime → Time (H:i:s, eg 23:59:59) End time of the planned absence. Will be ignored if the futureAbsence's type is either 'whole' or 'late'. Can't be later than school end time for the given student and date. [example: "15:00"]
    • type → String Time-span category of the absence. whole means the absence covers fully every day in the specified date range, and will ignore the provided values for startTime and endTime, setting them to the school start/end time for the respective days for the student. late means that on the last day of the absence the student will be in the school after it starts; it will ignore the provided value for startTime, setting it to the school start time of the last day of the absence. early means that on the first day of the absence the student will be in the school but will leave earlier than normal; it will ignore the provided value for endTime, setting it to the school end time of the first day of the absence. timed means the student will be in the school both on the first and last day of the absence, but will leave early and return late. [example: "whole"] Value constraints: Allowed values: "whole", "early", "timed", "late"
    • category → String Category of the absence. [example: "medical"] Value constraints: Allowed values: "holiday", "observance", "medical", "sport", "other"
    • comment → String A comment from the submiter [example: "Minor cosmetic surgery"]
  • Relationships
    • futureAbsenceReason → [optional] [single] expected type is futureAbsenceReason.
    • sender → [optional] [single] expected type is portalUser.
    • student → [required] [single] expected type is student.
    • reason → [optional] [single] expected type is absenceReason.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Future Absences

Retrieves a page of instances of futureAbsence.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentId
number

Number ID of the student whose future absences should be returned. [optional] [default: null]

startDateFrom
string

Date (Y-m-d, eg. 2019-12-31) Any future absence that has a start date occuring on or after the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

startDateto
string

Date (Y-m-d, eg. 2019-12-31) Any future absence that has an start date occuring on or before the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Future Absence

Removes existing 'futureAbsence'.

path Parameters
id
required
number

Number ID of the futureAbsence that should be deleted. [example: 1]

Responses

Get Future Absence

Retrieves a single instance of futureAbsence.

path Parameters
id
required
number

Number ID of the 'futureAbsence' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Future Absence

Updates an existing absence

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

futureAbsence

  • ID is required
  • Exactly 1 instance
  • Attributes
    • startDate → Date (Y-m-d, eg. 2019-12-31) The start date of the planned absence. Must be the same date or earlier than endDate. [example: "2018-08-01"] Value constraints: Minimum value: yesterday [inclusive]
    • endDate → Date (Y-m-d, eg. 2019-12-31) The end date of the planned absence. Must be the same date or later than startDate. [example: "2018-08-08"] Value constraints: Minimum value: today [inclusive]
    • startTime → Time (H:i:s, eg 23:59:59) Start time of the planned absence. Will be ignored if the futureAbsence's type is either 'whole' or 'early'. Can't be earlier than school start time for the given student and date. [example: "8:00"]
    • endTime → Time (H:i:s, eg 23:59:59) End time of the planned absence. Will be ignored if the futureAbsence's type is either 'whole' or 'late'. Can't be later than school end time for the given student and date. [example: "15:00"]
    • type → String Time-span category of the absence. whole means the absence covers fully every day in the specified date range, and will ignore the provided values for startTime and endTime, setting them to the school start/end time for the respective days for the student. late means that on the last day of the absence the student will be in the school after it starts; it will ignore the provided value for startTime, setting it to the school start time of the last day of the absence. early means that on the first day of the absence the student will be in the school but will leave earlier than normal; it will ignore the provided value for endTime, setting it to the school end time of the first day of the absence. timed means the student will be in the school both on the first and last day of the absence, but will leave early and return late. [example: "whole"] Value constraints: Allowed values: "whole", "early", "timed", "late"
    • category → String Category of the absence. [example: "medical"] Value constraints: Allowed values: "holiday", "observance", "medical", "sport", "other"
    • comment → String A comment from the submiter [example: "Minor cosmetic surgery"]
  • Relationships
    • futureAbsenceReason → [optional] [single] expected type is futureAbsenceReason.
    • sender → [optional] [single] expected type is portalUser.
path Parameters
id
required
number

Number ID of the futureAbsence that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Future Absence Reason

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Parent/guardian supplied reason for a future absence

Get Future Absence Reasons

Retrieves a page of instances of futureAbsenceReason.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Future Absence Reason

Retrieves a single instance of futureAbsenceReason.

path Parameters
id
required
number

Number ID of the 'futureAbsenceReason' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Period Roll

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Information about roll on a specific day and period.

Get Period Rolls

Retrieves a page of instances of periodRoll.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

date
string

Date (Y-m-d, eg. 2019-12-31) Filters by the date field [optional] [default: null] [example: "2018-01-01"]

period
number

Number Filters by the period filed [optional] [default: null] [example: "3"]

rollclassId
number

Number Filters by the rollclass to which this periodRoll belongs [optional] [default: null] [example: "7"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Period Roll

Retrieves a single instance of periodRoll.

path Parameters
id
required
string

String ID of the 'periodRoll' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Administrative User

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A tenant-specific administrative user (admins, teachers, staff).

Get Core Administrative Users

Retrieves a page of instances of coreAdministrativeUser.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

administrativeUserIds
string

String Comma-separated list of administratieUser relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Administrative User

Retrieves a single instance of coreAdministrativeUser.

path Parameters
id
required
number

Number ID of the 'coreAdministrativeUser' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Class

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Tenant-specific class.

Get Core Class

Retrieves a single instance of coreClass.

path Parameters
id
required
number

Number ID of the 'coreClass' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff, coreSubject, timetableClass. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Classes

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Core Classes

Retrieves a page of instances of coreClass.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff, coreSubject, timetableClass. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

teacherIds
string

String Comma-separated list of teacher relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

assignedStudentIds
string

String Comma-separated list of assignedStudents relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

assignedStaffIds
string

String Comma-separated list of assignedStaff relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Classes Assigned Staff

Retrieves a page of coreStaff related to coreClass via relation assignedStaff.

path Parameters
id
required
number

Number ID of the 'coreClass', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedClasses. [optional] [default: null] [example: "assignedClasses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Classes Assigned Students

Retrieves a page of coreStudent related to coreClass via relation assignedStudents.

path Parameters
id
required
number

Number ID of the 'coreClass', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Families

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Tenant-specific family

Get Core Families

Retrieves a page of instances of coreFamily.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Family

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Tenant-specific family

Get Core Family

Retrieves a single instance of coreFamily.

path Parameters
id
required
number

Number ID of the 'coreFamily' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Holiday

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A holiday information

Get Core Holidays

Retrieves a page of instances of coreHoliday.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years to filter by. When filtering by years it will also return ALL reoccuring holidays from the past. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Holiday

Retrieves a single instance of coreHoliday.

path Parameters
id
required
number

Number ID of the 'coreHoliday' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core House

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Tenant-specific house.

Get Core Houses

Retrieves a page of instances of coreHouse.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core House

Retrieves a single instance of coreHouse.

path Parameters
id
required
number

Number ID of the 'coreHouse' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Person

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Core Persons

Retrieves a page of instances of corePerson.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: studentContacts. [optional] [default: null] [example: "studentContacts"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Person

Retrieves a single instance of corePerson.

path Parameters
id
required
number

Number ID of the 'corePerson' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: studentContacts. [optional] [default: null] [example: "studentContacts"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Core Person Student Contacts

Retrieves a page of coreStudentPersonRelation related to corePerson via relation studentContacts.

path Parameters
id
required
number

Number ID of the 'corePerson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Rollclass

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Tenant-specific rollclass.

Get Core Rollclasses

Retrieves a page of instances of coreRollclass.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enterpriseUserIds
string

String Comma-separated list of IDs of AdminUsers to whom the classes are linked to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Rollclass

Retrieves a single instance of coreRollclass.

path Parameters
id
required
number

Number ID of the 'coreRollclass' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Staff

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Core Staffs

Retrieves a page of instances of coreStaff.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedClasses. [optional] [default: null] [example: "assignedClasses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Staff

Retrieves a single instance of coreStaff.

path Parameters
id
required
number

Number ID of the 'coreStaff' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedClasses. [optional] [default: null] [example: "assignedClasses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Core Staff Assigned Classes

Retrieves a page of coreClass related to coreStaff via relation assignedClasses.

path Parameters
id
required
number

Number ID of the 'coreStaff', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff, coreSubject, timetableClass. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Student

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Core Students

Retrieves a page of instances of coreStudent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreRollclassIds
string

String Comma-separated list of coreRollclass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Student

Retrieves a single instance of coreStudent.

path Parameters
id
required
number

Number ID of the 'coreStudent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Core Student Attended Classes

Retrieves a page of coreClass related to coreStudent via relation attendedClasses.

path Parameters
id
required
number

Number ID of the 'coreStudent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff, coreSubject, timetableClass. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Student Contacts

Retrieves a page of coreStudentPersonRelation related to coreStudent via relation contacts.

path Parameters
id
required
number

Number ID of the 'coreStudent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Student Photo

Returns the photo of a given student. Allowed dimensions are: 50x50, 100x100, 250x250, 500x500, 16x16, 28x28, 30x30, 32x32, 40x40, 45x45, 48x48, 64x64, 70x70, 75x75, 90x90, 92x92, 150x150, 170x170, 180x180, 190x35, 200x200, 245x245, 256x256, 300x300. If provided dimensions don't match it'll return the next closest dimension available.

path Parameters
id
required
string

String ID of the coreStudent whose photo to retrieve. Also supports externalId for backwards compatibility.

query Parameters
width
number

Number Width of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

height
number

Number Height of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

Responses

Get Timetable Student Related Timetable Classes

Retrieves a page of timetableClass related to timetableStudent via relation timetableClasses.

path Parameters
id
required
number

Number ID of the 'timetableStudent', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: timetableStudents. [optional] [default: null] [example: "timetableStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Student Relationship

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Tenant-specific student relationship.

Get Core Student Relationship

Retrieves a single instance of coreStudentRelationship.

path Parameters
id
required
number

Number ID of the 'coreStudentRelationship' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: coreStudent. [optional] [default: null] [example: "coreStudent"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Student Relationships

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Tenant-specific student relationship.

Get Core Student Relationships

Retrieves a page of instances of coreStudentRelationship.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: coreStudent. [optional] [default: null] [example: "coreStudent"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of Student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Core Subject

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Tenant-specific subject.

Get Core Subjects

Retrieves a page of instances of coreSubject.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: timetableSubject. [optional] [default: null] [example: "timetableSubject"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Core Subject

Retrieves a single instance of coreSubject.

path Parameters
id
required
number

Number ID of the 'coreSubject' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: timetableSubject. [optional] [default: null] [example: "timetableSubject"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Term

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

School terms

Get Core Term

Retrieves a single instance of coreTerm.

path Parameters
id
required
string

String matching regular expression: ^\d{4}-\d+$ ID of the 'coreTerm' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Core Terms

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

School terms

Get Core Terms

Retrieves a page of instances of coreTerm.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Date

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Get Dates

Retrieves at most a year worth of dates.

query Parameters
fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to return. Must be the same year as toDate [optional] [default: First day of the server's year.] [example: "2019-02-15"]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to return. Must be the same year as fromDate [optional] [default: Last day of the server's year.] [example: "2019-03-01"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Date

Retrieves information about a dates.

path Parameters
id
required
string

Date (Y-m-d, eg. 2019-12-31) ID of the 'date' to retrieve [example: "2019-01-01"]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dashboard Notice

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Dashboard Notices

Retrieves a page of instances of dashboardNotice.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

recipientIds
string

String Comma-separated list of recipient IDs, will only include notices which have any of given recipients (in any status). [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

senderIds
string

String Comma-separated list of sender IDs to filter by, null (case insensitive) can be used to limit results to notices with no sender (must be used alone). [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Dashboard Notice

Retrieves a single instance of dashboardNotice.

path Parameters
id
required
number

Number ID of the 'dashboardNotice' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Dashboard Notice Related Recipients

Retrieves a page of dashboardNoticeRecipient related to dashboardNotice via relation recipients.

path Parameters
id
required
number

Number ID of the 'dashboardNotice', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

statuses
string

String Comma-separated list of statuses to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

recipientIds
string

String Comma-separated list of recipient IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Dashboard Notice Recipient

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A dashboard notice recipient and delivery status information.

Get Dashboard Notice Recipients

Retrieves a page of instances of dashboardNoticeRecipient.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

noticeIds
string

String Comma-separated list of notice IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

recipientIds
string

String Comma-separated list of recipient IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

statuses
string

String Comma-separated list of statuses to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Dashboard Notice Recipient

Retrieves a single instance of dashboardNoticeRecipient.

path Parameters
id
required
number

Number ID of the 'dashboardNoticeRecipient' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Dashboard Notice Recipient

Updates an existing dasboardNoticeRecipient

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

dashboardNoticeRecipient

  • ID is required
  • Exactly 1 instance
  • Attributes
    • status → String New status of the delivery. [example: "UNREAD"] Value constraints: Allowed values: "READ", "UNREAD", "DELETED"
  • No relationships
path Parameters
id
required
number

Number ID of the dashboardNoticeRecipient that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Academic Report

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Academic Reports Edu Pro

Retrieves a page of instances of studentAcademicReportEduPro.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report Edu Pro

Retrieves a single instance of studentAcademicReportEduPro.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportEduPro' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Academic Report Edu Pro File

Returns the actual file of the given EduPro student academic report

path Parameters
id
required
number

Number ID of the studentAcademicReportEduPro which file to retrieve

Responses

Get Student Academic Reports

Retrieves a page of instances of studentAcademicReport.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

semesters
string

String Comma-separated list of semesters to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

periods
string

String Comma-separated list of periods to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report

Retrieves a single instance of studentAcademicReport.

path Parameters
id
required
number

Number ID of the 'studentAcademicReport' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Academic Report File

Returns the actual file of the given student academic report

path Parameters
id
required
number

Number ID of the studentAcademicReport which file to retrieve

Responses

Ability

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A person's ability

Get Abilities

Retrieves a page of instances of ability.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Ability

Retrieves a single instance of ability.

path Parameters
id
required
number

Number ID of the 'ability' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Period

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Get Academic Periods

Retrieves a page of instances of academicPeriod.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

names
string

String Comma-separated list of name attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of year attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

date
string

Date (Y-m-d, eg. 2019-12-31) A date encompassed by the academic period. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Period

Retrieves a single instance of academicPeriod.

path Parameters
id
required
number

Number ID of the 'academicPeriod' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Period Students

Retrieves a page of student related to academicPeriod via relation students. Only active students with active enrollment will be included in the results.

path Parameters
id
required
number

Number ID of the 'academicPeriod', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Campus

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A campus that belongs to a school

Get Campuses

Retrieves a page of instances of campus.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Campus

Retrieves a single instance of campus.

path Parameters
id
required
number

Number ID of the 'campus' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Class

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Classes

Retrieves a page of instances of class.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

subjectIds
string

String Comma-separated list of subject IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Class

Retrieves a single instance of class.

path Parameters
id
required
number

Number ID of the 'class' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Class Students

Retrieves a page of student related to class via relation students. Only active students with active enrollment will be included in the results.

path Parameters
id
required
number

Number ID of the 'class', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Class Subject

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A class subject.

Get Class Subjects

Retrieves a page of instances of classSubject.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Class Subject

Retrieves a single instance of classSubject.

path Parameters
id
required
number

Number ID of the 'classSubject' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Consent

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A consent that can be applied to a person.

Post Consent

Creates a new consent.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

consent

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • type → String The type of the consent [example: "Attending tea Wednesdays"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Any additional details about the type of consent [example: "Whether the student is allowed to attend the weekly tea Wednesdays with Philosophy teacher"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • defaultExpireOn → Date (Y-m-d, eg. 2019-12-31) Default expiry date for newly given consents (can be override per given consent). Expired consents have their flags removed. [optional] [default: null] [example: "2020-01-01"]
  • No relationships
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Consents

Retrieves a page of instances of consent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

isDefaultConsent
boolean

Boolean When provided it will filter by isDefaultConsnt attribute. [optional] [default: null] [example: TRUE]

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: 1] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Consent

Deletes consent by ID

path Parameters
id
required
number

Number ID of the consent to delete. [example: 1]

Responses

Get Consent

Retrieves a single instance of consent.

path Parameters
id
required
number

Number ID of the 'consent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Consent

Updates an existing consent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

consent

  • ID is required
  • Exactly 1 instance
  • Attributes
    • type → String The type of the consent [example: "Attending tea Wednesdays"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Any additional details about the type of consent [example: "Whether the student is allowed to attend the weekly tea Wednesdays with Philosophy teacher"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • defaultExpireOn → Date (Y-m-d, eg. 2019-12-31) Default expiry date for newly given consents (can be override per given consent). Expired consents have their flags removed. [optional] [default: null] [example: "2020-01-01"]
  • No relationships
path Parameters
id
required
number

Number ID of the futureAbsence that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Court Order

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A court order.

Post Court Orders

Creates a new court order.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

courtOrder

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • type → String Type of the court order [example: "other"] Value constraints: Allowed values: "apprehended_violence_order", "family_court_order", "other"
    • caseId → String Identifier of the court order [example: "1234"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • title → String Title of the court order [example: "Court Order Title"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • schoolNotes → String School-made notes on the court order [example: "School note"] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • orderNotes → String Court-made notes on the court order [example: "Court notes"] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • startDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order starts applying [optional] [example: "2021-01-01"]
    • reviewDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order was reviewed [optional] [example: "2021-01-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order ends applying [optional] [example: "2021-01-01"]
  • Relationships
    • school → [required] [single] expected type is school. School to which the court order applies
    • students → [required] [collection] expected type is student. Students who are affected by the court order
    • persons → [required] [collection] expected type is person. Other people who are affected by the court order
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Court Orders

Retrieves a page of instances of courtOrder.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of students relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of persons relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Court Order

Retrieves a single instance of courtOrder.

path Parameters
id
required
number

Number ID of the 'courtOrder' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Court Order

Updates an existing court order

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

courtOrder

  • ID is required
  • Exactly 1 instance
  • Attributes
    • type → String Type of the court order [example: "other"] Value constraints: Allowed values: "apprehended_violence_order", "family_court_order", "other"
    • caseId → String Identifier of the court order [example: "1234"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • title → String Title of the court order [example: "Court Order Title"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • schoolNotes → String School-made notes on the court order [example: "School note"] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • orderNotes → String Court-made notes on the court order [example: "Court notes"] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • startDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order starts applying [optional] [example: "2021-01-01"]
    • reviewDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order was reviewed [optional] [example: "2021-01-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) Date when the court order ends applying [optional] [example: "2021-01-01"]
  • Relationships
    • school → [optional] [single] expected type is school. School to which the court order applies
    • students → [optional] [collection] expected type is student. Students who are affected by the court order
    • persons → [optional] [collection] expected type is person. Other people who are affected by the court order
path Parameters
id
required
number

Number ID of the courtOrder that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Disability Other

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Disability Others

Retrieves a page of instances of disabilityOther.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Disability Other

Retrieves a single instance of disabilityOther.

path Parameters
id
required
number

Number ID of the 'disabilityOther' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Disability Other Care Plan File

Returns the care plan file of the specified disability

path Parameters
id
required
number

Number ID of the disability which care plan file to retrieve. [example: 1]

Responses

Doctor

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Doctors

Retrieves a page of instances of doctor.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: patient. [optional] [default: null] [example: "patient"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Doctor

Retrieves a single instance of doctor.

path Parameters
id
required
number

Number ID of the 'doctor' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: patient. [optional] [default: null] [example: "patient"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Doctor Person

Retrieves a single instance of person, the relation relatedPerson of doctor.

path Parameters
id
required
number

Number ID of the 'doctor' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enrolment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Enrolments

Retrieves a page of instances of enrolment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

academicPeriodIds
string

String Comma-separated list of academicPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

rollclassIds
string

String Comma-separated list of rollclass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

yearLevelIds
string

String Comma-separated list of yearLevel relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

houseIds
string

String Comma-separated list of house relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

statuses
string

String Comma-separated list of statuses to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

startDateFrom
string

Date (Y-m-d, eg. 2019-12-31) Any enrolments that have a start date occuring on or after the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

startDateTo
string

Date (Y-m-d, eg. 2019-12-31) Any enrolments that have a start date occuring on or before the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

endDateFrom
string

Date (Y-m-d, eg. 2019-12-31) Any enrolments that have no end date (unless endDateTo is also set) or an end date occuring on or after the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

endDateTo
string

Date (Y-m-d, eg. 2019-12-31) Any enrolments that have an end date occuring on or before the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: 1] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrolment

Retrieves a single instance of enrolment.

path Parameters
id
required
number

Number ID of the 'enrolment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Enrolment

Updates an existing enrolment

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

enrolment

  • ID is required
  • Exactly 1 instance
  • Attributes
    • isBoarding → Boolean Whether this enrolment includes boarding [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of the enrolment that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Enrolment Classes

Retrieves a page of class related to enrolment via relation classes.

path Parameters
id
required
number

Number ID of the 'enrolment', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrolment House

Retrieves a single instance of house, the relation house of enrolment.

path Parameters
id
required
number

Number ID of the 'enrolment' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Enrolment Rollclass

Retrieves a single instance of rollclass, the relation rollclass of enrolment.

path Parameters
id
required
number

Number ID of the 'enrolment' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enrolment Priority

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Student's enrolment to a specific school and year.

Get Enrolment Priorities

Retrieves a page of instances of enrolmentPriority.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrolment Priority

Retrieves a single instance of enrolmentPriority.

path Parameters
id
required
number

Number ID of the 'enrolmentPriority' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enrolment Speciality

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Definition of a speciality that a person can have.

Get Enrolment Specialities

Retrieves a page of instances of enrolmentSpeciality.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

categoryIds
string

String Comma-separated list of category relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrolment Speciality

Retrieves a single instance of enrolmentSpeciality.

path Parameters
id
required
number

Number ID of the 'enrolmentSpeciality' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enrolment Speciality Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category for a speciality of a person - currently only used by staff.

Get Enrolment Speciality Categories

Retrieves a page of instances of enrolmentSpecialityCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

nameSearch
string

String Search for name. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Teach%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Enrolment Speciality Category

Retrieves a single instance of enrolmentSpecialityCategory.

path Parameters
id
required
number

Number ID of the 'enrolmentSpecialityCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Flag

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Flags

Retrieves a page of instances of flag.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: school. [optional] [default: null] [example: "school"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

includeDisabled
boolean

Boolean When true, flags that were disabled will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Flag

Retrieves a single instance of flag.

path Parameters
id
required
number

Number ID of the 'flag' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: school. [optional] [default: null] [example: "school"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Flag School

Retrieves a single instance of school, the relation school of flag.

path Parameters
id
required
number

Number ID of the 'flag' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: tenant. [optional] [default: null] [example: "tenant"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

House

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Houses

Retrieves a page of instances of house.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get House

Retrieves a single instance of house.

path Parameters
id
required
number

Number ID of the 'house' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get House Students

Retrieves a page of student related to house via relation students.

path Parameters
id
required
number

Number ID of the 'house', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Household

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Households

Retrieves a page of instances of household.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: addresses. [optional] [default: null] [example: "addresses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Household

Retrieves a single instance of household.

path Parameters
id
required
number

Number ID of the 'household' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: addresses. [optional] [default: null] [example: "addresses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Household Related Addresses

Retrieves all of householdAddress related to household via relation addresses.

path Parameters
id
required
number

Number ID of the 'household', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Household Address

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Household's address

Get Household Addresses

Retrieves a page of instances of householdAddress.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Househould Address

Retrieves a single instance of householdAddress.

path Parameters
id
required
number

Number ID of the 'householdAddress' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Medical Condition

Get Medical Conditions

Retrieves a page of instance of one of the medicalCondition* models.

query Parameters
limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

names
string

String Comma-separated list of names to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition

Retrieves a single instance of one of the medicalCondition* models.

path Parameters
id
required
number

Number ID of the referenced 'medicalCondition*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Get Medical Condition Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the referenced 'medicalCondition*' [example: 17]

Responses

Get Medical Condition Doctors Letter

Returns the doctor's letter file of the condition

path Parameters
id
required
number

Number ID of the referenced 'medicalCondition*' [example: 17]

Responses

Medical Condition Add

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Add

Retrieves a page of instances of medicalConditionAdd. (Deprecated: use /v1/enrolments/medical-condition instead; meta.count may not match the actual number of records that can be retrieved from this endpoint)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Add

Retrieves a single instance of medicalConditionAdd.

path Parameters
id
required
number

Number ID of the 'medicalConditionAdd' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Add Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Allergy

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Allergy

Retrieves a page of instances of medicalConditionAllergy. (Deprecated: use /v1/enrolments/medical-condition instead; meta.count may not match the actual number of records that can be retrieved from this endpoint)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Allergy

Retrieves a single instance of medicalConditionAllergy.

path Parameters
id
required
number

Number ID of the 'medicalConditionAllergy' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Allergy Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Asthma

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Asthma

Retrieves a page of instances of medicalConditionAsthma. (Deprecated: use /v1/enrolments/medical-condition instead; meta.count may not match the actual number of records that can be retrieved from this endpoint)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Asthma

Retrieves a single instance of medicalConditionAsthma.

path Parameters
id
required
number

Number ID of the 'medicalConditionAsthma' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Asthma Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Diabetes

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Diabetes

Retrieves a page of instances of medicalConditionDiabetes. (Deprecated: use /v1/enrolments/medical-condition instead; meta.count may not match the actual number of records that can be retrieved from this endpoint)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Diabetes

Retrieves a single instance of medicalConditionDiabetes.

path Parameters
id
required
number

Number ID of the 'medicalConditionDiabetes' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Diabetes Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Epilepsy

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Epilepsy

Retrieves a page of instances of medicalConditionEpilepsy. (Deprecated: use /v1/enrolments/medical-condition instead; meta.count may not match the actual number of records that can be retrieved from this endpoint)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Epilepsy

Retrieves a single instance of medicalConditionEpilepsy.

path Parameters
id
required
number

Number ID of the 'medicalConditionEpilepsy' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Epilepsy Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Other

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Medical Conditions Other

Retrieves a page of instances of medicalConditionOther. (Deprecated: use /v1/enrolments/medical-condition instead)

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Other

Retrieves a single instance of medicalConditionOther.

path Parameters
id
required
number

Number ID of the 'medicalConditionOther' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Condition Other Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the condition which care plan file to retrieve. [example: 1]

Responses

Medical Condition Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Information about an ADD medical condition.

Get Medical Condition Types

Retrieves a page of instances of medicalConditionType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Condition Type

Retrieves a single instance of medicalConditionType.

path Parameters
id
required
number

Number ID of the 'medicalConditionType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Note Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Definition of a note type

Get Note Types

Retrieves a page of instances of noteType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

isBuiltin
boolean

Boolean Filter by 'isBuiltin' attribute value. Values other than 'true', 'false', '1' and '0' will be interpreted as null and won't filter by this field. [optional] [default: false] [example: "true"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Note Type

Retrieves a single instance of noteType.

path Parameters
id
required
number

Number ID of the 'noteType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Person

Creates a new person

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

person

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Persons

Retrieves a page of instances of person.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of person ids by which to filter. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

refIds
string

String Comma-separated list of person refIds by which to filter. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

contactCodes
string

String Comma-separated list of person contactCodes by which to filter. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of person externalIds by which to filter. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

firstName
string

String Search for first name. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Joh%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

preferredName
string

String Search for preferredName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Jimm%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

middleName
string

String Search for middleNames. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Stev%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

lastName
string

String Search for lastName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Do*"] Value constraints: Length must be between 1024 and 0 characters, inclusive

legalLastName
string

String Search for legalLastName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Do*"] Value constraints: Length must be between 1024 and 0 characters, inclusive

inactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person

Retrieves a single instance of person.

path Parameters
id
required
number

Number ID of the 'person' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person

Updates an existing person

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

person

path Parameters
id
required
number

Number ID of the person that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Associated Students

Retrieves all of studentPersonRelation related to person via relation associatedStudents.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, studentPerson, person. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

hasPortalAccess
boolean

Boolean Filter the list of relations by students which this person can access in the portal. [optional] [default: null] [example: TRUE]

withPastEnrolment
boolean

Boolean Include students who have an enrolment with a type of: alumni, withdrawn, expelled, transferred [optional] [default: false] [example: FALSE]

withCurrentEnrolment
boolean

Boolean Include students who have an enrolment with a type of: active_pending, external_pending, active, external, active_leaving [optional] [default: 1] [example: TRUE]

withFutureEnrolment
boolean

Boolean Include students who have an enrolment with a type of: accepted, confirmed [optional] [default: false] [example: FALSE]

withOtherEnrolment
boolean

Boolean Include students who have an enrolment with a type of: enquired, applied, interview_review, interview_required, tested_successful, tested_unsuccessful, offered, waitlist_offered, waitlist_offered_rejected, waitlist_offered_to_send, waitlisted, offered_to_send, offered_rejected, not_approved, never_attended, draft, transitioning_students, under_appeal, leave_of_absence [optional] [default: false] [example: FALSE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Disabilities

Returns all disabilities of a specific person

path Parameters
id
required
number

Number ID of 'person' whose disability* models to retrieve. [example: 1]

query Parameters
limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Doctors

Retrieves all of doctor related to person via relation doctors.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: patient. [optional] [default: null] [example: "patient"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Given Consents

Retrieves a page of consent related to person via relation givenConsents.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Medical Conditions

Returns all medical conditions of a specific person

path Parameters
id
required
number

Number

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

name
string

String Search for condition name. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Diabe*"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Medical Summary

Returns summary of medical information for a person (Return description pending)

path Parameters
id
required
number

Number

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Other Households

Retrieves all of household related to person via relation otherHouseholds.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: addresses. [optional] [default: null] [example: "addresses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Related Person Contact Details

Retrieves a single instance of personContactDetails, the relation staff of person.

path Parameters
id
required
number

Number ID of the 'person' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Prescribed Medications

Retrieves all of prescribedMedication related to person via relation prescribedMedications.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Primary Household

Retrieves a single instance of household, the relation primaryHousehold of person.

path Parameters
id
required
number

Number ID of the 'person' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: addresses. [optional] [default: null] [example: "addresses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Staff

Retrieves a single instance of staff, the relation staff of person.

path Parameters
id
required
number

Number ID of the 'person' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Student

Retrieves a single instance of student, the relation student of person.

path Parameters
id
required
number

Number ID of the 'person' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Student Contacts

Retrieves all instances of studentPersonRelation.

path Parameters
id
required
number

Number ID of the person whose contacts should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, studentPerson, person. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Vaccinations

Retrieves all of vaccination related to person via relation vaccinations.

path Parameters
id
required
number

Number ID of the 'person', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Person Address

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Person's address - usually only used for staff members since they're not part of a household.

Get Person Addresses

Retrieves a page of instances of personAddress.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Address

Retrieves a single instance of personAddress.

path Parameters
id
required
number

Number ID of the 'personAddress' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person By Code

Get Person By Code

Retrieves a single instance of person.

path Parameters
id
required
string

Alphanumeric string ID of the 'person' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Contact Details

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Additional details about a person who is used in a relation with a student - usually a parent or guardian but can be any other household member whose details are required.

Get Person Contact Details Many

Retrieves a page of instances of personContactDetails.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Contact Details One

Retrieves a single instance of personContactDetails.

path Parameters
id
required
number

Number ID of the 'personContactDetails' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person Contact Details

Updates an existing personContactDetails record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personContactDetails

path Parameters
id
required
number

Number ID of the personContactDetails record that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Email

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A person's email address.

Post Person Email

Creates a new personEmail.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personEmail

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • email → String Email address [example: "test@example.com"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • type → String Type of this email address. It's advisable to avoid one person having multiple emails of the same type, but there is no server-side validation. [example: "01"] Value constraints: Allowed values: "01", "02", "03", "04", "05", "06", "07"
    • canContact → Boolean If the person can be contacted using this email address. [example: TRUE]
  • Relationships
    • owner → [required] [single] expected type is person. Person whose email it is
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Emails

Retrieves a page of instances of personEmail.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Person Email

Deletes personEmail by ID

path Parameters
id
required
number

Number ID of the personEmail to delete. [example: 1]

Responses

Get Person Email

Retrieves a single instance of personEmail.

path Parameters
id
required
number

Number ID of the 'personEmail' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person Email

Updates an existing personEmail.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personEmail

  • ID is required
  • Exactly 1 instance
  • Attributes
    • email → String Email address [example: "test@example.com"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • type → String Type of this email address. It's advisable to avoid one person having multiple emails of the same type, but there is no server-side validation. [example: "01"] Value constraints: Allowed values: "01", "02", "03", "04", "05", "06", "07"
    • canContact → Boolean If the person can be contacted using this email address. [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of the personEmail that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Field

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

An additional, custom field for a person.

Get Person Fields

Retrieves a page of instances of personField.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. Note: it will also find fields which have null relation. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Field

Retrieves a single instance of personField.

path Parameters
id
required
number

Number ID of the 'personField' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Field Value

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A custom field value for a person.

Get Person Field Values

Retrieves a page of instances of personFieldValue.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fieldIds
string

String Comma-separated list of field relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Field Value

Retrieves a single instance of personFieldValue.

path Parameters
id
required
number

Number ID of the 'personFieldValue' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Household Relation

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A connection that a person has to a household.

Get Person Household Relations

Retrieves a page of instances of personHouseholdRelation.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, household. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of student IDs to filter by. These are linked through person relation. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

householdIds
string

String Comma-separated list of household IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

residentialHouseholds
string

String Comma-separated list of residentialHousehold attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Household Relation

Retrieves a single instance of personHouseholdRelation.

path Parameters
id
required
number

Number ID of the 'personHouseholdRelation' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, household. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Medical Misc

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about an ADD medical condition.

Get Person Medical Miscs

Retrieves a page of instances of personMedicalMisc.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Medical Misc

Retrieves a single instance of personMedicalMisc.

path Parameters
id
required
number

Number ID of the 'personMedicalMisc' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Name

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A person's name other than the legal name.

Get Person Names

Retrieves a page of instances of personName.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of 'namePerson' relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

nameTypes
string

String Comma-separated list of 'nameTypes' attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Name

Retrieves a single instance of personName.

path Parameters
id
required
number

Number ID of the 'personName' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Passport

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A person that a person holds

Post Person Passport

Creates a new personPassport.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personPassport

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • number → String Passport number [example: "92983L-2"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • countryCode → String Passport issuing country (code), must be one of Standard Australian Classification of Countries keys: http://specification.sifassociation.org/Implementation/AU/3.5.0/CodeSets.html#AUCodeSetsStandardAustralianClassificationOfCountriesSACCType [example: "3307"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrimary → Boolean Whether this is person's primary passport. It's possible to have multiple passports marked as primary, but ideally there should ever be only one. [example: FALSE]
    • issueDate → Date (Y-m-d, eg. 2019-12-31) When the passport was issued [optional] [example: "2021-01-01"]
    • expiryDate → Date (Y-m-d, eg. 2019-12-31) When the passport expires [optional] [example: "2021-01-02"]
  • Relationships
    • holder → [required] [single] expected type is person. Passport holder
    • name → [optional] [single] expected type is personName. Name on the passport
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Passports

Retrieves a page of instances of personPassport.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Passport

Retrieves a single instance of personPassport.

path Parameters
id
required
number

Number ID of the 'personPassport' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person Passport

Updates an existing personPassport.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personPassport

  • ID is required
  • Exactly 1 instance
  • Attributes
    • number → String Passport number [example: "92983L-2"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • countryCode → String Passport issuing country (code), must be one of Standard Australian Classification of Countries keys: http://specification.sifassociation.org/Implementation/AU/3.5.0/CodeSets.html#AUCodeSetsStandardAustralianClassificationOfCountriesSACCType [example: "3307"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrimary → Boolean Whether this is person's primary passport. It's possible to have multiple passports marked as primary, but ideally there should ever be only one. [example: FALSE]
    • issueDate → Date (Y-m-d, eg. 2019-12-31) When the passport was issued [optional] [example: "2021-01-01"]
    • expiryDate → Date (Y-m-d, eg. 2019-12-31) When the passport expires [optional] [example: "2021-01-02"]
  • No relationships
path Parameters
id
required
number

Number ID of the personPassport that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Phone

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A person's phone number.

Post Person Phone

Creates a new personPhone.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personPhone

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • number → String Phone number [example: "12345666"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • extension → Number The extension part of the phone number [optional] [example: 12]
    • type → String Type of this phone number. It's advisable to avoid one person having multiple phone numbers of the same type, but there is no server-side validation. [example: "0779"] Value constraints: Allowed values: "0350", "0359", "0400", "0370", "2364", "0779", "0777", "0478", "0096", "0486", "0888", "0437", "0426", "0448", "0889"
    • isListed → Boolean If this phone number is listed publicly [optional] [example: TRUE]
    • canContact → Boolean If the person can be contacted using this phone number. [example: TRUE]
  • Relationships
    • owner → [required] [single] expected type is person. Person whose phone number it is
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Phones

Retrieves a page of instances of personPhone.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Phone

Retrieves a single instance of personPhone.

path Parameters
id
required
number

Number ID of the 'personPhone' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person Phone

Updates an existing personPhone.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personPhone

  • ID is required
  • Exactly 1 instance
  • Attributes
    • number → String Phone number [example: "12345666"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • extension → Number The extension part of the phone number [optional] [example: 12]
    • type → String Type of this phone number. It's advisable to avoid one person having multiple phone numbers of the same type, but there is no server-side validation. [example: "0779"] Value constraints: Allowed values: "0350", "0359", "0400", "0370", "2364", "0779", "0777", "0478", "0096", "0486", "0888", "0437", "0426", "0448", "0889"
    • isListed → Boolean If this phone number is listed publicly [optional] [example: TRUE]
    • canContact → Boolean If the person can be contacted using this phone number. [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of the personPhone that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Person Phones

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Delete Person Phone

Deletes personPhone by ID

path Parameters
id
required
number

Number ID of the personPhone to delete. [example: 1]

Responses

Person Visa

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A visa that a person holds.

Post Person Visa

Creates a new personVisa.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personVisa

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • visaClass → String Visa's class type, must be one of the values as available in Sentral's UI, the two letter code. [optional] [example: "AD"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • visaSubClass → String Visa's subclass type, must be one of SIF-compliant values: http://specification.sifassociation.org/Implementation/AU/3.5.0/CodeSets.html#AUCodeSetsVisaSubClassType [example: "AD"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • grantNumber → String Visa's grant number [example: "1448PS"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • statisticalCode → String Visa's statistical code [example: "123123"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • issueDate → Date (Y-m-d, eg. 2019-12-31) When the visa was issued [optional] [example: "2021-01-01"]
    • expiryDate → Date (Y-m-d, eg. 2019-12-31) When the visa expires [optional] [example: "2021-01-02"]
    • applicationDate → Date (Y-m-d, eg. 2019-12-31) When the visa was applied for [optional] [example: "2021-01-03"]
  • Relationships
    • holder → [required] [single] expected type is person. Visa holder
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Person Visas

Retrieves a page of instances of personVisa.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

personIds
string

String Comma-separated list of person relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Person Visa

Retrieves a single instance of personVisa.

path Parameters
id
required
number

Number ID of the 'personVisa' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Person Visa

Updates an existing personVisa.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

personVisa

  • ID is required
  • Exactly 1 instance
  • Attributes
    • visaClass → String Visa's class type, must be one of the values as available in Sentral's UI, the two letter code. [optional] [example: "AD"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • visaSubClass → String Visa's subclass type, must be one of SIF-compliant values: http://specification.sifassociation.org/Implementation/AU/3.5.0/CodeSets.html#AUCodeSetsVisaSubClassType [example: "AD"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • grantNumber → String Visa's grant number [example: "1448PS"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • statisticalCode → String Visa's statistical code [example: "123123"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • issueDate → Date (Y-m-d, eg. 2019-12-31) When the visa was issued [optional] [example: "2021-01-01"]
    • expiryDate → Date (Y-m-d, eg. 2019-12-31) When the visa expires [optional] [example: "2021-01-02"]
    • applicationDate → Date (Y-m-d, eg. 2019-12-31) When the visa was applied for [optional] [example: "2021-01-03"]
  • No relationships
path Parameters
id
required
number

Number ID of the personVisa that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Prescribed Medication

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about a prescribed drug.

Get Prescribed Medications

Retrieves a page of instances of prescribedMedication.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Prescribed Medication

Retrieves a single instance of prescribedMedication.

path Parameters
id
required
number

Number ID of the 'prescribedMedication' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Rollclass

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Rollclasses

Retrieves a page of instances of rollclass.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

academicPeriodIds
string

String Comma-separated list of academicPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Rollclass

Retrieves a single instance of rollclass.

path Parameters
id
required
number

Number ID of the 'rollclass' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Rollclass Students

Retrieves a page of student related to rollclass via relation students. Only active students with active enrollment will be included in the results.

path Parameters
id
required
number

Number ID of the 'rollclass', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

School

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Schools

Retrieves a page of instances of school.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: tenant. [optional] [default: null] [example: "tenant"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

names
string

String Comma-separated list of name attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolCodes
string

String Comma-separated list of schoolCodes attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get School

Retrieves a single instance of school.

path Parameters
id
required
number

Number ID of the 'school' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: tenant. [optional] [default: null] [example: "tenant"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get School Tenant

Retrieves a single instance of tenant, the relation tenant of school.

path Parameters
id
required
number

Number ID of the 'school' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: schools. [optional] [default: null] [example: "schools"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Special Needs Program

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A special needs program that a student can be a part of.

Get Special Needs Programs

Retrieves a page of instances of specialNeedsProgram.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: students. [optional] [default: null] [example: "students"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Special Needs Program

Retrieves a single instance of specialNeedsProgram.

path Parameters
id
required
number

Number ID of the 'specialNeedsProgram' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: students. [optional] [default: null] [example: "students"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A definition of a class in a timetable.

Post Staff

Creates a new staff record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staff

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • staffCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • timetableCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • barcode → String {DESCRIPTION-MISSING} [optional] [example: "ABC-abc-1234"]
    • emergencyContactName → String Deprecated, no longer used. Name of the person who should be contacted in case of an emergency. [optional] [example: "John Smith"]
    • emergencyContactPhone → String Deprecated, no longer used. Phone number of the person who should be contacted in case of an emergency. [optional] [example: "+61 7 7010 4537"]
    • emergencyContactMobile → String Deprecated, no longer used. Mobile Phone number of the person who should be contacted in case of an emergency. [optional] [example: "0491 570 156"]
    • employmentStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment status of the staff member [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment classification of the staff member [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Staff member's job title [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract was started [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract will end [optional] [example: "2024-12-31"]
    • wWCCNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: "2028-09-22"]
    • aGSNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: NULL]
  • Relationships
    • person → [required] [single] expected type is person. Person record for whom the staff record relates to.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staffs

Retrieves a page of instances of staff.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

barcodes
string

String Comma-separated list of barcodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffCodes
string

String Comma-separated list of staffCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

refIds
string

String Comma-separated list of refIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

contactCodes
string

String Comma-separated list of contactCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of externalIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Staff

Deletes staff by ID

path Parameters
id
required
number

Number ID of the staff to delete. [example: 1]

Responses

Get Staff

Retrieves a single instance of staff.

path Parameters
id
required
number

Number ID of the 'staff' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Staff

Updates an existing staff record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staff

  • ID is required
  • Exactly 1 instance
  • Attributes
    • staffCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • timetableCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • barcode → String {DESCRIPTION-MISSING} [optional] [example: "ABC-abc-1234"]
    • emergencyContactName → String Deprecated, no longer used. Name of the person who should be contacted in case of an emergency. [optional] [example: "John Smith"]
    • emergencyContactPhone → String Deprecated, no longer used. Phone number of the person who should be contacted in case of an emergency. [optional] [example: "+61 7 7010 4537"]
    • emergencyContactMobile → String Deprecated, no longer used. Mobile Phone number of the person who should be contacted in case of an emergency. [optional] [example: "0491 570 156"]
    • employmentStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment status of the staff member [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment classification of the staff member [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Staff member's job title [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract was started [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract will end [optional] [example: "2024-12-31"]
    • wWCCNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: "2028-09-22"]
    • aGSNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: NULL]
  • No relationships
path Parameters
id
required
number

Number ID of the staff that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Staff Absences

Retrieves a page of staffAbsence related to staff via relation absences.

path Parameters
id
required
number

Number ID of the 'staff', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Person

Retrieves a single instance of person, the relation relatedPerson of staff.

path Parameters
id
required
number

Number ID of the 'staff' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Photo

Returns the photo of a given staff. Allowed dimensions are: 50x50, 100x100, 250x250, 500x500. If provided dimensions don't match it'll return the next closest dimension available.

path Parameters
id
required
string

String ID of the staff whose photo to retrieve. Also supports externalId for backwards compatibility.

query Parameters
width
number

Number Width of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

height
number

Number Height of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

Responses

Get Staff Related Qualifications

Retrieves all of staffQualification related to staff via relation qualifications.

path Parameters
id
required
number

Number ID of the 'staff', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Timetable Lessons

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the staff which timetable should be retrieved for a given date.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to retrieve timetable lessons, inclusive range. When not specified it defaults to today. [optional] [default: Today]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to retrieve timetable lessons, inclusive range. When not specified it uses fromDate. Max allowed number of days to fetch data is 31. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Timetable Lessons Legacy

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the staff which timetable should be retrieved for a given date.

date
required
string

Date (Y-m-d, eg. 2019-12-31) Date for which the timetable should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Staff Car

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A staff member's car details

Post Staff Car

Creates a new staffCar record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffCar

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • model → String The model of the car [optional] [example: "CarModel"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • make → String The make of the car [optional] [example: "CarMake"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • colour → String The colour of the car [optional] [example: "CarColour"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • insurer → String The insurer of the car [optional] [example: "CarInsurer"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • numberPlate → String The number plate of the car [optional] [example: "CarNumber"] Value constraints: Length must be between 12 and 0 characters, inclusive
  • Relationships
    • staff → [required] [single] expected type is staff. Staff member who has the car.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Cars

Retrieves a page of instances of staffCar.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Staff Car

Deletes staff car by ID

path Parameters
id
required
number

Number ID of the staffCar to delete. [example: 1]

Responses

Get Staff Car

Retrieves a single instance of staffCar.

path Parameters
id
required
number

Number ID of the 'staffCar' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Staff Car

Updates an existing staffCar record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffCar

  • ID is required
  • Exactly 1 instance
  • Attributes
    • model → String The model of the car [optional] [example: "CarModel"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • make → String The make of the car [optional] [example: "CarMake"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • colour → String The colour of the car [optional] [example: "CarColour"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • insurer → String The insurer of the car [optional] [example: "CarInsurer"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • numberPlate → String The number plate of the car [optional] [example: "CarNumber"] Value constraints: Length must be between 12 and 0 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of the staffCar that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff Document

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Class of a given subject.

Get Staff Documents

Retrieves a page of instances of staffDocument.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of Ids to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffIds
string

String Comma-separated list of staff Ids to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Document

Retrieves a single instance of staffDocument.

path Parameters
id
required
number

Number ID of the 'staffDocument' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff Document Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category of staff documents.

Get Staff Document Categories

Retrieves a page of instances of staffDocumentCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of Ids to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Document Category

Retrieves a single instance of staffDocumentCategory.

path Parameters
id
required
number

Number ID of the 'staffDocumentCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff Employment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about staff's employment in a particular school.

Post Staff Employment

Creates a new staffEmployement record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffEmployment

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • employmentStatus → String Employment status of the staff in the school. [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Employment classification of the staff in the school. [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Staff's job title in the school. [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Date when the staff's contract was started in the school. [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when the staff's contract will end in the school. [optional] [example: "2024-12-31"]
    • isWWCCCompleted → Boolean Whether Working With Children Check has been completed [optional] [example: NULL]
    • wWCCNumber → String Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCType → String Working With Children Check type. [optional] [example: NULL] Value constraints: Length must be between 50 and 0 characters, inclusive
    • wWCCResultDate → Date (Y-m-d, eg. 2019-12-31) When Working With Children Check results were produced. [optional] [example: "2023-02-11"]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2028-09-22"]
    • aGSNumber → String {DESCRIPTION-MISSING} [optional] [example: NULL]
    • positionNumber → String {DESCRIPTION-MISSING} [optional] [example: NULL]
    • payRate → String Staff's pay rate [optional] [example: "Administrative Services Officer Class 2"] Value constraints: Allowed values: "Classroom Teacher 3 Year Trained", "Classroom Teacher New Educator 1.1", "Classroom Teacher New Educator 1.2", "Classroom Teacher New Educator 1.3", "Classroom Teacher Experienced Teacher 1 2.1", "Classroom Teacher Experienced Teacher 1 2.2", "Classroom Teacher Experienced Teacher 1 2.3", "Classroom Teacher Experienced Teacher 1 2.4", "Classroom Teacher Experienced Teacher 2 3.1", "Classroom Teacher Experienced Teacher 2 3.2", "Classroom Teacher Executive Teacher 4.1", "Principal Deputy Principal 5.1", "Principal Principal 2 5.2", "Principal Principal 2+ 5.2", "Principal Principal 3 5.2", "Principal Principal 3+ 5.2", "Principal Principal 4 5.2", "Principal Principal 4+ 5.2", "Principal Principal 4++ 5.2", "Principal Principal 5 5.2", "Principal Principal 5+ 5.2", "Principal Principal 5++ 5.2", "Principal Principal 5+++ 5.2", "School Network Leader 6.1", "Casual Teacher 1", "Casual Teacher 2", "Casual Intern", "School Assistant 2", "School Assistant 2/3", "School Assistant 3", "School Assistant 4", "Administrative Services Officer Class 1", "Administrative Services Officer Class 2", "Administrative Services Officer Class 3", "Administrative Services Officer Class 4", "Administrative Services Officer Class 5", "Administrative Services Officer Class 6", "Senior Officer Grade C", "Senior Officer Grade B", "Senior Officer Grade A", "Graduate Administrative Assistant", "Building Service Officer 1", "Building Service Officer 2", "Building Service Officer 3", "Facilities Manager", "General Service Officer Level 2", "General Service Officer Level 3", "General Service Officer Level 4", "General Service Officer Level 5", "General Service Officer Level 6", "General Service Officer Level 7", "General Service Officer Level 8", "General Service Officer Level 9", "General Service Officer Level 10", "Information Communications Technology Trainee", "Information Technology Officer Class 1", "Information Technology Officer Post Graduate", "Information Technology Officer Class 2", "Senior Information Technology Officer Grade C", "Senior Information Technology Officer Grade B", "Senior Information Technology Officer Grade A", "Professional Officer Class 1", "Professional Officer Class 2", "Senior Professional Officer Grade C", "Senior Professional Officer Grade B", "Senior Professional Officer Grade A", "Senior Professional Officer (Eng & Related) A", "Health Professional Level 1 2", "Health Professional Level 1 3", "Health Professional Level 1 4", "Health Professional Level 1 5", "Health Professional Level 1 6+", "Health Professional Level 2", "Health Professional Level 3", "Health Professional Level 4", "Health Professional Level 5", "Health Professional Level 6", "Dental Assistant (Unqualified)", "Dental Assistant (Qualified)", "Principal Dental Assistant", "Disability Support Officer Level 1", "Disability Support Officer Level 2", "Disability Support Officer Level 3"
    • employmentCategory → String Staff's employment category [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • username → String Staff's username [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • teacherRegistrationNumber → String Staff's teacher registration number [optional] [example: NULL] Value constraints: Length must be between 50 and 0 characters, inclusive
    • areQualificationsProvided → Boolean Whether staff's qualifications were provided [optional] [example: NULL]
    • startDate → Date (Y-m-d, eg. 2019-12-31) Start Date of the Employment [optional] [example: NULL]
    • endDate → Boolean End Date of the Employment [optional] [example: "2020-01-01"]
    • isMainSchool → Boolean Whether this is the staffs main school enrolment [optional] [example: NULL]
  • Relationships
    • staff → [required] [single] expected type is staff. Staff member who has the employment.
    • school → [required] [single] expected type is school. School the employment is for.
    • house → [optional] [single] expected type is house. Staff's assigned house
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Employments

Retrieves a page of instances of staffEmployment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffIds
string

String Comma-separated list of staff relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Staff Employment

Deletes staff employment by ID

path Parameters
id
required
number

Number ID of the staffEmployment to delete. [example: 1]

Responses

Get Staff Employment

Retrieves a single instance of staffEmployment.

path Parameters
id
required
number

Number ID of the 'staffEmployment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Staff Employment

Updates an existing staff employment record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffEmployment

  • ID is required
  • Exactly 1 instance
  • Attributes
    • employmentStatus → String Employment status of the staff in the school. [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Employment classification of the staff in the school. [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Staff's job title in the school. [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Date when the staff's contract was started in the school. [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when the staff's contract will end in the school. [optional] [example: "2024-12-31"]
    • isWWCCCompleted → Boolean Whether Working With Children Check has been completed [optional] [example: NULL]
    • wWCCNumber → String Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCType → String Working With Children Check type. [optional] [example: NULL] Value constraints: Length must be between 50 and 0 characters, inclusive
    • wWCCResultDate → Date (Y-m-d, eg. 2019-12-31) When Working With Children Check results were produced. [optional] [example: "2023-02-11"]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2028-09-22"]
    • aGSNumber → String {DESCRIPTION-MISSING} [optional] [example: NULL]
    • positionNumber → String {DESCRIPTION-MISSING} [optional] [example: NULL]
    • payRate → String Staff's pay rate [optional] [example: "Administrative Services Officer Class 2"] Value constraints: Allowed values: "Classroom Teacher 3 Year Trained", "Classroom Teacher New Educator 1.1", "Classroom Teacher New Educator 1.2", "Classroom Teacher New Educator 1.3", "Classroom Teacher Experienced Teacher 1 2.1", "Classroom Teacher Experienced Teacher 1 2.2", "Classroom Teacher Experienced Teacher 1 2.3", "Classroom Teacher Experienced Teacher 1 2.4", "Classroom Teacher Experienced Teacher 2 3.1", "Classroom Teacher Experienced Teacher 2 3.2", "Classroom Teacher Executive Teacher 4.1", "Principal Deputy Principal 5.1", "Principal Principal 2 5.2", "Principal Principal 2+ 5.2", "Principal Principal 3 5.2", "Principal Principal 3+ 5.2", "Principal Principal 4 5.2", "Principal Principal 4+ 5.2", "Principal Principal 4++ 5.2", "Principal Principal 5 5.2", "Principal Principal 5+ 5.2", "Principal Principal 5++ 5.2", "Principal Principal 5+++ 5.2", "School Network Leader 6.1", "Casual Teacher 1", "Casual Teacher 2", "Casual Intern", "School Assistant 2", "School Assistant 2/3", "School Assistant 3", "School Assistant 4", "Administrative Services Officer Class 1", "Administrative Services Officer Class 2", "Administrative Services Officer Class 3", "Administrative Services Officer Class 4", "Administrative Services Officer Class 5", "Administrative Services Officer Class 6", "Senior Officer Grade C", "Senior Officer Grade B", "Senior Officer Grade A", "Graduate Administrative Assistant", "Building Service Officer 1", "Building Service Officer 2", "Building Service Officer 3", "Facilities Manager", "General Service Officer Level 2", "General Service Officer Level 3", "General Service Officer Level 4", "General Service Officer Level 5", "General Service Officer Level 6", "General Service Officer Level 7", "General Service Officer Level 8", "General Service Officer Level 9", "General Service Officer Level 10", "Information Communications Technology Trainee", "Information Technology Officer Class 1", "Information Technology Officer Post Graduate", "Information Technology Officer Class 2", "Senior Information Technology Officer Grade C", "Senior Information Technology Officer Grade B", "Senior Information Technology Officer Grade A", "Professional Officer Class 1", "Professional Officer Class 2", "Senior Professional Officer Grade C", "Senior Professional Officer Grade B", "Senior Professional Officer Grade A", "Senior Professional Officer (Eng & Related) A", "Health Professional Level 1 2", "Health Professional Level 1 3", "Health Professional Level 1 4", "Health Professional Level 1 5", "Health Professional Level 1 6+", "Health Professional Level 2", "Health Professional Level 3", "Health Professional Level 4", "Health Professional Level 5", "Health Professional Level 6", "Dental Assistant (Unqualified)", "Dental Assistant (Qualified)", "Principal Dental Assistant", "Disability Support Officer Level 1", "Disability Support Officer Level 2", "Disability Support Officer Level 3"
    • employmentCategory → String Staff's employment category [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • username → String Staff's username [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • teacherRegistrationNumber → String Staff's teacher registration number [optional] [example: NULL] Value constraints: Length must be between 50 and 0 characters, inclusive
    • areQualificationsProvided → Boolean Whether staff's qualifications were provided [optional] [example: NULL]
    • startDate → Date (Y-m-d, eg. 2019-12-31) Start Date of the Employment [optional] [example: NULL]
    • endDate → Boolean End Date of the Employment [optional] [example: "2020-01-01"]
    • isMainSchool → Boolean Whether this is the staffs main school enrolment [optional] [example: NULL]
  • Relationships
    • house → [optional] [single] expected type is house. Staff's assigned house
path Parameters
id
required
number

Number ID of the staffEmployment that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff Learning Log

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A log of a professional development of a staff member.

Get Staff Learning Logs

Retrieves a page of instances of staffLearningLog.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffIds
string

String Comma-separated list of staff relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Learning Log

Retrieves a single instance of staffLearningLog.

path Parameters
id
required
number

Number ID of the 'staffLearningLog' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff Qualification

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A staff member's qualification details

Post Staff Qualification

Creates a new staffQualification record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffQualification

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • qualification → String {DESCRIPTION-MISSING} [example: "Master's Degree"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • type → String Type of the qualification [optional] [example: "bachelors_degree"] Value constraints: Allowed values: "doctoral_degree", "masters_degree", "bachelors_degree", "tafe_certificate", "certificate"
    • from → String {DESCRIPTION-MISSING} [optional] [example: "Master's Degree"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • aitslTeacherAccreditationLevel → String {DESCRIPTION-MISSING} [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • nextAitslTeacherAccreditationLevel → String {DESCRIPTION-MISSING} [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • dateAchieved → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2019-01-01"]
  • Relationships
    • staff → [required] [single] expected type is staff. Staff memberwho has the qualification.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Qualifications

Retrieves a page of instances of staffQualification.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Staff Qualification

Deletes staff qualification by ID

path Parameters
id
required
number

Number ID of the staffQualification to delete. [example: 1]

Responses

Get Staff Qualification

Retrieves a single instance of staffQualification.

path Parameters
id
required
number

Number ID of the 'staffQualification' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Staff Qualification

Updates an existing staffQualification record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffQualification

  • ID is required
  • Exactly 1 instance
  • Attributes
    • qualification → String {DESCRIPTION-MISSING} [example: "Master's Degree"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • type → String Type of the qualification [optional] [example: "bachelors_degree"] Value constraints: Allowed values: "doctoral_degree", "masters_degree", "bachelors_degree", "tafe_certificate", "certificate"
    • from → String {DESCRIPTION-MISSING} [optional] [example: "Master's Degree"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • aitslTeacherAccreditationLevel → String {DESCRIPTION-MISSING} [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • nextAitslTeacherAccreditationLevel → String {DESCRIPTION-MISSING} [optional] [example: NULL] Value constraints: Length must be between 255 and 0 characters, inclusive
    • dateAchieved → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2019-01-01"]
  • No relationships
path Parameters
id
required
number

Number ID of the staffQualification that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A definition of a class in a timetable.

Get Students

Retrieves a page of instances of student.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

tenant
string

String Only return students who belong to the specified tenant. [optional] [default: ""] [example: "aSd2rs"] Value constraints: Length must be between 256 and 0 characters, inclusive

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentCodes
string

String Comma-separated list of studentCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

examNumbers
string

String Comma-separated list of examNumbers to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

refIds
string

String Comma-separated list of refIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

contactCodes
string

String Comma-separated list of contactCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of externalIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

academicPeriodIds
string

String Comma-separated list of academicPeriodIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student

Retrieves a single instance of student.

path Parameters
id
required
number

Number ID of the 'student' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Student

Updates an existing student

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

student

  • ID is required
  • Exactly 1 instance
  • Attributes
    • permissionToPhotograph → Boolean This field cannot be modified once it's not null. [example: TRUE]
    • usiId → String Updates the unique user identifier. [optional] [example: "c8370653bf584bd7644ccb2ba1f39e78"]
    • barcode → String Updates the barcode field. [optional] [example: "B000012680"]
    • examNumber → String Updates the examNumber field. [optional] [example: "Value123"]
    • studentCode → String Updates the studentCode field. [optional] [example: "40045"]
    • systemStudentId → String Updates the systemStudentId field. [optional] [example: "Value123"]
    • acaraId → Number Updates the acaraId field. [optional] [example: "Value234"]
    • username → String Updates the username field. [optional] [example: "john.smith"]
  • No relationships
path Parameters
id
required
number

Number ID of the student that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Absences

Retrieves a page of absence related to student via relation absences.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Related Academic Reports

Retrieves a page of studentAcademicReport related to student via relation academicReports.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Activities

Retrieves a page of activity related to student via relation activities.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venue. [optional] [default: null] [example: "venue"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Return only activities that end after this date. [optional] [default: null]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Return only activities that start before this date. [optional] [default: null]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Awards

Retrieves a page of award related to student via relation awards.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post Student Data Sync

Synchronizes a student into Sentra Data layer of used tenant - but only if the tenant uses Sentralenrolment importer.

path Parameters
id
required
number

Number ID of the student who should be synced with the Sentral Data layer. [example: 1]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Student Related Student Document

Adds a new 'studentDocument' to a 'studentEnrolmentDraft'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'document'.

path Parameters
id
required
number

Number ID of the 'STUDENT' to which the document should be added. [example: 1]

query Parameters
isConfidential
boolean

Boolean Controls whether the newly created file should be confidential or not. [optional] [default: false]

studentEnrolmentDraftId
number

Number ID of the studentEnrolmentDraft to which this document should be additionally attached. The draft must be related through student relation to the student to which the document is added. [optional] [example: 1]

categoryId
number

Number ID of the category relation to which this document should belong. [optional] [example: 1]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Student Documents

Retrieves all of studentDocument related to student via relation documents.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Related Edu Pro Academic Reports

Retrieves a page of studentAcademicReportEduPro related to student via relation eduProAcademicReports.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Enrolments

Retrieves all of enrolment related to student via relation enrolments.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

statuses
string

String Comma-separated list of enrolment types to filter by. Reference the model enrolment for the list of all supported types.. [optional] [default: active,active_pending,active_leaving] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Flags

Retrieves all of flag related to student via relation flags. Results will include inactive flags.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: school. [optional] [default: null] [example: "school"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Household Relations

Retrieves all of studentHouseholdRelation related to student via relation households.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, household. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

residentialHouseholdTypes
string

String Comma-separated list of Residential household types to filter by. Reference the model HouseholdStudentRelations for the list of all supported types.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Person

Retrieves a single instances of person based on the specified ID.

path Parameters
id
required
number

Number ID of the student whose person details should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Photo

Returns the photo of a given student. Allowed dimensions are: 50x50, 100x100, 250x250, 500x500. If provided dimensions don't match it'll return the next closest dimension available.

path Parameters
id
required
string

String ID of the student whose photo to retrieve. Also supports externalId for backwards compatibility.

query Parameters
width
number

Number Width of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

height
number

Number Height of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

avoidReturningMissingPhoto
string

String By default this method returns the photo of the student in the current tenant, even if the student has no custom photo there. With this option set to '1', if the student doesn't have a photo in the current tenant the endpoint will attempt to return a photo from another tenant this student is/was part of and return the photo from there. The mechanism will prefer the tenant where the student is currently enrolled, then earliest past tenants, then earlies future tenants. [optional] [default: "0"] Value constraints: Allowed values: "1", "0"

Responses

Get Student Primary Enrolment

Retrieves a single instance of enrolment, the relation primaryEnrolment of student.

path Parameters
id
required
number

Number ID of the 'student' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Special Needs Programs

Retrieves all of specialNeedsProgram related to student via relation specialNeedsPrograms.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: students. [optional] [default: null] [example: "students"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Tenants

Retrieves all of tenant related to student via relation tenants.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: schools. [optional] [default: null] [example: "schools"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Timetable Lessons

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the student which timetable should be retrieved for a given date.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to retrieve timetable lessons, inclusive range. When not specified it defaults to today. [optional] [default: Today]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to retrieve timetable lessons, inclusive range. When not specified it uses fromDate. Max allowed number of days to fetch data is 31. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Timetable Lessons Legacy

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the student which timetable should be retrieved for a given date.

date
required
string

Date (Y-m-d, eg. 2019-12-31) Date for which the timetable should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Student Contact

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Contacts

Retrieves a page of instances of studentPersonRelation.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, studentPerson, person. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

excludeSelf
boolean

Boolean When true will exclude relation records which link the student to themself. [optional] [default: false] [example: "1"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Contact

Retrieves a single instance of studentPersonRelation.

path Parameters
id
required
string

String matching regular expression: ^(\d+|derived-\d+-\d+)$ ID of the 'studentPersonRelation' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, studentPerson, person. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Student Person Relation

Modifies an existing Contact Relation record of a student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentPersonRelation

  • ID is required
  • Exactly 1 instance
  • Attributes
    • isFinanciallyResponsible → Boolean Controls whether this contact is a debtor for the student. When false feeSplitPercentage will be set to 0. [example: TRUE]
    • feeSplitPercentage → Number The percentage of the fee that the contact is responsible for. Ignored if feeSplitPercentage is false. Total value of all student's relations which have feeSplitPercentage set to true must be 100, otherwise an exception will be thrown. [optional] [example: "100"] Value constraints: Minimum value: 0 [inclusive] Maximum value: 100 [inclusive]
  • No relationships
path Parameters
id
required
number

Number ID of the studentPersonRelation to modify [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Contact Student

Retrieves a single instance of student, the relation relatedStudent of studentPersonRelation.

path Parameters
id
required
string

String matching regular expression: ^(\d+|derived-\d+-\d+)$ ID of the 'studentPersonRelation' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Document

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Documents

Retrieves a page of instances of studentDocument.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Student Document

Deletes studentDocument of given id

path Parameters
id
required
number

Number ID of the studentDocument to delete.

Responses

Get Student Document

Retrieves a single instance of studentDocument.

path Parameters
id
required
number

Number ID of the 'studentDocument' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Document File

Returns the actual file of the given student document

path Parameters
id
required
number

Number ID of the studentDocument which file to retrieve

Responses

Student Document Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category of student documents.

Get Student Document Categories

Retrieves a page of instances of studentDocumentCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Document Category

Retrieves a single instance of studentDocumentCategory.

path Parameters
id
required
number

Number ID of the 'studentDocumentCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Household

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Households

Deprecated! Please use personHouseholdRelation models instead. Retrieves a page of instances of studentHouseholdRelation.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, household. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Household

Deprecated! Please use personHouseholdRelation models instead. Retrieves a single instance of studentHouseholdRelation.

path Parameters
id
required
string

String matching regular expression: ^(\d+|derived-\d+-\d+)$ ID of the 'studentHouseholdRelation' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, household. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Household Household

Deprecated! Please use personHouseholdRelation models instead. Retrieves a single instance of household, the relation relatedHousehold of studentHouseholdRelation.

path Parameters
id
required
string

String matching regular expression: ^(\d+|derived-\d+-\d+)$ ID of the 'studentHouseholdRelation' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: addresses. [optional] [default: null] [example: "addresses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Household Student

Deprecated! Please use personHouseholdRelation models instead. Retrieves a single instance of student, the relation relatedStudent of studentHouseholdRelation.

path Parameters
id
required
string

String matching regular expression: ^(\d+|derived-\d+-\d+)$ ID of the 'studentHouseholdRelation' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Nccd Record

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Student's NCCD record

Post Student Nccd Record

Adds a new NCCD record to a student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentNccdRecord

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • categoryCode → String Disability category [example: "COG"] Value constraints: Allowed values: "COG", "PHY", "SEN", "SE"
    • adjustmentLevelCode → String Level of adjustment [example: "SUB"] Value constraints: Allowed values: "EXT", "SUB", "SUP", "QDTP"
    • educationType → String Education type of the NCCD record [example: ""]
  • Relationships
    • student → [required] [single] expected type is student. Student to whom the record belongs.
    • school → [required] [single] expected type is school. School .
    • academicPeriod → [required] [single] expected type is academicPeriod. Student to whom the record belongs.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Nccd Records

Retrieves a page of instances of studentNccdRecord.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

academicPeriodIds
string

String Comma-separated list of academicPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Student Nccd Record

Deletes `studentNccdRecord`` of given id

path Parameters
id
required
number

Number ID of the studentNccdRecord to delete.

Responses

Get Student Nccd Record

Retrieves a single instance of studentNccdRecord.

path Parameters
id
required
number

Number ID of the 'studentNccdRecord' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Student Nccd Record

Modifies an existing NCCD record of a student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentNccdRecord

  • ID is required
  • Exactly 1 instance
  • Attributes
    • categoryCode → String Disability category [example: "COG"] Value constraints: Allowed values: "COG", "PHY", "SEN", "SE"
    • adjustmentLevelCode → String Level of adjustment [example: "SUB"] Value constraints: Allowed values: "EXT", "SUB", "SUP", "QDTP"
    • educationType → String Education type of the NCCD record [example: ""]
  • No relationships
path Parameters
id
required
number

Number ID of the studentNccdRecord to modify [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Note

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A text note linked to a student

Get Student Notes

Retrieves a page of instances of studentNote.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of 'student' relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

noteTypeIds
string

String Comma-separated list of 'noteType' relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Note

Retrieves a single instance of studentNote.

path Parameters
id
required
number

Number ID of the 'studentNote' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student School History

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about student's past schools

Get Student Class Histories

Retrieves a page of instances of studentSchoolHistory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student School History

Retrieves a single instance of studentSchoolHistory.

path Parameters
id
required
number

Number ID of the 'studentSchoolHistory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Transfer

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

The transfer information for a student.

Post Student Transfer

Creates a student transfer record while also enrolling them in the target school and, optionally, creating a departure record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentTransfer

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • destinationEnrolmentType → String Sentral enrolment type [example: "active"] Value constraints: Allowed values: "alumni", "applied", "draft", "enquired", "accepted", "active", "active_pending", "active_leaving", "expelled", "external", "external_pending", "interview_required", "interview_review", "never_attended", "not_approved", "offered_rejected", "offered", "waitlist_offered_rejected", "waitlist_offered", "offered_to_send", "waitlist_offered_to_send", "tested_successful", "tested_unsuccessful", "transferred", "transitioning_students", "under_appeal", "waitlisted", "leave_of_absence", "confirmed", "withdrawn"
    • destinationEnrolmentStartDate → Date (Y-m-d, eg. 2019-12-31) The start date of student's enrolment [example: "2022-01-01"]
    • destinationIntendedStartDate → Date (Y-m-d, eg. 2019-12-31) The intended start date of the student's enrolment [optional] [example: "2022-01-01"]
    • reasonLeaving → String Departure reason of current enrolment [optional] [default: null] [example: "Bad behaviour"]
    • handoverCompleteDate → DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) The complete date of the transfer [optional] [default: null] [example: "2022-01-01"]
    • sourceExitDate → Date (Y-m-d, eg. 2019-12-31) The exit date of current enrolment, will create a departure record when provided [optional] [default: null] [example: "2022-01-01"]
    • sourceEnrolmentEndDate → Date (Y-m-d, eg. 2019-12-31) The end date of current enrolment [optional] [default: null] [example: "2022-01-01"]
  • Relationships
    • student → [required] [single] expected type is student. Student whose transfer record to create
    • sourceSchool → [required] [single] expected type is school. The school the student transfers from
    • destinationSchool → [required] [single] expected type is school. The school the student transfers to
    • academicPeriod → [required] [single] expected type is academicPeriod. Academic period during which the transfer happens
    • yearLevel → [required] [single] expected type is yearLevel. Target year level of the transfer
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Transfer

Retrieves a single instance of studentTransfer.

path Parameters
id
required
number

Number ID of the 'studentTransfer' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Vaccination

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about vaccination.

Get Vaccinations

Retrieves a page of instances of vaccination.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Vaccination

Retrieves a single instance of vaccination.

path Parameters
id
required
number

Number ID of the 'vaccination' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Year Level

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A year level.

Get Year Levels

Retrieves a page of instances of yearLevel.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schoolIds
string

String Comma-separated list of school relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

names
string

String Comma-separated list of name attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

codes
string

String Comma-separated list of code attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

censusYears
string

String Comma-separated list of name attribute values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Year Level

Retrieves a single instance of yearLevel.

path Parameters
id
required
number

Number ID of the 'yearLevel' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Access Ability

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

An access ability for an application

Get Access Abilities

Retrieves a page of instances of accessAbility.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

applications
string

String Comma-separated list of Applications to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Access Ability

Retrieves a single instance of accessAbility.

path Parameters
id
required
number

Number ID of the 'accessAbility' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Access Level

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

An access level designated for staff

Get Access Levels

Retrieves all instances of accessLevel.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Access Level

Retrieves a single instance of accessLevel.

path Parameters
id
required
number

Number ID of the 'accessLevel' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Access Level Ability

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

The abilities associated with an access level

Get Access Level Abilities

Retrieves a page of instances of accessLevelAbility.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: accessAbility, accessLevel. [optional] [default: null] [example: "accessAbility"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

accessLevelIds
string

String Comma-separated list of Access Level IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

accessAbilityIds
string

String Comma-separated list of Access Ability IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

types
string

String Comma-separated list of Types to filter by (GLOBAL, TENANT). [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

tenantIds
string

String Comma-separated list of Tenant IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Access Level Ability

Retrieves a single instance of accessLevelAbility.

path Parameters
id
required
number

Number ID of the 'accessLevelAbility' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: accessAbility, accessLevel. [optional] [default: null] [example: "accessAbility"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Administrative User

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

An administrative user account for administrator or staff member.

Get Administrative Users

Retrieves a page of instances of administrativeUser.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs by which to filter. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

firstNameSearch
string

String Search for firstName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "John%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

lastNameSearch
string

String Search for lastName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Doe"] Value constraints: Length must be between 1024 and 0 characters, inclusive

usernameSearch
string

String Search for username. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "admin_"] Value constraints: Length must be between 1024 and 0 characters, inclusive

emailSearch
string

String Search for email. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "%@gmail.com"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Administrative User

Retrieves a single instance of administrativeUser.

path Parameters
id
required
number

Number ID of the 'administrativeUser' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calendar

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Get Calendars

This endpoint is deprecated. Please use endpoints for userCalendar (CM-) or webcalCalendar (SM-) instead. Retrieves a page of instances of calendar.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

type
required
string

String Type of the calendars to return Value constraints: Allowed values: "CM", "SM"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Calendar

This endpoint is deprecated. Please use endpoints for userCalendar (CM-) or webcalCalendar (SM-) instead. Retrieves a single instance of calendar.

path Parameters
id
required
string

String matching regular expression: ^(CM|SM)-\d+$ ID of the 'calendar' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Calender Events

This endpoint is deprecated. Please use endpoints for userCalendar (CM-) or webcalCalendar (SM-) instead. Retrieves a page of calendarEvent related to calendar via relation events.

path Parameters
id
required
string

String matching regular expression: ^(CM|SM)-\d+$ ID of the 'calendar', which related models will be retrieved. [example: 17]

type
required
string

String Type of the events to retrieve. Due to underlying database constraints, calendars of type CM support only CM events, while SM calendar supports both SM and RG. Value constraints: Allowed values: "CM", "SM", "RG"

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Only include events that end after this date. [optional]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Only include events that start before this date. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Calendar Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

This model is deprecated. Please use `userCalendarEvent` (CM-), `webcalCalendarEvent` (SM-) or `webcalCalendarRecurringEvent` (RG-) instead. A calendar event inside a calendar.

Get Calendar Events

This endpoint is deprecated. Please use endpoints for userCalendarEvent (CM-), webcalCalendarEvent (SM-) or webcalCalendarRecurringEvent (RG-) instead. Retrieves a page of instances of calendarEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

type
required
string

String Type of the calendar events to return Value constraints: Allowed values: "CM", "SM", "RG"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Calendar Event

This endpoint is deprecated. Please use endpoints for userCalendarEvent (CM-), webcalCalendarEvent (SM-) or webcalCalendarRecurringEvent (RG-) instead. Retrieves a single instance of calendarEvent.

path Parameters
id
required
string

String matching regular expression: ^(CM|SM|RG)-\d+$ ID of the 'calendarEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enterprise Term

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Reference school terms

Get Term Dates

Retrieves a page of instances of enterpriseTerms.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

regions
string

String Comma-separated list of regions to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Term Date

Retrieves a single instance of enterpriseTerms.

path Parameters
id
required
number

Number ID of the 'enterpriseTerms' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Portal Access Level

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    }
}

A portal access level designated for parents

Get Portal Access Levels

Retrieves all instances of portalAccessLevel.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Portal Access Level

Retrieves a single instance of portalAccessLevel.

path Parameters
id
required
number

Number ID of the 'portalAccessLevel' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Portal User

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A user account for student or guardian.

Get Portal Users

Retrieves a page of instances of portalUser.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

emails
string

String Comma-separated list of emails to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Portal User

Retrieves a single instance of portalUser.

path Parameters
id
required
number

Number ID of the 'portalUser' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Tenant

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Tenants

Retrieves all instances of tenant.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: schools. [optional] [default: null] [example: "schools"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Tenant

Retrieves a single instance of tenant.

path Parameters
id
required
number

Number ID of the 'tenant' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: schools. [optional] [default: null] [example: "schools"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Tenant

Updates an existing Tenant

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

tenant

  • ID is required
  • Exactly 1 instance
  • Attributes
    • code → String Tenant code [optional] [example: "DUMMY123"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • name → String Tenant name [optional] [example: "Dummy Primary School"] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • region → String Tenant region [optional] [example: "NSW"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of the Tenant that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Tenant Schools

Retrieves all of school related to tenant via relation schools.

path Parameters
id
required
number

Number ID of the 'tenant', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: tenant. [optional] [default: null] [example: "tenant"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Tenant Term Dates

Retrieves all of enterpriseTerms related to tenant via relation termDates.

path Parameters
id
required
number

Number ID of the 'tenant', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

User Calendar

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A calendar belonging to a poral user (a student or a parent).

Post User Calendar

Creates a new userCalendar

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

userCalendar

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • calendarName → String Display name of the calendar [optional] [example: "2UMMO"]
    • externalSource → String External source of the calendar [optional] [example: "2UMMO"]
    • externalId → String ID used in the external source [optional] [example: "2UMMO"]
    • refId → String Internal identifier used for mapping same models between different modules [optional] [example: "2UMMO"]
  • Relationships
    • owner → [required] [single] expected type is administrativeUser. User who owns the calendar.
    • portalOwner → [optional] [single] expected type is portalUser. Portal user who owns the calendar
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get User Calendars

Retrieves a page of instances of userCalendar.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

ownerIds
string

String Comma-separated list of owner relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

portalOwnerIds
string

String Comma-separated list of portalOwner relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete User Calendar Remove Event

path Parameters
calendarId
required
number

Number ID of the userCalendar from which the event will be removed [example: 1]

eventId
required
number

Number ID of the userCalendarEvent which will be unlinked [example: 1]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Post User Calendar Add Event

path Parameters
calendarId
required
number

Number ID of the userCalendar to which the event will be added [example: 1]

eventId
required
number

Number ID of the userCalendarEvent which will be linked [example: 1]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Delete User Calendar

Deletes userCalendar by ID

path Parameters
id
required
number

Number ID of the userCalendar to delete. [example: 1]

Responses

Get User Calendar

Retrieves a single instance of userCalendar.

path Parameters
id
required
number

Number ID of the 'userCalendar' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch User Calendar

Updates an existing userCalendar

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

userCalendar

  • ID is required
  • Exactly 1 instance
  • Attributes
    • calendarName → String Display name of the calendar [optional] [example: "2UMMO"]
    • externalSource → String External source of the calendar [optional] [example: "2UMMO"]
    • externalId → String ID used in the external source [optional] [example: "2UMMO"]
    • refId → String Internal identifier used for mapping same models between different modules [optional] [example: "2UMMO"]
  • No relationships
path Parameters
id
required
number

Number ID of the userCalendar that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

User Calendar Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

An event in a user calendar

Post User Calendar Event

Creates a new userCalendarEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

userCalendarEvent

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • title → String Event title [optional] [example: "Biology Teacher Hire"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • description → String Event description [optional] [example: "Hiring of a new Biology teacher will be discussed."] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • recordType → String Type of the record that this event is related to [optional] [example: "activities"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • recordSubtype → String Subtype of the record that event is related to [optional] [example: "Sport"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • location → String Where the event takes place [optional] [example: "2UMMO"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • timezone → String Timezone of the event [optional] [example: "Australia/Sydney"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • startsAt → DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) When the event starts [optional] [example: "2020-02-02 11:00:00"]
    • endsAt → DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) When the event ends [optional] [example: "2020-02-02 12:30:00"]
  • Relationships
    • userCalendars → [optional] [collection] expected type is userCalendar. Calendars to which this event should be added
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get User Calendar Events

Retrieves a page of instances of userCalendarEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

creatorIds
string

String Comma-separated list of creator relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

calendarIds
string

String Comma-separated list of userCalendar IDs that events belong to, to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete User Calendar Event

Deletes userCalendarEvent by ID

path Parameters
id
required
number

Number ID of the userCalendarEvent to delete. [example: 1]

Responses

Get User Calendar Event

Retrieves a single instance of userCalendarEvent.

path Parameters
id
required
number

Number ID of the 'userCalendarEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch User Calendar Event

Updates an existing userCalendarEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

userCalendarEvent

  • ID is required
  • Exactly 1 instance
  • Attributes
    • title → String Event title [optional] [example: "Biology Teacher Hire"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • description → String Event description [optional] [example: "Hiring of a new Biology teacher will be discussed."] Value constraints: Length must be between 4294967295 and 0 characters, inclusive
    • recordType → String Type of the record that this event is related to [optional] [example: "activities"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • recordSubtype → String Subtype of the record that event is related to [optional] [example: "Sport"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • location → String Where the event takes place [optional] [example: "2UMMO"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • timezone → String Timezone of the event [optional] [example: "Australia/Sydney"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • startsAt → DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) When the event starts [optional] [example: "2020-02-02 11:00:00"]
    • endsAt → DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) When the event ends [optional] [example: "2020-02-02 12:30:00"]
  • No relationships
path Parameters
id
required
number

Number ID of the userCalendarEvent that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Config

Get Configs

Retrieves a page of instances of feesConfig.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

name
string

String Comma-separated list of name to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

value
string

String Comma-separated list of value to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Config

Retrieves a single instance of feesConfig.

path Parameters
id
required
number

Number ID of the 'feesConfig' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Debtor

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Debtors

Retrieves a page of instances of debtor.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Debtor

Retrieves a single instance of debtor.

path Parameters
id
required
number

Number ID of the 'debtor' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Debtor Invoices

Retrieves a page of invoice related to debtor via relation invoices.

path Parameters
id
required
number

Number ID of the 'debtor', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Debtor Status

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Status of a debtor.

Get Debtor Statuses

Retrieves a page of instances of debtorStatus.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Debtor Status

Retrieves a single instance of debtorStatus.

path Parameters
id
required
number

Number ID of the 'debtorStatus' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Donor Status

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Status of a donor.

Get Donor Statuses

Retrieves a page of instances of donorStatus.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Donor Status

Retrieves a single instance of donorStatus.

path Parameters
id
required
number

Number ID of the 'donorStatus' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fee Status

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A generic status for the fees namespace.

Get Fee Statuses

Retrieves a page of instances of feeStatus.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

types
string

String Comma-separated list of types to filter by. Allowed values are: invoice. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Fee Status

Retrieves a single instance of feeStatus.

path Parameters
id
required
number

Number ID of the 'feeStatus' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Invoice

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Invoices

Retrieves a page of instances of invoice.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

debtorIds
string

String Comma-separated list of debtor IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

statusIds
string

String Comma-separated list of status IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Invoice

Retrieves a single instance of invoice.

path Parameters
id
required
number

Number ID of the 'invoice' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Invoice Related Items

Retrieves a page of invoiceItem related to invoice via relation items.

path Parameters
id
required
number

Number ID of the 'invoice', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Invoice Item

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Item on an invoice

Get Invoice Items

Retrieves a page of instances of invoiceItem.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

invoiceIds
string

String Comma-separated list of invoice IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Invoice Item

Retrieves a single instance of invoiceItem.

path Parameters
id
required
number

Number ID of the 'invoiceItem' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Online Bill

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

{DESCRIPTION-MISSING}

Get Online Bills

Retrieves a page of instances of onlineBill.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Online Bill

Retrieves a single instance of onlineBill.

path Parameters
id
required
number

Number ID of the 'onlineBill' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Online Payment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

{DESCRIPTION-MISSING}

Get Online Payments

Retrieves a page of instances of onlinePayment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Online Payment

Retrieves a single instance of onlinePayment.

path Parameters
id
required
number

Number ID of the 'onlinePayment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Medical Certificate

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Get Medical Certificates

Retrieves a page of instances of medicalCertificate.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Certificate

Retrieves a single instance of medicalCertificate.

path Parameters
id
required
number

Number ID of the 'medicalCertificate' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Certificate Attachment

Adds a new 'medicalCertificateAttachment' to a 'medicalCertificate'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'attachment'.

path Parameters
id
required
number

Number ID of the 'medicalCertificate' to which the attachment should be added. [example: 1]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Certificate Attachments

Retrieves all of medicalCertificateAttachment related to medicalCertificate via relation attachments.

path Parameters
id
required
number

Number ID of the 'medicalCertificate', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Medical Certificate Student

Retrieves a single instance of student, the relation student of medicalCertificate.

path Parameters
id
required
number

Number ID of the 'medicalCertificate' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Medical Certificate Attachment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Delete Medical Certificate Attachment

Removes an existing 'medicalStudentAttachment'

path Parameters
id
required
number

Number ID of 'medicalStudentAttachment' to remove. [example: 1]

Responses

Get Medical Certificate Attachment

Retrieves a single instance of medicalCertificateAttachment.

path Parameters
id
required
number

Number ID of the 'medicalCertificateAttachment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Certificate Attachment Certificate

Retrieves a single instance of medicalCertificate, the relation certificate of medicalCertificateAttachment.

path Parameters
id
required
number

Number ID of the 'medicalCertificateAttachment' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Certificate Attachment File

Returns the actual file of the given medicalCertificateAttachment

path Parameters
id
required
number

Number ID of the medicalCertificateAttachment which file to retrieve

Responses

Interview Booking

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A date combined with time period of availability for an interview session

Get Interview Bookings

Retrieves a page of instances of interviewBooking.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Booking

Retrieves a single instance of interviewBooking.

path Parameters
id
required
number

Number ID of the 'interviewBooking' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Interview Class Link Class

Retrieves a single instance of class, the relation class of interviewClassLink.

path Parameters
id
required
number

Number ID of the 'interviewClassLink' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Interview Class Link Interview Session

Retrieves a single instance of interviewSession, the relation interviewSession of interviewClassLink.

path Parameters
id
required
number

Number ID of the 'interviewClassLink' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Interview Class Link Rollclass

Retrieves a single instance of rollclass, the relation rollclass of interviewClassLink.

path Parameters
id
required
number

Number ID of the 'interviewClassLink' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Interview Class Link Students

Retrieves all of student related to interviewClassLink via relation students.

path Parameters
id
required
number

Number ID of the 'interviewClassLink', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Interview Session

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Get Interview Sessions

Retrieves a page of instances of interviewSession.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session

Retrieves a single instance of interviewSession.

path Parameters
id
required
number

Number ID of the 'interviewSession' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Interview Session Interview Bookings

Retrieves a page of interviewBooking related to interviewSession via relation bookings.

path Parameters
id
required
number

Number ID of the 'interviewSession', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session Classes

Retrieves all of class related to interviewSession via relation classes.

path Parameters
id
required
number

Number ID of the 'interviewSession', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session Interview Session Dates

Retrieves all of interviewSessionDate related to interviewSession via relation dates.

path Parameters
id
required
number

Number ID of the 'interviewSession', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session Rollclasses

Retrieves all of rollclass related to interviewSession via relation rollclasses.

path Parameters
id
required
number

Number ID of the 'interviewSession', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session Students

Retrieves a page of student related to interviewSession via relation students.

path Parameters
id
required
number

Number ID of the 'interviewSession', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Interview Session Date

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A date combined with time period of availability for an interview session

Get Interview Session Dates

Retrieves a page of instances of interviewSessionDate.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Interview Session Date

Retrieves a single instance of interviewSessionDate.

path Parameters
id
required
number

Number ID of the 'interviewSessionDate' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Markbook

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Markbook

Creates a new markbook that can be edited by the API. It auto sets externalSource to REST_API.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

markbook

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • name → String Name of the markbook. [example: "Year 12 Physics 2018"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • year → Number Year which this markbook covers [example: "2019"] Value constraints: Minimum value: 2025 [inclusive]
    • description → String Additional information about the markbook [example: "General marks"] Value constraints: Length must be between 65535 and 0 characters, inclusive
    • externalId → String ID of this markbook in the external system [optional] [example: "65283817-1500-47d0-94ce-4c30f3c64692"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • Relationships
    • category → [required] [single] expected type is markbookCategory.
    • createdBy → [required] [single] expected type is administrativeUser.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Markbooks

Retrieves a page of instances of markbook.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

categoryIds
string

String Comma-separated list of category relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

createdByIds
string

String Comma-separated list of createdBy relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Markbook

Removes a single instance of markbook provided its externalSource equals REST_API.

path Parameters
id
required
number

Number ID of the referenced 'markbook*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Markbook

Retrieves a single instance of markbook.

path Parameters
id
required
number

Number ID of the 'markbook' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Markbook

Updates an existing marbook

path Parameters
id
required
number

Number ID of markbook to modify [example: 7]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Markbook Related Classes

Retrieves a page of class related to markbook via relation classes.

path Parameters
id
required
number

Number ID of the 'markbook', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Markbook Related Core Classes

Retrieves a page of coreClass related to markbook via relation classes.

path Parameters
id
required
number

Number ID of the 'markbook', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedStudents, assignedStaff, coreSubject, timetableClass. [optional] [default: null] [example: "assignedStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Markbook Related Students

Retrieves a page of student related to markbook via relation students.

path Parameters
id
required
number

Number ID of the 'markbook', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Markbook Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A category for a markbook

Get Markbook Categories

Retrieves a page of instances of markbookCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

types
string

String Comma-separated list of types to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

createdByIds
string

String Comma-separated list of createdBy relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Markbook Category

Retrieves a single instance of markbookCategory.

path Parameters
id
required
number

Number ID of the 'markbookCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Markbook Column

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Markbook Columns

Retrieves a page of instances of markbookColumn.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

markbookIds
string

String Comma-separated list of markbook relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Markbook Column

Retrieves a single instance of markbookColumn.

path Parameters
id
required
number

Number ID of the 'markbookColumn' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Markbook Column Related Marks

Retrieves all of markbookColumnMark related to markbookColumn via relation marks.

path Parameters
id
required
number

Number ID of the 'markbookColumn', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Markbook Column Mark

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A mark in a markbook column for a student

Get Markbook Column Mark

Retrieves a single instance of markbookColumnMark.

path Parameters
id
required
string

String matching regular expression: ^\d+-\d+$ ID of the 'markbookColumnMark' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Incoming Message

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

An incoming message.

Get Incoming Messages

Retrieves a page of instances of incomingMessage.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Incoming Message

Retrieves a single instance of incomingMessage.

path Parameters
id
required
number

Number ID of the 'incomingMessage' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Outgoing Message

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Outgoing Messages

Retrieves a page of instances of outgoingMessage.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: recipients. [optional] [default: null] [example: "recipients"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

subjectPersonIds
string

String Comma-separated list of person IDs, filters the messages by subject relation through all of the message's recipients. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

recipientIds
string

String Comma-separated list of person IDs, filters the messages by recipient relation through all of the message's recipients.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Outgoing Message

Retrieves a single instance of outgoingMessage.

path Parameters
id
required
number

Number ID of the 'outgoingMessage' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: recipients. [optional] [default: null] [example: "recipients"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Outgoing Message Related Recipients

Retrieves all of outgoingMessageRecipient related to outgoingMessage via relation recipients.

path Parameters
id
required
number

Number ID of the 'outgoingMessage', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Outgoing Message Recipient

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

{DESCRIPTION-MISSING}

Get Outgoing Message Recipients

Retrieves a page of instances of outgoingMessageRecipient.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Outgoing Message Recipient

Retrieves a single instance of outgoingMessageRecipient.

path Parameters
id
required
number

Number ID of the 'outgoingMessageRecipient' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Plan

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Plans

Retrieves a page of instances of studentPlan.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentIds
string

String Comma-separated list of related student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

createdByIds
string

String Comma-separated list of related createdBy IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

typeIds
string

String Comma-separated list of related type IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Plan

Retrieves a single instance of studentPlan.

path Parameters
id
required
number

Number ID of the 'studentPlan' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Plan Published File

Returns the actual published file of the given student plan. If the plan is not published it throws an error.

path Parameters
id
required
number

Number ID of the studentPlan which published file to retrieve

Responses

Student Plan Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A type of a student plan.

Get Student Plan Types

Retrieves a page of instances of studentPlanType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Plan Type

Retrieves a single instance of studentPlanType.

path Parameters
id
required
number

Number ID of the 'studentPlanType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Activity Response

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A guardian response to an activity pertaining a specific student.

Delete Activity Response

Deletes an existing 'activityResponse'.

path Parameters
id
required
number

Number ID of the activityResponse that should be deleted. [example: 1]

Responses

Get Activity Response

Retrieves a single instance of activityResponse.

path Parameters
id
required
number

Number ID of the 'activityResponse' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Activity Response

Updates an existing activityResponse.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

activityResponse

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalNotes → String {DESCRIPTION-MISSING} [optional] [example: "Response was delivered via snail mail"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • medicalDetails → String {DESCRIPTION-MISSING} [optional] [example: "None"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • emergencyContactDetails → String {DESCRIPTION-MISSING} [optional] [example: "Mother, Jane Doe, +48 123-123-123"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • consentedBy → String {DESCRIPTION-MISSING} [optional] [example: "Mother"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • permissionGiven → String {DESCRIPTION-MISSING} [example: "Yes"] Value constraints: Allowed values: "Unknown", "Yes", "No", "Excluded"
    • isPaid → Boolean {DESCRIPTION-MISSING} [example: FALSE]
  • No relationships
path Parameters
id
required
number

Number ID of the activityResponse that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Family Change Request

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Family Change Request

Adds a new 'familyChangeRequest' with optional additional details

Payload has the following requirements:

  • Expects a non-empty collection.

And supports these models:

familyChangeRequest

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • externalId → String ID of this model in an external system [optional] [example: "7b5d6a86-6e8d-4eec-80cb-1e22765d617f"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • Relationships
    • affectedStudent → [required] [single] expected type is student.

familyChangeRequestDetail

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • objectType → String Type of the object to be created/modified/deleted. [example: "CONTACT"] Value constraints: Allowed values: "FAMILY", "STUDENT", "USER", "CONTACT", "HOUSEHOLD", "STUDENT_CONTACT_RELATIONSHIP", "EMERGENCY_CONTACT_ORDER"
    • objectId → String matching regular expression: ^(?:[1-9]\d*|new_\d+)$ ID of the modified/deleted object or new_<number> for creating new models [example: "1"]
    • subObjectType → String Type of the related object to be created/modified/deleted. [optional] [default: null] [example: "HOUSEHOLD_ADDRESS"] Value constraints: Allowed values: "HOUSEHOLD_ADDRESS", "CONTACT_PHONE", "CONTACT_EMAIL"
    • subObjectId → String matching regular expression: ^(?:[1-9]\d*|new_\d+)$ ID of the modified/deleted related object or new_<number> for creating new related model [optional] [default: null] [example: "1"]
    • field → String Name of the field that should be changed [example: "email_address"]
    • isDeleteOperation → Boolean Name of the field that should be changed [optional] [default: false] [example: "email_address"]
    • value → String New value for the field [optional] [example: "new.parents.email@example.com"]
  • No relationships
Request Body schema: application/vnd.api+json
object or object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Family Change Requests

Retrieves a page of instances of familyChangeRequest.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of externalIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

affectedStudentIds
string

String Comma-separated list of related affectedStudent IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Family Change Request

Deletes an existing, incomplete 'familyChangeRequest'

path Parameters
id
required
number

Number ID of the 'familyChangeRequest' which should be deleted. [example: 1]

Responses

Get Family Change Request

Retrieves a single instance of familyChangeRequest.

path Parameters
id
required
number

Number ID of the 'familyChangeRequest' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Family Change Request Detail

Adds a new detail to the 'familyChangeRequest'

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

familyChangeRequestDetail

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • objectType → String Type of the object to be created/modified/deleted. [example: "CONTACT"] Value constraints: Allowed values: "FAMILY", "STUDENT", "USER", "CONTACT", "HOUSEHOLD", "STUDENT_CONTACT_RELATIONSHIP", "EMERGENCY_CONTACT_ORDER"
    • objectId → String matching regular expression: ^(?:[1-9]\d*|new_\d+)$ ID of the modified/deleted object or new_<number> for creating new models [example: "1"]
    • subObjectType → String Type of the related object to be created/modified/deleted. [optional] [default: null] [example: "HOUSEHOLD_ADDRESS"] Value constraints: Allowed values: "HOUSEHOLD_ADDRESS", "CONTACT_PHONE", "CONTACT_EMAIL"
    • subObjectId → String matching regular expression: ^(?:[1-9]\d*|new_\d+)$ ID of the modified/deleted related object or new_<number> for creating new related model [optional] [default: null] [example: "1"]
    • field → String Name of the field that should be changed [example: "email_address"]
    • isDeleteOperation → Boolean Name of the field that should be changed [optional] [default: false] [example: "email_address"]
    • value → String New value for the field [optional] [example: "new.parents.email@example.com"]
  • No relationships
path Parameters
id
required
number

Number ID of the 'familyChangeRequest' to which a detail should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Family Change Request Details

Retrieves all of familyChangeRequestDetail related to familyChangeRequest via relation details.

path Parameters
id
required
number

Number ID of the 'familyChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Family Change Request Detail

Deletes an existing 'familyChangeRequestDetail' that belongs to an incomplete 'familyChangeRequest'.

path Parameters
id
required
number

Number ID of the 'familyChangeRequest' of which detail should be deleted. [example: 1]

detailId
required
number

Number ID of the 'familyChangeRequestDetail' to remove. [example: 1]

Responses

Get Family Change Request Detail

Retrieves a single instances of familyChangeRequestDetail based on the specified ID.

path Parameters
id
required
number

Number ID of the 'familyChangeRequest' of which detail should be retrieved. [example: 1]

detailId
required
number

Number ID of the 'familyChangeRequestDetail' to get. [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Family Change Request Detail

Adds a new detail to the 'familyChangeRequest'

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

familyChangeRequestDetail

  • ID is required
  • Exactly 1 instance
  • Attributes
  • No relationships
path Parameters
id
required
number

Number ID of the 'familyChangeRequest' of which detail should be updated. [example: 1]

detailId
required
number

Number ID of the 'familyChangeRequestDetail' to update. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Medical Change Condition

Post Medical Change Condition

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAdd

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isInattentive → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • isHyperactive → Boolean {DESCRIPTION-MISSING} [optional] [example: FALSE]
    • isMedicationRequired → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • isDoctorsLetterProvided → Boolean {DESCRIPTION-MISSING} [example: FALSE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAdd.

medicalChangeConditionAsthma

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String {DESCRIPTION-MISSING} [optional] [example: "mild"] Value constraints: Allowed values: "not stated", "mild", "moderate", "severe", "life threatening"
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isPrescribedSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAsthma.

medicalChangeConditionAllergy

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • allergyName → String Name of the allergy. [optional] [example: "Dust allergy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedAntihistamine → Boolean Has been Prescribed with Antihistamine [example: FALSE]
    • isPrescribedEpiPen → Boolean Has an EpiPen/Anapen Adrenaline Auto-injector been Prescribed [example: FALSE]
    • hasEpiPenRegistered → Boolean Has been registered with EpiClub [example: FALSE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAllergy.

medicalChangeConditionDiabetes

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • hasInsulinInjections → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasInsulinPump → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasGlucagon → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionDiabetes.

medicalChangeConditionDietary

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • dietaryName → String Name of the dietary condition [optional] [default: null] [example: "Lactose Intolerance"]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionDietary.

medicalChangeConditionEpilepsy

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • type → String {DESCRIPTION-MISSING} [optional] [example: "Random epilepsy"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionEpilepsy.

medicalChangeConditionOther

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • name → String Name for the condition. it cannot be any of the built-in custom types (Add, Asthma, Epilepsy, etc). [example: "Chronic sleep deprivation"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionOther.

medicalChangeConditionPhobia

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • phobiaName → String Name of the phobia condition [optional] [default: null] [example: "Lactose Intolerance"]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentCondition → [optional] [single] expected type is medicalConditionPhobia.
Request Body schema: application/vnd.api+json
object or object or object or object or object or object or object or object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Get Medical Change Conditions

Retrieves a page of instances of all the medicalChangeCondition* model.

query Parameters
limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

changeRequestIds
string

String Comma-separated list of changeRequest relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Condition

Removes a single instance of one of the medicalChangeCondition* model.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Medical Change Condition

Retrieves a single instance of one of the medicalChangeCondition* model.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Patch Medical Change Condition

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAdd

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isInattentive → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • isHyperactive → Boolean {DESCRIPTION-MISSING} [optional] [example: FALSE]
    • isMedicationRequired → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • isDoctorsLetterProvided → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships

medicalChangeConditionAsthma

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • severity → String {DESCRIPTION-MISSING} [optional] [example: "mild"] Value constraints: Allowed values: "not stated", "mild", "moderate", "severe", "life threatening"
    • isPrescribedSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • No relationships

medicalChangeConditionAllergy

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • allergyName → String Name of the allergy. [optional] [example: "Dust allergy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedAntihistamine → Boolean Has been Prescribed with Antihistamine [example: FALSE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedEpiPen → Boolean Has an EpiPen/Anapen Adrenaline Auto-injector been Prescribed [example: FALSE]
    • hasEpiPenRegistered → Boolean Has been registered with EpiClub [example: FALSE]
  • No relationships

medicalChangeConditionDiabetes

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • hasInsulinInjections → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasInsulinPump → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasGlucagon → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships

medicalChangeConditionDietary

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • dietaryName → String Name of the dietary condition [optional] [default: null] [example: "Lactose Intolerance"]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships

medicalChangeConditionEpilepsy

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • type → String {DESCRIPTION-MISSING} [optional] [example: "Random epilepsy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships

medicalChangeConditionOther

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • name → String Name for the condition. it cannot be any of the built-in custom types (Add, Asthma, Epilepsy, etc). [example: "Chronic sleep deprivation"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships

medicalChangeConditionPhobia

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • phobiaName → String Name of the phobia condition [optional] [default: null] [example: "Lactose Intolerance"]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Request Body schema: application/vnd.api+json
object or object or object or object or object or object or object or object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Post Medical Change Condition Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Medical Change Condition Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Get Medical Change Condition Doctors Letter File

Returns the doctor's letter file of the condition

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Post Medical Change Condition Doctors Letter File

Attachs a doctor's letter file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'doctorsLetter'.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeCondition*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Medical Change Disability

Post Medical Change Disability

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeDisabilityOther

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • name → String Name of the disability [example: "Hearing Impairment"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional information about the disability [optional] [example: "Uses a hearing aid"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • receivesFunding → Boolean Whether the student receives money for this disability [example: TRUE]
    • isMarkedForDeletion → Boolean If true enrolmentDisability is required, all other attributes are unnecessary and on approval the referenced disability will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentDisability → [optional] [single] expected type is disabilityOther.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Get Medical Change Disabilities

Retrieves a page of instances of all the medicalChangeDisability* model.

query Parameters
limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

changeRequestIds
string

String Comma-separated list of changeRequest relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Disability

Removes a single instance of one of the medicalChangeDisability* model.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeDisability*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Medical Change Disability

Retrieves a single instance of one of the medicalChangeDisability* model.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeDisability*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Patch Medical Change Disability

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeDisabilityOther

  • ID is required
  • Between 0 and 1 instances
  • Attributes
    • name → String Name of the disability [example: "Hearing Impairment"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional information about the disability [optional] [example: "Uses a hearing aid"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • receivesFunding → Boolean Whether the student receives money for this disability [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of the referenced 'medicalChangeDisability*' [example: 17]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Post Medical Change Disability Care Plan File

Attachs a care plan file to a medical change disability submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeDisability*' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Medical Change Disability Care Plan File

Returns the care plan file of the disability

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeDisability*' [example: 17]

Responses

Medical Change Prescribed Medication

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Medical Change Prescribed Medication

Adds a new medicalChangePrescribedMedication to an existing medicalChangeRequest

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangePrescribedMedication

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • name → String Name of the medication [optional] [example: "Ketanol"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • dosage → String Text explanation of the dosage [optional] [example: "Should be given up to one 200mg tablet per day in case of a headache"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • type → String Type of the medication [optional] [example: "Analgesics"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional information about the medication. [optional] [example: ""] Value constraints: Length must be between 65535 and 1 characters, inclusive
    • isPrescribed → Boolean Whether the medication is prescribed or taken without prescription [example: TRUE]
    • isTakenAtSchool → Boolean Whether the medication is taken during school time or outside [optional] [example: TRUE]
    • isLongTerm → Boolean Whether it's a medication that is or will be taken for a long time [optional] [example: FALSE]
    • anticipatedStopDate → Date (Y-m-d, eg. 2019-12-31) A date at which it is expected the student will stop taking the medication [optional] [example: "2019-01-01"]
    • isMarkedForDeletion → Boolean If true enrolmentPrescribedMedication is required, all other attributes are unnecessary and on approval the referenced prescribed medication will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • changeRequest → [required] [single] expected type is medicalChangeRequest.
    • enrolmentPrescribedMedication → [optional] [single] expected type is prescribedMedication.
    • enrolmentCondition → [optional] [single] expected type is medicalCondition.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Prescribed Medications

Retrieves a page of instances of medicalChangePrescribedMedication.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of createdBy relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

changeRequestIds
string

String Comma-separated list of changeRequest relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Prescribed Medication

Removes a single instance of one of the medicalChangePrescribedMedication.

path Parameters
id
required
number

Number ID of 'medicalChangePrescribedMedication' to remove. [example: 1]

Responses

Get Medical Change Prescribed Medication

Retrieves a single instance of medicalChangePrescribedMedication.

path Parameters
id
required
number

Number ID of the 'medicalChangePrescribedMedication' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Prescribed Medication

Update an existing medicalChangePrescribedMedication.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangePrescribedMedication

  • ID is required
  • Exactly 1 instance
  • Attributes
    • name → String Name of the medication [optional] [example: "Ketanol"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • dosage → String Text explanation of the dosage [optional] [example: "Should be given up to one 200mg tablet per day in case of a headache"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • type → String Type of the medication [optional] [example: "Analgesics"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional information about the medication. [optional] [example: ""] Value constraints: Length must be between 65535 and 1 characters, inclusive
    • isPrescribed → Boolean Whether the medication is prescribed or taken without prescription [example: TRUE]
    • isTakenAtSchool → Boolean Whether the medication is taken during school time or outside [optional] [example: TRUE]
    • isLongTerm → Boolean Whether it's a medication that is or will be taken for a long time [optional] [example: FALSE]
    • anticipatedStopDate → Date (Y-m-d, eg. 2019-12-31) A date at which it is expected the student will stop taking the medication [optional] [example: "2019-01-01"]
  • No relationships
path Parameters
id
required
number

Number ID of 'medicalChangePrescribedMedication' to update.

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Medical Change Request

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Medical Change Request

Creates a new future absence

Payload has the following requirements:

  • Expects a non-empty collection.

And supports these models:

medicalChangeRequest

  • Must not have ID
  • Exactly 1 instance
  • No attributes
  • Relationships
    • student → [required] [single] expected type is student.

medicalChangeDoctor

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • type → String Type of the doctor [optional] [example: "other"] Value constraints: Allowed values: "other", "gp", "specialist", "dentist"
    • name → String Name of the doctor. [optional] [example: "Dr John Doe"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • practiceName → String Name of the doctor's practice. [optional] [example: "Doe's Laryngology"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • phone → String Phone to the doctor. [optional] [example: "+48 123-123-123"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • address → String Address of the doctor. [optional] [example: "Doctor Street 73/12, Medicalville"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • consentToContact → Boolean Whether the doctor has given permission to be contacted by school. [example: TRUE]
    • isMarkedForDeletion → Boolean If true affectedDoctor is required, all other attributes are unnecessary and on approval the referenced doctor will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • affectedDoctor → [optional] [single] expected type is doctor. When provided this medical change will modify the affected doctor rather than create a new record.

medicalChangeVaccination

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • name → String Name of the vaccine. [optional] [example: "Placebon"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • dateOfVaccination → Date (Y-m-d, eg. 2019-12-31) Date of the vaccination [optional] [example: "2015-01-01"]
    • comment → String Additional comments about the vaccination. [optional] [example: "Vaccine does nothing, used for a medical trial"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • isMarkedForDeletion → Boolean If true enrolmentVaccination is required, all other attributes are unnecessary and on approval the referenced vaccination will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • enrolmentVaccination → [optional] [single] expected type is vaccination. When provided this medical change will modify the affected vaccination rather than create a new record.

medicalChangeConditionAdd

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isInattentive → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • isHyperactive → Boolean {DESCRIPTION-MISSING} [optional] [example: FALSE]
    • isMedicationRequired → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • isDoctorsLetterProvided → Boolean {DESCRIPTION-MISSING} [example: FALSE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAdd.

medicalChangeConditionAllergy

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • allergyName → String Name of the allergy. [optional] [example: "Dust allergy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedAntihistamine → Boolean Has been Prescribed with Antihistamine [example: FALSE]
    • isPrescribedEpiPen → Boolean Has an EpiPen/Anapen Adrenaline Auto-injector been Prescribed [example: FALSE]
    • hasEpiPenRegistered → Boolean Has been registered with EpiClub [example: FALSE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAllergy.

medicalChangeConditionAsthma

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String {DESCRIPTION-MISSING} [optional] [example: "mild"] Value constraints: Allowed values: "not stated", "mild", "moderate", "severe", "life threatening"
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isPrescribedSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAsthma.

medicalChangeConditionDiabetes

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • hasInsulinInjections → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasInsulinPump → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasGlucagon → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionDiabetes.

medicalChangeConditionEpilepsy

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • type → String {DESCRIPTION-MISSING} [optional] [example: "Random epilepsy"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionEpilepsy.

medicalChangeConditionOther

  • Must not have ID
  • Between 0 and 99 instances
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • name → String Name for the condition. it cannot be any of the built-in custom types (Add, Asthma, Epilepsy, etc). [example: "Chronic sleep deprivation"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionOther.

medicalChangeMisc

  • Must not have ID
  • Between 0 and 1 instances
  • Attributes
    • wasMedicationAdviceFormReceived → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterParacetamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterIbuprofen → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterAntihistamine → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasParentAcknowledged → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasLongTermMedication → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • areVaccinationsUpToDate → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasMeaslesExclusion → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • lastDateOfTetanusInjection → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"] Value constraints: Maximum value: today [inclusive]
    • privateMedicalFundExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • medicareExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • ambulanceCoverProvider → String {DESCRIPTION-MISSING} [optional] [example: "Bupa HI Pty Ltd"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicareNumber → String {DESCRIPTION-MISSING} [optional] [example: "4173158231/1"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicarePositionOnCard → String {DESCRIPTION-MISSING} [optional] [example: "7"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFund → String {DESCRIPTION-MISSING} [optional] [example: "ahm Health Insurance"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFundNumber → String {DESCRIPTION-MISSING} [optional] [example: "1237124691"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • healthCareCardNumber → String {DESCRIPTION-MISSING} [optional] [example: "HCCN001234567890"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • hasAmbulanceCover → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasPrivateHospitalCover → Boolean Does the student have private hospital cover? [optional] [example: TRUE]
  • No relationships
Request Body schema: application/vnd.api+json
object or object or object or object or object or object or object or object or object or object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get Medical Change Requests

Retrieves a page of instances of medicalChangeRequest.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request

Removes unapproved 'medicalChangeCondition' and all of its details

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

Responses

Get Medical Change Request

Retrieves a single instance of medicalChangeRequest.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Vaccination Certificate File

Attachs a certificate file to a medical vaccination submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'certificate'.

path Parameters
id
required
number

Number ID of the referenced 'medicalChangeVaccination' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Post Medical Change Request Condition Add

Adds condition add details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAdd

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isInattentive → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • isHyperactive → Boolean {DESCRIPTION-MISSING} [optional] [example: FALSE]
    • isMedicationRequired → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • isDoctorsLetterProvided → Boolean {DESCRIPTION-MISSING} [example: FALSE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAdd.
path Parameters
id
required
number

Number ID of medical change requests to which a condition ADD should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Add

Retrieves all of medicalChangeConditionAdd related to medicalChangeRequest via relation conditionsAdd.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Add

Removes existing 'medicalChangeConditionAdd' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAdd belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Add

Retrieves a single instances of medicalChangeConditionAdd based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAdd to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change REquest Condition Add

Updates existing medicalChangeConditionAdd details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAdd

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isInattentive → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • isHyperactive → Boolean {DESCRIPTION-MISSING} [optional] [example: FALSE]
    • isMedicationRequired → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • isDoctorsLetterProvided → Boolean {DESCRIPTION-MISSING} [example: FALSE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionAdd should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAdd to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Add Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAdd which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Add Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAdd which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Condition Allergy

Adds condition allergy details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAllergy

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • allergyName → String Name of the allergy. [optional] [example: "Dust allergy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedAntihistamine → Boolean Has been Prescribed with Antihistamine [example: FALSE]
    • isPrescribedEpiPen → Boolean Has an EpiPen/Anapen Adrenaline Auto-injector been Prescribed [example: FALSE]
    • hasEpiPenRegistered → Boolean Has been registered with EpiClub [example: FALSE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAllergy.
path Parameters
id
required
number

Number ID of medical change requests to which a condition ALLERGY should be allergyed. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Allergy

Retrieves all of medicalChangeConditionAllergy related to medicalChangeRequest via relation conditionsAllergy.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Allergy

Removes existing 'medicalChangeConditionAllergy' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAllergy belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Allergy

Retrieves a single instances of medicalChangeConditionAllergy based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAllergy to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Condition

Updates existing medicalChangeConditionAllergy details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAllergy

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • allergyName → String Name of the allergy. [optional] [example: "Dust allergy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedAntihistamine → Boolean Has been Prescribed with Antihistamine [example: FALSE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • isPrescribedEpiPen → Boolean Has an EpiPen/Anapen Adrenaline Auto-injector been Prescribed [example: FALSE]
    • hasEpiPenRegistered → Boolean Has been registered with EpiClub [example: FALSE]
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionAllergy should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAllergy to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Allergy Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAllergy which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Allergy Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAllergy which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Condition Asthma

Asthmas condition asthma details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAsthma

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String {DESCRIPTION-MISSING} [optional] [example: "mild"] Value constraints: Allowed values: "not stated", "mild", "moderate", "severe", "life threatening"
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • isPrescribedSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionAsthma.
path Parameters
id
required
number

Number ID of medical change requests to which a condition ASTHMA should be asthmaed. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Asthma

Retrieves all of medicalChangeConditionAsthma related to medicalChangeRequest via relation conditionsAsthma.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Asthma

Removes existing 'medicalChangeConditionAsthma' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAsthma belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Asthma

Retrieves a single instances of medicalChangeConditionAsthma based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAsthma to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Condition Asthma

Updates existing medicalChangeConditionAsthma details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionAsthma

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • severity → String {DESCRIPTION-MISSING} [optional] [example: "mild"] Value constraints: Allowed values: "not stated", "mild", "moderate", "severe", "life threatening"
    • isPrescribedSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionAsthma should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAsthma to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Asthma Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAsthma which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Asthma Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionAsthma which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Condition Diabetes

Diabetess condition diabetes details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionDiabetes

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • hasInsulinInjections → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasInsulinPump → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasGlucagon → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionDiabetes.
path Parameters
id
required
number

Number ID of medical change requests to which a condition DIABETES should be diabetesed. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Diabetes

Retrieves all of medicalChangeConditionDiabetes related to medicalChangeRequest via relation conditionsDiabetes.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Diabetes

Removes existing 'medicalChangeConditionDiabetes' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionDiabetes belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Diabetes

Retrieves a single instances of medicalChangeConditionDiabetes based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionDiabetes to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Condition Diabetes

Updates existing medicalChangeConditionDiabetes details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionDiabetes

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • hasInsulinInjections → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasInsulinPump → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasGlucagon → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionDiabetes should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionDiabetes to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Diabetes Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionDiabetes which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Diabetes Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionDiabetes which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Condition Epilepsy

Epilepsys condition epilepsy details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionEpilepsy

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • type → String {DESCRIPTION-MISSING} [optional] [example: "Random epilepsy"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionEpilepsy.
path Parameters
id
required
number

Number ID of medical change requests to which a condition EPILEPSY should be epilepsyed. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Epilepsy

Retrieves all of medicalChangeConditionEpilepsy related to medicalChangeRequest via relation conditionsEpilepsy.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Epilepsy

Removes existing 'medicalChangeConditionEpilepsy' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionEpilepsy belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Epilepsy

Retrieves a single instances of medicalChangeConditionEpilepsy based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionEpilepsy to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Condition Epilepsy

Updates existing medicalChangeConditionEpilepsy details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionEpilepsy

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • type → String {DESCRIPTION-MISSING} [optional] [example: "Random epilepsy"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionEpilepsy should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionEpilepsy to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Epilepsy Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionEpilepsy which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Epilepsy Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionEpilepsy which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Condition Other

Others condition other details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionOther

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • isMarkedForDeletion → Boolean If true enrolmentCondition is required, all other attributes are unnecessary and on approval the referenced condition will be deleted. [optional] [default: false] [example: TRUE]
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • name → String Name for the condition. it cannot be any of the built-in custom types (Add, Asthma, Epilepsy, etc). [example: "Chronic sleep deprivation"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • Relationships
    • enrolmentCondition → [optional] [single] expected type is medicalConditionOther.
path Parameters
id
required
number

Number ID of medical change requests to which a condition OTHER should be othered. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Conditions Other

Retrieves all of medicalChangeConditionOther related to medicalChangeRequest via relation conditionsOther.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Condition Other

Removes existing 'medicalChangeConditionOther' details of a yet-unapproved 'medicalChangeRequest'

path Parameters
id
required
number

Number ID of medicalChangeRequest of which condition should be removed. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionOther belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Condition Other

Retrieves a single instances of medicalChangeConditionOther based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionOther to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Condition Other

Updates existing medicalChangeConditionOther details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeConditionOther

  • ID is required
  • Exactly 1 instance
  • Attributes
    • additionalInformation → String Additional information that can be attached to this condition. [optional] [default: ""] [example: "Condition is serious"]
    • details → String Additional detail about the condition [optional] [default: ""] [example: "Lorem ipsum dolor"] Value constraints: Length must be between 65025 and 1 characters, inclusive
    • name → String Name for the condition. it cannot be any of the built-in custom types (Add, Asthma, Epilepsy, etc). [example: "Chronic sleep deprivation"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • severity → String Should be one of the following values: not stated, mild, moderate, severe, life threatening. It'll accept any string but those won't work correctly in the UI. [optional] [example: "mild"] Value constraints: Length must be between 255 and 1 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeConditionOther should be modified. [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionOther to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Condition Other Care Plan File

Attachs a care plan file to a medical condition submission, provided no file was uploaded yet. The file should be uploaded via 'multipart/form-data' and should be sent under key 'carePlan'.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionOther which care plan file to retrieve [example: 1]

Responses

Get Medical Change Request Condition Other Care Plan File

Returns the care plan file of the condition

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

conditionId
required
number

Number ID of the medicalChangeConditionOther which care plan file to retrieve [example: 1]

Responses

Post Medical Change Request Doctor

Adds doctor details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeDoctor

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • type → String Type of the doctor [optional] [example: "other"] Value constraints: Allowed values: "other", "gp", "specialist", "dentist"
    • name → String Name of the doctor. [optional] [example: "Dr John Doe"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • practiceName → String Name of the doctor's practice. [optional] [example: "Doe's Laryngology"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • phone → String Phone to the doctor. [optional] [example: "+48 123-123-123"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • address → String Address of the doctor. [optional] [example: "Doctor Street 73/12, Medicalville"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • consentToContact → Boolean Whether the doctor has given permission to be contacted by school. [example: TRUE]
    • isMarkedForDeletion → Boolean If true affectedDoctor is required, all other attributes are unnecessary and on approval the referenced doctor will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • affectedDoctor → [optional] [single] expected type is doctor. When provided this medical change will modify the affected doctor rather than create a new record.
path Parameters
id
required
number

Number ID of medical change requests to which a doctor should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Doctors

Retrieves all of medicalChangeDoctor related to medicalChangeRequest via relation doctors.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Doctor

Removes an existing doctor details of a yet-unapproved medicalChangeRequest

path Parameters
id
required
number

Number ID of medical change requests of which doctor should be removed. [example: 1]

doctorId
required
number

Number ID of the doctor belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Doctor

Retrieves a single instances of medicalChangeDoctor based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

doctorId
required
number

Number ID of the medicalChangeDoctor to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Doctor

Updates existing medicalChangeDoctor details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeDoctor

  • ID is required
  • Exactly 1 instance
  • Attributes
    • type → String Type of the doctor [optional] [example: "other"] Value constraints: Allowed values: "other", "gp", "specialist", "dentist"
    • name → String Name of the doctor. [optional] [example: "Dr John Doe"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • practiceName → String Name of the doctor's practice. [optional] [example: "Doe's Laryngology"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • phone → String Phone to the doctor. [optional] [example: "+48 123-123-123"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • address → String Address of the doctor. [optional] [example: "Doctor Street 73/12, Medicalville"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • consentToContact → Boolean Whether the doctor has given permission to be contacted by school. [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeDoctor should be modified. [example: 1]

doctorId
required
number

Number ID of the medicalChangeDoctor to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Medical Change Request Misc

Removes an existing miscellaneous details of a yet-unapproved medical change request

path Parameters
id
required
number

Number ID of medical change requests of which miscellanous details should be removed. [example: 1]

Responses

Post Medical Change Request Misc

Adds miscellaneous details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeMisc

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • wasMedicationAdviceFormReceived → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterParacetamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterIbuprofen → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterAntihistamine → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasParentAcknowledged → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasLongTermMedication → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • areVaccinationsUpToDate → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasMeaslesExclusion → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • lastDateOfTetanusInjection → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"] Value constraints: Maximum value: today [inclusive]
    • privateMedicalFundExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • medicareExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • ambulanceCoverProvider → String {DESCRIPTION-MISSING} [optional] [example: "Bupa HI Pty Ltd"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicareNumber → String {DESCRIPTION-MISSING} [optional] [example: "4173158231/1"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicarePositionOnCard → String {DESCRIPTION-MISSING} [optional] [example: "7"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFund → String {DESCRIPTION-MISSING} [optional] [example: "ahm Health Insurance"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFundNumber → String {DESCRIPTION-MISSING} [optional] [example: "1237124691"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • healthCareCardNumber → String {DESCRIPTION-MISSING} [optional] [example: "HCCN001234567890"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • hasAmbulanceCover → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasPrivateHospitalCover → Boolean Does the student have private hospital cover? [optional] [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of medical change requests to which miscellanous details should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Misc

Retrieves a single instance of medicalChangeMisc, the relation misc of medicalChangeRequest.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Misc

Updates existing miscellaneous details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeMisc

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • wasMedicationAdviceFormReceived → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterSalbutamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterParacetamol → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterIbuprofen → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • canOverCounterAntihistamine → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasParentAcknowledged → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasLongTermMedication → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • areVaccinationsUpToDate → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasMeaslesExclusion → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • lastDateOfTetanusInjection → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"] Value constraints: Maximum value: today [inclusive]
    • privateMedicalFundExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • medicareExpiryDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [optional] [example: "2016-01-01"]
    • ambulanceCoverProvider → String {DESCRIPTION-MISSING} [optional] [example: "Bupa HI Pty Ltd"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicareNumber → String {DESCRIPTION-MISSING} [optional] [example: "4173158231/1"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • medicarePositionOnCard → String {DESCRIPTION-MISSING} [optional] [example: "7"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFund → String {DESCRIPTION-MISSING} [optional] [example: "ahm Health Insurance"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • privateMedicalFundNumber → String {DESCRIPTION-MISSING} [optional] [example: "1237124691"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • healthCareCardNumber → String {DESCRIPTION-MISSING} [optional] [example: "HCCN001234567890"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • hasAmbulanceCover → Boolean {DESCRIPTION-MISSING} [optional] [example: TRUE]
    • hasPrivateHospitalCover → Boolean Does the student have private hospital cover? [optional] [example: TRUE]
  • No relationships
path Parameters
id
required
number

Number ID of medical change requests of which miscellanous details should be modified. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Medical Change Request Vaccination

Adds vaccination details to a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeVaccination

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • name → String Name of the vaccine. [optional] [example: "Placebon"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • dateOfVaccination → Date (Y-m-d, eg. 2019-12-31) Date of the vaccination [optional] [example: "2015-01-01"]
    • comment → String Additional comments about the vaccination. [optional] [example: "Vaccine does nothing, used for a medical trial"] Value constraints: Length must be between 65536 and 0 characters, inclusive
    • isMarkedForDeletion → Boolean If true enrolmentVaccination is required, all other attributes are unnecessary and on approval the referenced vaccination will be deleted. [optional] [default: false] [example: TRUE]
  • Relationships
    • enrolmentVaccination → [optional] [single] expected type is vaccination. When provided this medical change will modify the affected vaccination rather than create a new record.
path Parameters
id
required
number

Number ID of medical change requests to which a vaccination should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Medical Change Request Vaccinations

Retrieves all of medicalChangeVaccination related to medicalChangeRequest via relation vaccinations.

path Parameters
id
required
number

Number ID of the 'medicalChangeRequest', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Medical Change Request Vaccination

deleteMedicalChangeRequestVaccination

path Parameters
id
required
number

Number ID of medical change requests of which vaccination should be removed. [example: 1]

vaccinationId
required
number

Number ID of the vaccination belonging to the medicalChangeRequest to be removed. [example: 1]

Responses

Get Medical Change Request Vaccination

Retrieves a single instances of medicalChangeVaccination based on the specified ID.

path Parameters
id
required
number

Number ID of the medicalChangeRequest [example: 1]

vaccinationId
required
number

Number ID of the medicalChangeVaccination to retrieve, must belong to the specific medicalChangeRequest [example: 1]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Medical Change Request Vaccination

Updates existing medicalChangeVaccination details of a yet-unapproved medical change request

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

medicalChangeVaccination

  • ID is required
  • Exactly 1 instance
  • Attributes
    • name → String Name of the vaccine. [optional] [example: "Placebon"] Value constraints: Length must be between 255 and 1 characters, inclusive
    • dateOfVaccination → Date (Y-m-d, eg. 2019-12-31) Date of the vaccination [optional] [example: "2015-01-01"]
    • comment → String Additional comments about the vaccination. [optional] [example: "Vaccine does nothing, used for a medical trial"] Value constraints: Length must be between 65536 and 0 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of medicalChangeRequest of which medicalChangeVaccination should be modified. [example: 1]

vaccinationId
required
number

Number ID of the medicalChangeVaccination to modify, must belong to the specified medicalChangeRequest [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Student Enrolment Draft

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Student Enrolment Draft

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentEnrolmentDraft

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • data → String OR Object Refer to the description of the studentEnrolmentDraft model for information what structure this attribute expects. [example: "See description of studentEnrolmentDraft for actual example JSON"]
  • Relationships
    • createdBy → [optional] [single] expected type is portalUser. The user who should be marked as the creator of the draft.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Enrolment Drafts

Retrieves a page of instances of studentEnrolmentDraft.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

createdByIds
string

String Comma-separated list of createdBy relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Student Enrolment Draft

Removes existing 'studentEnrolmentDraft' provided it is still in SUBMITTED status

path Parameters
id
required
number

Number ID of 'studentEnrolmentDraft' to remove. [example: 1]

Responses

Get Student Enrolment Draft

Retrieves a single instance of studentEnrolmentDraft.

path Parameters
id
required
number

Number ID of the 'studentEnrolmentDraft' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Student Enrolment Draft

Method disabled.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

studentEnrolmentDraft

  • ID is required
  • Exactly 1 instance
  • Attributes
    • data → String OR Object Refer to the description of the studentEnrolmentDraft model for information what structure this attribute expects. [example: "See description of studentEnrolmentDraft for actual example JSON"]
  • No relationships
path Parameters
id
required
number

Number ID of 'studentEnrolmentDraft' to update.

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Student Enrolment Draft Attachment

Adds a new 'studentDocument' to a processed 'studentEnrolmentDraft'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'attachment'.

path Parameters
id
required
number

Number ID of the 'studentEnrolmentDraft' to which the attachment should be added. [example: 1]

query Parameters
isConfidential
boolean

Boolean Controls whether the newly created file should be confidential or not. [optional] [default: false]

studentDocumentCategoryId
number

Number Category to which this document belongs. [optional] [default: Oldest active category ID.]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Enrolment Draft Attachments

Retrieves all of studentDocument related to studentEnrolmentDraft via relation attachments.

path Parameters
id
required
number

Number ID of the 'studentEnrolmentDraft', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Assignment Mark

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A mark on a specific assignment for a specific student.

Post Academic Report Assignment Mark

Marks an assignment for a given student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

academicReportAssignmentMark

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • weight → Number Numeric weight of the mark. Must be one of the values defined in the assignment's scale. [example: 3]
  • Relationships
    • coreStudent → [optional] [single] expected type is coreStudent. Student who is marked.
    • schemaAssignment → [required] [single] expected type is academicReportSchemaAssignment. Schema assignment that is marked. Will fail if the weight provided does not exist in this schema assignment's scale.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Assignment Marks

Retrieves a page of instances of academicReportAssignmentMark.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Assignment Mark

Retrieves a single instance of academicReportAssignmentMark.

path Parameters
id
required
string

String matching regular expression: ^\d+-\d+$ ID of the 'academicReportAssignmentMark' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Class

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Classes

Retrieves a page of instances of academicReportClass.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreClassIds
string

String Comma-separated list of coreClass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreRollclassIds
string

String Comma-separated list of coreRollclass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enrolmentClassIds
string

String Comma-separated list of enrolmentClass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enrolmentRollclassIds
string

String Comma-separated list of enrolmentRollclass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent IDs to filter the classes. Be mindful that if you input multiple student IDs the response will not indicate which classes belong to which student. It's best to either request one student per query, or later map the data by fetching all the relevant cohorts and their students.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

nameSearch
string

String Search for name. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "5A%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Class

Retrieves a single instance of academicReportClass.

path Parameters
id
required
number

Number ID of the 'academicReportClass' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Classes Related Report Cohorts

Retrieves all of academicReportClassCohort related to academicReportClass via relation reportCohorts.

path Parameters
id
required
number

Number ID of the 'academicReportClass', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Class Cohort

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Class Cohorts

Retrieves a page of instances of academicReportClassCohort.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportClassIds
string

String Comma-separated list of reportClass relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportSchemaIds
string

String Comma-separated list of reportSchema relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent IDs to filter the cohorts. Be mindful that if you input multiple student IDs the response will not indicate which cohorts belong to which student. It's best to either request one student per query, or later fetch all students for each cohort returned to do the mapping. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Class Cohort

Retrieves a single instance of academicReportClassCohort.

path Parameters
id
required
number

Number ID of the 'academicReportClassCohort' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Class Cohorts Related Academic Report Assignment Marks

Retrieves a page of academicReportAssignmentMark related to academicReportClassCohort via relation academicReportAssignmentMarks.

path Parameters
id
required
number

Number ID of the 'academicReportClassCohort', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

reportSchemaIds
string

String Comma-separated list of reportSchema relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportSchemaAssignmentIds
string

String Comma-separated list of reportSchemaAssignments relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Class Cohorts Related Core Students

Retrieves a page of coreStudent related to academicReportClassCohort via relation coreStudents.

path Parameters
id
required
number

Number ID of the 'academicReportClassCohort', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Class Cohorts Related Enrolment Students

Retrieves a page of student related to academicReportClassCohort via relation enrolmentStudents.

path Parameters
id
required
number

Number ID of the 'academicReportClassCohort', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Comment Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A school comment type

Get Academic Report Comment Types

Retrieves a page of instances of academicReportCommentType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Comment Type

Retrieves a single instance of academicReportCommentType.

path Parameters
id
required
number

Number ID of the 'academicReportCommentType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Period Comment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

An overall comment for a specific student.

Post Academic Report Period Comment

Sets an overall comment for a given student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

academicReportPeriodComment

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • comment → String The contents of the comment [example: "This is an overall comment for a student"]
  • Relationships
    • reportCommentType → [required] [single] expected type is academicReportCommentType. The comment type this comment applies to. Must be of a type OVERALL
    • reportPeriod → [required] [single] expected type is studentAcademicReportPeriod. The reporting period that this comment applies to
    • coreStudent → [optional] [single] expected type is coreStudent. Student for whom this comment applies to.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Period Comments

Retrieves a page of instances of academicReportPeriodComment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of Report Period IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportCommentTypeIds
string

String Comma-separated list of Comment Type IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of Student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Period Comment

Retrieves a single instance of academicReportPeriodComment.

path Parameters
id
required
number

Number ID of the 'academicReportPeriodComment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Scale

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Scales

Retrieves a page of instances of academicReportScale.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportGrades. [optional] [default: null] [example: "reportGrades"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Scale

Retrieves a single instance of academicReportScale.

path Parameters
id
required
number

Number ID of the 'academicReportScale' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportGrades. [optional] [default: null] [example: "reportGrades"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Scales Related Report Grades

Retrieves all of academicReportScaleGrade related to academicReportScale via relation reportScales.

path Parameters
id
required
number

Number ID of the 'academicReportScale', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Scale Grade

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A single grade in a scale available in a reporting period

Get Academic Report Scale Grades

Retrieves a page of instances of academicReportScaleGrade.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportScaleIds
string

String Comma-separated list of reportScale relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Scale Grade

Retrieves a single instance of academicReportScaleGrade.

path Parameters
id
required
number

Number ID of the 'academicReportScaleGrade' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Schema

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Schemas

Retrieves a page of instances of academicReportSchema.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportCommentTypes. [optional] [default: null] [example: "reportCommentTypes"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Schema

Retrieves a single instance of academicReportSchema.

path Parameters
id
required
number

Number ID of the 'academicReportSchema' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportCommentTypes. [optional] [default: null] [example: "reportCommentTypes"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Schema Related Comment Types

Retrieves all of academicReportCommentType related to academicReportSchema via relation reportSchemas.

path Parameters
id
required
number

Number ID of the 'academicReportSchema', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Schema Assignment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Schema Assignments

Retrieves a page of instances of academicReportSchemaAssignment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportCommentTypes. [optional] [default: null] [example: "reportCommentTypes"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportSchemaIds
string

String Comma-separated list of reportSchema relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportSubjectIds
string

String Comma-separated list of reportSubject relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportStrandIds
string

String Comma-separated list of reportStrand relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportCohortIds
string

String Comma-separated list of academicReportClassCohort IDs to filter the schema assignments. Be mindful that if you input multiple IDs the response will not indicate which schema assignments belong to which cohort. It's best to either filter by one cohort per query, or later map the data together by pulling relevant schemas and cohorts.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Schema Assignment

Retrieves a single instance of academicReportSchemaAssignment.

path Parameters
id
required
number

Number ID of the 'academicReportSchemaAssignment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportCommentTypes. [optional] [default: null] [example: "reportCommentTypes"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Schema Assignment Related Comment Types

Retrieves all of academicReportCommentType related to academicReportSchemaAssignment via relation reportSchemas.

path Parameters
id
required
number

Number ID of the 'academicReportSchemaAssignment', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Academic Report Schema Assignment Comment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A schema assignment comment for a specific student.

Post Academic Report Schema Assignment Comment

Sets a schema assignment comment for a given student.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

academicReportSchemaAssignmentComment

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • comment → String The contents of the comment [example: "This is an overall comment for a student"]
  • Relationships
    • reportCommentType → [required] [single] expected type is academicReportCommentType. The comment type this comment applies to. Must be of a type OVERALL
    • schemaAssignment → [required] [single] expected type is academicReportSchemaAssignment. The schema assignment that this comment applies to
    • coreStudent → [optional] [single] expected type is coreStudent. Student for whom this comment applies to.
    • author → [optional] [single] expected type is administrativeUser. The author of the comment.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Schema Assignment Comments

Retrieves a page of instances of academicReportSchemaAssignmentComment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of Report Period IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

schemaAssignmentIds
string

String Comma-separated list of Schema Assignment IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportCommentTypeIds
string

String Comma-separated list of Comment Type IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of Student IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Schema Assignment Comment

Retrieves a single instance of academicReportSchemaAssignmentComment.

path Parameters
id
required
number

Number ID of the 'academicReportSchemaAssignmentComment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Strand

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A grading strand available in a reporting period

Get Academic Report Strands

Retrieves a page of instances of academicReportStrand.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportSubjectIds
string

String Comma-separated list of reportSubject relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Strand

Retrieves a single instance of academicReportStrand.

path Parameters
id
required
number

Number ID of the 'academicReportStrand' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Academic Report Subject

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Academic Report Subjects

Retrieves a page of instances of academicReportSubject.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

reportPeriodIds
string

String Comma-separated list of reportPeriod relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

names
string

String Comma-separated list of name values by which to look up. [optional] [default: null] [example: "English,Mathematics"] Value constraints: Length must be between 1024 and 0 characters, inclusive

shortNames
string

String Comma-separated list of shortName values by which to look up. [optional] [default: null] [example: "EAL/D,Science"] Value constraints: Length must be between 1024 and 0 characters, inclusive

codes
string

String Comma-separated list of code values by which to look up. [optional] [default: null] [example: "HPE,HASS,SCI,English"] Value constraints: Length must be between 1024 and 0 characters, inclusive

shortNameSearch
string

String Search for shortName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Engl%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

codeSearch
string

String Search for code. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "H%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Academic Report Subject

Retrieves a single instance of academicReportSubject.

path Parameters
id
required
number

Number ID of the 'academicReportSubject' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Academic Report Subject Related Schema Assignments

Retrieves a page of academicReportSchemaAssignment related to academicReportSubject via relation schemaAssignments.

path Parameters
id
required
number

Number ID of the 'academicReportSubject', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportCommentTypes. [optional] [default: null] [example: "reportCommentTypes"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Student Academic Report

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Academic Reports Edu Pro

Retrieves a page of instances of studentAcademicReportEduPro.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report Edu Pro

Retrieves a single instance of studentAcademicReportEduPro.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportEduPro' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Academic Report Edu Pro File

Returns the actual file of the given EduPro student academic report

path Parameters
id
required
number

Number ID of the studentAcademicReportEduPro which file to retrieve

Responses

Get Student Academic Reports

Retrieves a page of instances of studentAcademicReport.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentIds
string

String Comma-separated list of student relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

years
string

String Comma-separated list of years to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

semesters
string

String Comma-separated list of semesters to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

periods
string

String Comma-separated list of periods to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report

Retrieves a single instance of studentAcademicReport.

path Parameters
id
required
number

Number ID of the 'studentAcademicReport' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Academic Report File

Returns the actual file of the given student academic report

path Parameters
id
required
number

Number ID of the studentAcademicReport which file to retrieve

Responses

Student Academic Report Period

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Student Academic Report Periods

Retrieves a page of instances of studentAcademicReportPeriod.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Together with toDate these two filter designate a date range, and only periods that cover that range at least partially will be returned. In other words, it'll only return periods which date range collides with the date range specified by these filters. If you provide only one of the filters it'll treat the other as if it was infinitely in the past/future. [optional] [default: null] [example: "2020-01-01"]

toDate
string

Date (Y-m-d, eg. 2019-12-31) See description of fromDate [optional] [default: null] [example: "2020-02-02"]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report Period

Retrieves a single instance of studentAcademicReportPeriod.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportPeriod' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Academic Report Period Related Classes

Retrieves a page of academicReportClass related to studentAcademicReportPeriod via relation scales.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportPeriod', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report Period Related Scales

Retrieves a page of academicReportScale related to studentAcademicReportPeriod via relation scales.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportPeriod', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: reportGrades. [optional] [default: null] [example: "reportGrades"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Academic Report Period Related Subjects

Retrieves a page of academicReportSubject related to studentAcademicReportPeriod via relation scales.

path Parameters
id
required
number

Number ID of the 'studentAcademicReportPeriod', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

names
string

String Comma-separated list of name values by which to look up. [optional] [default: null] [example: "English,Mathematics"] Value constraints: Length must be between 1024 and 0 characters, inclusive

shortNames
string

String Comma-separated list of shortName values by which to look up. [optional] [default: null] [example: "EAL/D,Science"] Value constraints: Length must be between 1024 and 0 characters, inclusive

codes
string

String Comma-separated list of code values by which to look up. [optional] [default: null] [example: "HPE,HASS,SCI,English"] Value constraints: Length must be between 1024 and 0 characters, inclusive

shortNameSearch
string

String Search for shortName. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "Engl%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

codeSearch
string

String Search for code. By default it looks for an exact match, but special characters _ and % can be used to look for, respectively, any single character or zero or more characters. For example, Test_ will match Test1, TestB but not Test or TestLong, while Test% will match all of the above. These special characters can be escaped by prepending them with a backslach \. [optional] [default: null] [example: "H%"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restapi Exception Log

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

An event that was raised but not yet queued to be sent as a message to listeners.

Get Restapi Exception Logs

Retrieves a page of instances of restapiExceptionLog.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

path
string

String path to filter by [optional] [example: "/v1/enrolments/student?offset=212"] Value constraints: Length must be between 255 and 0 characters, inclusive

from
string

DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) Datetime from which to return exceptions. [optional] [example: "2018-01-01 00:01:02"] Value constraints: Length must be between 1024 and 0 characters, inclusive

to
string

DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) Datetime to which to return exceptions. [optional] [example: "2018-12-01 23:40:32"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Restapi Exception Log

Retrieves a single instance of restapiExceptionLog.

path Parameters
id
required
number

Number ID of the 'restapiExceptionLog' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deprovision Tenant

Delete Deprovision Tenant

deprovisions the specified tenant

path Parameters
id
required
number

Number ID of the tenant that should be deprovisioned. [example: 1]

Responses

Key Info

Get Key Information

Retrieves information about the passed Tenant ID and API Key as well as the user who owns the API key.

Responses

Ping

Ping

Responds with no content and header 204 No Content.

Responses

Provision Tenants

Post Provision Tenants

Allows provisioning of new tenants in an organisation. Provisioning process itself is performed via a queue.

Responses

Revoke Key

Revoke Key

Revokes the API key thats currently in use

Responses

Schema

Get Schema

Retrieves the schema of this API.

query Parameters
excludeTags
boolean

Boolean When true the schema will not include tags information for the endpoints [optional] [default: "0"] [example: "1"]

actionNamespaces
string

String Comma-separated list of action namespaces to filter by. Matching is case-insensitive. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

operationIds
string

String Comma-separated list of operation IDs to filter by. Search is case insensitive and supports one-character wildcard '?' and multi-character wildcard '*'. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

modelNames
string

String Comma-separated list of model names to filter by. Search is case insensitive and supports one-character wildcard '?' and multi-character wildcard '*'. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Get Schema Action Summary

Retrieves the names and descriptions of every action exposed in the API, grouped by namespace.

Responses

Get Schema Model Summary

Retrieves the names and descriptions of every model exposed in the API, grouped by namespace.

Responses

Get Schema Namespaces

Retrieves the list of all namespaces

Responses

Status

Get Status

Retrieves the status of the server.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Absence

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Post Absence

Creates a new absence

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

absence

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • date → Date (Y-m-d, eg. 2019-12-31) Date of the absence [example: "2018-08-01"]
    • type → String Type of the absence [example: "whole"] Value constraints: Allowed values: "whole", "early", "timed", "late"
    • start → Time (H:i:s, eg 23:59:59) Start time of the absence. [optional] [example: "8:00"]
    • end → Time (H:i:s, eg 23:59:59) End time of the absence [optional] [example: "15:00"]
    • comment → String Comment for the absence [optional] [example: "Doctor appointment"]
  • Relationships
    • reason → [optional] [single] expected type is absenceReason.
    • coreStudent → [required] [single] expected type is coreStudent.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Absences

Retrieves a page of instances of absence.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 366 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

studentId
string

String Comma-separated list of enrolmentStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

year
string

String Comma-separated list of years from which absences to return (matches the year of the date attribute). [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

dates
string

String Comma-separated list of date values to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Absence

Removes existing 'absence'.

path Parameters
id
required
number

Number ID of the referenced 'absence' [example: 17]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Get Absence

Retrieves a single instance of absence.

path Parameters
id
required
number

Number ID of the 'absence' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Absence Relationship To Response

Removes a link between an 'absence' and 'incomingMessage' which form a response to former from a guardian.

path Parameters
id
required
number

Number ID of 'absence' of which response should be removed. [example: 1]

messageId
required
number

Number ID of the 'incomingMessage' belonging to the 'absence' to which link should be removed. [example: 1]

Responses

Post Absence Response

Adds a response to an absence by creating a new outgoing message in the system and linking it through to the absence.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

incomingMessage

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • message → String The message that was sent that contains the explanation for absence. [example: ""] Value constraints: Length must be at most 1 characters, inclusive
    • type → String Type of the message delivery mechanism. [example: "sms"] Value constraints: Allowed values: "sms", "email", "phone", "letter", "portal"
    • isUnsolicited → Boolean Whether the message was unsolicited. [example: FALSE]
  • No relationships
path Parameters
id
required
number

Number ID of the absence to which a new response should be added. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Absence Responses

Retrieves all of incomingMessage related to absence via relation responses.

path Parameters
id
required
number

Number ID of the 'absence', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post Staff Absence

Creates a new staff absence.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staffAbsence

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • type → String {DESCRIPTION-MISSING} [example: "whole"] Value constraints: Allowed values: "whole", "early", "late", "timed"
    • startDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [example: "2018-01-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) {DESCRIPTION-MISSING} [example: "2018-01-02"]
    • startTime → Time (H:i:s, eg 23:59:59) {DESCRIPTION-MISSING} [optional] [default: null] [example: "08:15:00"]
    • endTime → Time (H:i:s, eg 23:59:59) {DESCRIPTION-MISSING} [optional] [default: null] [example: "16:30:00"]
    • reason → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "Struck down by flu"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "Pending confirmation from a doctor"] Value constraints: Length must be between 65025 and 0 characters, inclusive
    • hasReceivedMedicalCertificate → Boolean {DESCRIPTION-MISSING} [optional] [default: false] [example: FALSE]
    • externalSource → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "PAPER-RECORDS"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • externalId → String {DESCRIPTION-MISSING} [optional] [default: null] [example: "P/73/112"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • Relationships
    • staff → [required] [single] expected type is staff.
    • leaveType → [required] [single] expected type is staffAbsenceLeaveType.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Absences

Retrieves a page of instances of staffAbsence.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Absence

Retrieves a single instance of staffAbsence.

path Parameters
id
required
number

Number ID of the 'staffAbsence' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Staff Absence Attachment

Adds a new 'staffAbsenceAttachment' to a 'staffAbsence'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'attachment'.

path Parameters
id
required
number

Number ID of the 'staffAbsence' to which the attachment should be added. [example: 1]

query Parameters
uploaderId
required
number

Number ID of the administrativeUser who uploaded the file, corresponds to relation uploader in the resulting model. [example: "13"]

displayName
required
string

String Displayed name of the file. [example: "Learning plan"] Value constraints: Length must be between 100 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Absence Related Attachments

Retrieves a page of staffAbsenceAttachment related to staffAbsence via relation attachments.

path Parameters
id
required
number

Number ID of the 'staffAbsence', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Staff Absence Attachment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Staff Absence Attachments

Retrieves a page of instances of staffAbsenceAttachment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of leaveType IDs. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

absenceIds
string

String Comma-separated list of absence IDs. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

uploaderIds
string

String Comma-separated list of uploader IDs. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Absence Attachment

Retrieves a single instance of staffAbsenceAttachment.

path Parameters
id
required
number

Number ID of the 'staffAbsenceAttachment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Absence Attachment File

Returns the actual file of the given `staffAbsenceAttachment

path Parameters
id
required
number

Number ID of the staffAbsenceAttachment which file to retrieve [example: "1"]

Responses

Staff Absence Leave Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Information about staff absence on a specific day.

Get Staff Absence Leave Types

Retrieves a page of instances of staffAbsenceLeaveType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of leaveType IDs. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Absence Leave Type

Retrieves a single instance of staffAbsenceLeaveType.

path Parameters
id
required
number

Number ID of the 'staffAbsenceLeaveType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Staff

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A definition of a class in a timetable.

Post Staff

Creates a new staff record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staff

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • staffCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • timetableCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • barcode → String {DESCRIPTION-MISSING} [optional] [example: "ABC-abc-1234"]
    • emergencyContactName → String Deprecated, no longer used. Name of the person who should be contacted in case of an emergency. [optional] [example: "John Smith"]
    • emergencyContactPhone → String Deprecated, no longer used. Phone number of the person who should be contacted in case of an emergency. [optional] [example: "+61 7 7010 4537"]
    • emergencyContactMobile → String Deprecated, no longer used. Mobile Phone number of the person who should be contacted in case of an emergency. [optional] [example: "0491 570 156"]
    • employmentStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment status of the staff member [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment classification of the staff member [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Staff member's job title [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract was started [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract will end [optional] [example: "2024-12-31"]
    • wWCCNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: "2028-09-22"]
    • aGSNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: NULL]
  • Relationships
    • person → [required] [single] expected type is person. Person record for whom the staff record relates to.
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staffs

Retrieves a page of instances of staff.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

barcodes
string

String Comma-separated list of barcodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffCodes
string

String Comma-separated list of staffCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

refIds
string

String Comma-separated list of refIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

contactCodes
string

String Comma-separated list of contactCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of externalIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Staff

Deletes staff by ID

path Parameters
id
required
number

Number ID of the staff to delete. [example: 1]

Responses

Get Staff

Retrieves a single instance of staff.

path Parameters
id
required
number

Number ID of the 'staff' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: person, qualifications, employments. [optional] [default: null] [example: "person"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Staff

Updates an existing staff record

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

staff

  • ID is required
  • Exactly 1 instance
  • Attributes
    • staffCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • timetableCode → String {DESCRIPTION-MISSING} [optional] [example: "2UMMO"]
    • barcode → String {DESCRIPTION-MISSING} [optional] [example: "ABC-abc-1234"]
    • emergencyContactName → String Deprecated, no longer used. Name of the person who should be contacted in case of an emergency. [optional] [example: "John Smith"]
    • emergencyContactPhone → String Deprecated, no longer used. Phone number of the person who should be contacted in case of an emergency. [optional] [example: "+61 7 7010 4537"]
    • emergencyContactMobile → String Deprecated, no longer used. Mobile Phone number of the person who should be contacted in case of an emergency. [optional] [example: "0491 570 156"]
    • employmentStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment status of the staff member [optional] [example: "permanent"] Value constraints: Allowed values: "casual", "future", "left", "long_service_leave", "parental_leave", "pending", "permanent", "permanent_part_time", "temporary_full_time", "temporary_part_time", "volunteer", "contractor"
    • employmentClassification → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Employment classification of the staff member [optional] [example: "teaching"] Value constraints: Allowed values: "teaching", "non_teaching"
    • jobTitle → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Staff member's job title [optional] [example: "Biology Teacher"]
    • contractCommencementDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract was started [optional] [example: "2019-01-01"]
    • contractExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when the staff's contract will end [optional] [example: "2024-12-31"]
    • wWCCNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance number. [optional] [example: "WWC0000000E"]
    • wWCCStatus → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance status. [optional] [example: NULL]
    • wWCCExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Working With Children Check clearance expiry date. [optional] [example: "2024-01-01"]
    • codeOfConductDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Code of Conduct was signed. [optional] [example: "2019-02-14"]
    • socialNetworkingPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Social Networking Policy was signed. [optional] [example: "2019-03-02"]
    • childProtectionPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Child Protection Policy was signed. [optional] [example: "2019-04-30"]
    • iCTPolicyDateSigned → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when ICT Policy was signed. [optional] [example: "2019-05-22"]
    • firstAidExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when First Aid certificate expires. [optional] [example: "2023-07-05"]
    • resuscitationExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. Date when Resiscitate certificate expires. [optional] [example: "2025-08-17"]
    • publicLiabilityExpiryDate → Date (Y-m-d, eg. 2019-12-31) Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: "2028-09-22"]
    • aGSNumber → String Deprecated, patch the relevant staffEmployment model instead; using this attribute will attempt to update the best matching staffEmployment model or will do nothing. [optional] [example: NULL]
  • No relationships
path Parameters
id
required
number

Number ID of the staff that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Staff Absences

Retrieves a page of staffAbsence related to staff via relation absences.

path Parameters
id
required
number

Number ID of the 'staff', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Person

Retrieves a single instance of person, the relation relatedPerson of staff.

path Parameters
id
required
number

Number ID of the 'staff' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Staff Photo

Returns the photo of a given staff. Allowed dimensions are: 50x50, 100x100, 250x250, 500x500. If provided dimensions don't match it'll return the next closest dimension available.

path Parameters
id
required
string

String ID of the staff whose photo to retrieve. Also supports externalId for backwards compatibility.

query Parameters
width
number

Number Width of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

height
number

Number Height of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

Responses

Get Staff Related Qualifications

Retrieves all of staffQualification related to staff via relation qualifications.

path Parameters
id
required
number

Number ID of the 'staff', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Timetable Lessons

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the staff which timetable should be retrieved for a given date.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to retrieve timetable lessons, inclusive range. When not specified it defaults to today. [optional] [default: Today]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to retrieve timetable lessons, inclusive range. When not specified it uses fromDate. Max allowed number of days to fetch data is 31. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Staff Timetable Lessons Legacy

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the staff which timetable should be retrieved for a given date.

date
required
string

Date (Y-m-d, eg. 2019-12-31) Date for which the timetable should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Student

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A definition of a class in a timetable.

Get Students

Retrieves a page of instances of student.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

tenant
string

String Only return students who belong to the specified tenant. [optional] [default: ""] [example: "aSd2rs"] Value constraints: Length must be between 256 and 0 characters, inclusive

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

studentCodes
string

String Comma-separated list of studentCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

examNumbers
string

String Comma-separated list of examNumbers to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

refIds
string

String Comma-separated list of refIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

contactCodes
string

String Comma-separated list of contactCodes to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

externalIds
string

String Comma-separated list of externalIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

academicPeriodIds
string

String Comma-separated list of academicPeriodIds to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student

Retrieves a single instance of student.

path Parameters
id
required
number

Number ID of the 'student' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryEnrolment, person, activities, activityInstances, tenants, flags, flagLinks, contacts, holidays, specialNeedsPrograms, schoolHistory. [optional] [default: null] [example: "primaryEnrolment"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Student

Updates an existing student

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

student

  • ID is required
  • Exactly 1 instance
  • Attributes
    • permissionToPhotograph → Boolean This field cannot be modified once it's not null. [example: TRUE]
    • usiId → String Updates the unique user identifier. [optional] [example: "c8370653bf584bd7644ccb2ba1f39e78"]
    • barcode → String Updates the barcode field. [optional] [example: "B000012680"]
    • examNumber → String Updates the examNumber field. [optional] [example: "Value123"]
    • studentCode → String Updates the studentCode field. [optional] [example: "40045"]
    • systemStudentId → String Updates the systemStudentId field. [optional] [example: "Value123"]
    • acaraId → Number Updates the acaraId field. [optional] [example: "Value234"]
    • username → String Updates the username field. [optional] [example: "john.smith"]
  • No relationships
path Parameters
id
required
number

Number ID of the student that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Absences

Retrieves a page of absence related to student via relation absences.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Related Academic Reports

Retrieves a page of studentAcademicReport related to student via relation academicReports.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: period. [optional] [default: null] [example: "period"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Activities

Retrieves a page of activity related to student via relation activities.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: venue. [optional] [default: null] [example: "venue"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Return only activities that end after this date. [optional] [default: null]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Return only activities that start before this date. [optional] [default: null]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Awards

Retrieves a page of award related to student via relation awards.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post Student Data Sync

Synchronizes a student into Sentra Data layer of used tenant - but only if the tenant uses Sentralenrolment importer.

path Parameters
id
required
number

Number ID of the student who should be synced with the Sentral Data layer. [example: 1]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Student Related Student Document

Adds a new 'studentDocument' to a 'studentEnrolmentDraft'. The file should be uploaded via 'multipart/form-data' and should be sent under key 'document'.

path Parameters
id
required
number

Number ID of the 'STUDENT' to which the document should be added. [example: 1]

query Parameters
isConfidential
boolean

Boolean Controls whether the newly created file should be confidential or not. [optional] [default: false]

studentEnrolmentDraftId
number

Number ID of the studentEnrolmentDraft to which this document should be additionally attached. The draft must be related through student relation to the student to which the document is added. [optional] [example: 1]

categoryId
number

Number ID of the category relation to which this document should belong. [optional] [example: 1]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Student Documents

Retrieves all of studentDocument related to student via relation documents.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Related Edu Pro Academic Reports

Retrieves a page of studentAcademicReportEduPro related to student via relation eduProAcademicReports.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Enrolments

Retrieves all of enrolment related to student via relation enrolments.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

statuses
string

String Comma-separated list of enrolment types to filter by. Reference the model enrolment for the list of all supported types.. [optional] [default: active,active_pending,active_leaving] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Flags

Retrieves all of flag related to student via relation flags. Results will include inactive flags.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: school. [optional] [default: null] [example: "school"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Household Relations

Retrieves all of studentHouseholdRelation related to student via relation households.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, household. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

residentialHouseholdTypes
string

String Comma-separated list of Residential household types to filter by. Reference the model HouseholdStudentRelations for the list of all supported types.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Person

Retrieves a single instances of person based on the specified ID.

path Parameters
id
required
number

Number ID of the student whose person details should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: primaryHousehold, studentPrimaryEnrolment, staff, student, contactDetails, otherHouseholds, studentContacts, studentTenants, prescribedMedication, emails, phoneNumbers, givenConsents, givenConsentLinks, emergencyContactLinks, abilities, additionalFields. [optional] [default: null] [example: "primaryHousehold"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Photo

Returns the photo of a given student. Allowed dimensions are: 50x50, 100x100, 250x250, 500x500. If provided dimensions don't match it'll return the next closest dimension available.

path Parameters
id
required
string

String ID of the student whose photo to retrieve. Also supports externalId for backwards compatibility.

query Parameters
width
number

Number Width of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

height
number

Number Height of the returned photo, must be between 1 and 1500, defaults to 256. If not one of the allowed dimensions it will select the next closest available option. [optional] [default: 256] Value constraints: Minimum value: 1 [inclusive] Maximum value: 1500 [inclusive]

avoidReturningMissingPhoto
string

String By default this method returns the photo of the student in the current tenant, even if the student has no custom photo there. With this option set to '1', if the student doesn't have a photo in the current tenant the endpoint will attempt to return a photo from another tenant this student is/was part of and return the photo from there. The mechanism will prefer the tenant where the student is currently enrolled, then earliest past tenants, then earlies future tenants. [optional] [default: "0"] Value constraints: Allowed values: "1", "0"

Responses

Get Student Primary Enrolment

Retrieves a single instance of enrolment, the relation primaryEnrolment of student.

path Parameters
id
required
number

Number ID of the 'student' which relation to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: student, house, rollclass, classes, campus. [optional] [default: null] [example: "student"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Student Special Needs Programs

Retrieves all of specialNeedsProgram related to student via relation specialNeedsPrograms.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: students. [optional] [default: null] [example: "students"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Tenants

Retrieves all of tenant related to student via relation tenants.

path Parameters
id
required
number

Number ID of the 'student', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: schools. [optional] [default: null] [example: "schools"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Timetable Lessons

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the student which timetable should be retrieved for a given date.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to retrieve timetable lessons, inclusive range. When not specified it defaults to today. [optional] [default: Today]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to retrieve timetable lessons, inclusive range. When not specified it uses fromDate. Max allowed number of days to fetch data is 31. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Student Timetable Lessons Legacy

Retrieves all instances of timetableLesson.

path Parameters
id
required
number

Number ID of the student which timetable should be retrieved for a given date.

date
required
string

Date (Y-m-d, eg. 2019-12-31) Date for which the timetable should be retrieved.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timetable Calendar Date

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Information about a specific date in timetable.

Get Timetable Calendar Dates

Retrieves a page of instances of timetableCalendarDate.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

from
string

Date (Y-m-d, eg. 2019-12-31) Date from which to return calendar dates. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

to
string

Date (Y-m-d, eg. 2019-12-31) Date to which to return calendar dates. [optional] [example: "2018-12-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Calendar Date

Retrieves a single instance of timetableCalendarDate.

path Parameters
id
required
string

Date (Y-m-d, eg. 2019-12-31) ID of the 'timetableCalendarDate' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Class

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Timetable Classes

Retrieves a page of instances of timetableClass.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: timetableStudents. [optional] [default: null] [example: "timetableStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent IDs that are assigned to this class to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enrolmentStudentIds
string

String Comma-separated list of student IDs that are assigned to this class to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

subjectIds
string

String Comma-separated list of subject relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Class

Retrieves a single instance of timetableClass.

path Parameters
id
required
number

Number ID of the 'timetableClass' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: timetableStudents. [optional] [default: null] [example: "timetableStudents"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Timetable Class Related Timetable Students

Retrieves a page of timetableStudent related to timetableClass via relation timetableStudents.

path Parameters
id
required
number

Number ID of the 'timetableClass', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timetable Class Lesson

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "links": {
    },
  • "relationships": {
    }
}

Get Timetable Class Lessons

Retrieves a page of instances of timetableClassLesson.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: class, room, periodInDay, timetableTeachers. [optional] [default: null] [example: "class"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

roomIds
string

String Comma-separated list of room relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

periodInDayIds
string

String Comma-separated list of periodInDay relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

classIds
string

String Comma-separated list of class relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Class Lesson

Retrieves a single instance of timetableClassLesson.

path Parameters
id
required
number

Number ID of the 'timetableClassLesson' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: class, room, periodInDay, timetableTeachers. [optional] [default: null] [example: "class"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Timetable Class Lesson Related Core Staff

Retrieves a page of coreStaff related to timetableClassLesson via relation coreStaff.

path Parameters
id
required
number

Number ID of the 'timetableClassLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedClasses. [optional] [default: null] [example: "assignedClasses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Class Lesson Related Core Students

Retrieves a page of coreStudent related to timetableClassLesson via relation coreStudents.

path Parameters
id
required
number

Number ID of the 'timetableClassLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Class Lesson Related Timetable Students

Retrieves a page of timetableStudent related to timetableClassLesson via relation timetableStudents.

path Parameters
id
required
number

Number ID of the 'timetableClassLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Class Lesson Related Timetable Teachers

Retrieves a page of timetableTeacher related to timetableClassLesson via relation timetableTeachers.

path Parameters
id
required
number

Number ID of the 'timetableClassLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timetable Daily Lesson

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Timetable Daily Lessons

Retrieves a page of instances of timetableDailyLesson.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: class, periodInDay, room, timetableTeachers. [optional] [default: null] [example: "class"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

periodIds
string

String Comma-separated list of period relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

classIds
string

String Comma-separated list of class relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

from
string

Date (Y-m-d, eg. 2019-12-31) Date from which to return changes (inclusive). [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

to
string

Date (Y-m-d, eg. 2019-12-31) Date to which to return changes (inclusive). [optional] [example: "2018-12-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Daily Lesson

Retrieves a single instance of timetableDailyLesson.

path Parameters
id
required
number

Number ID of the 'timetableDailyLesson' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: class, periodInDay, room, timetableTeachers. [optional] [default: null] [example: "class"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Timetable Daily Lesson Related Core Staff

Retrieves a page of coreStaff related to timetableDailyLesson via relation coreStaff.

path Parameters
id
required
number

Number ID of the 'timetableDailyLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: assignedClasses. [optional] [default: null] [example: "assignedClasses"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Daily Lesson Related Core Students

Retrieves a page of coreStudent related to timetableDailyLesson via relation coreStudents.

path Parameters
id
required
number

Number ID of the 'timetableDailyLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: additionalDetails, coreRollclass, attendedClasses, holidays, studentRelationships, coreHouse, contacts. [optional] [default: null] [example: "additionalDetails"] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Daily Lesson Related Timetable Students

Retrieves a page of timetableStudent related to timetableDailyLesson via relation timetableStudents.

path Parameters
id
required
number

Number ID of the 'timetableDailyLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Daily Lesson Related Timetable Teachers

Retrieves a page of timetableTeacher related to timetableDailyLesson via relation timetableTeachers.

path Parameters
id
required
number

Number ID of the 'timetableDailyLesson', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timetable Day

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A timetable day of a week.

Get Timetable Days

Retrieves a page of instances of timetableDay.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Day

Retrieves a single instance of timetableDay.

path Parameters
id
required
number

Number ID of the 'timetableDay' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Lesson

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "relationships": {
    }
}

A definition of a class in a timetable.

Get Timetable Lessons

Retrieves all instances of timetableLesson. This is very computationally intensive endpoint, use it sparingly and cache the results. The value of (studentIds.length + staffIds.length + classIds.length) * days must be at most 500, to avoid fetching too many data points at once.

query Parameters
studentIds
string

String Comma-separated list of student IDs to filter by.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

staffIds
string

String Comma-separated list of staff IDs to filter by.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

classIds
string

String Comma-separated list of timetableClass IDs to filter by.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

fromDate
string

Date (Y-m-d, eg. 2019-12-31) Date from which to retrieve timetable lessons, inclusive range. When not specified it defaults to today. [optional] [default: Today]

toDate
string

Date (Y-m-d, eg. 2019-12-31) Date to which to retrieve timetable lessons, inclusive range. When not specified it uses fromDate. [optional]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Timetable Period

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A timetable period in a day.

Get Timetable Periods

Retrieves a page of instances of timetablePeriod.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Period

Retrieves a single instance of timetablePeriod.

path Parameters
id
required
number

Number ID of the 'timetablePeriod' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Period In Day

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A link between a period and a day.

Get Timetable Period In Days

Retrieves a page of instances of timetablePeriodInDay.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

dayIds
string

String Comma-separated list of day relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

periodIds
string

String Comma-separated list of period relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Period In Day

Retrieves a single instance of timetablePeriodInDay.

path Parameters
id
required
number

Number ID of the 'timetablePeriodInDay' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Room

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A physical room in which a `timetableLesson` can occur.

Get Timetable Rooms

Retrieves a page of instances of timetableRoom.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Room

Retrieves a single instance of timetableRoom.

path Parameters
id
required
number

Number ID of the 'timetableRoom' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Student

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A student model used by the timeview module. These students are traditionally sourced from a system different from where `student` and `coreStudent`. As such, there may be discrepancy between some details.

Get Timetable Students

Retrieves a page of instances of timetableStudent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

coreStudentIds
string

String Comma-separated list of coreStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enrolmentStudentIds
string

String Comma-separated list of enrolmentStudent linked through coreStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Student

Retrieves a single instance of timetableStudent.

path Parameters
id
required
number

Number ID of the 'timetableStudent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timetable Subject

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A school subject; a group of knowledge taught.

Get Timetable Subjects

Retrieves a page of instances of timetableSubject.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Timetable Subject

Retrieves a single instance of timetableSubject.

path Parameters
id
required
number

Number ID of the 'timetableSubject' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Webcal Calendar

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A system calendar.

Post Webcal Calendar

Creates a new webcalCalendar

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendar

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • calendarName → String Name of the calendar [example: "John Doe's Calendar"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • externalSource → String External source of this row [optional] [example: "Google Calendar"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • Relationships
    • owner → [required] [single] expected type is coreAdministrativeUser. User who owns the calendar
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Webcal Calendars

Retrieves a page of instances of webcalCalendar.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

ownerIds
string

String Comma-separated list of owner relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Webcal Calendar

Deletes webcalCalendar by ID

path Parameters
id
required
number

Number ID of the webcalCalendar to delete. [example: 1]

Responses

Get Webcal Calendar

Retrieves a single instance of webcalCalendar.

path Parameters
id
required
number

Number ID of the 'webcalCalendar' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Webcal Calendar

Updates an existing webcalCalendar

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendar

  • ID is required
  • Exactly 1 instance
  • Attributes
    • calendarName → String Name of the calendar [example: "John Doe's Calendar"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • externalSource → String External source of this row [optional] [example: "Google Calendar"] Value constraints: Length must be between 255 and 0 characters, inclusive
  • No relationships
path Parameters
id
required
number

Number ID of the webcalCalendar that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Webcal Calendar Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

An event inside a system calendar.

Post Webcal Calendar Event

Creates a new webcalCalendarEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendarEvent

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • title → String Title of the event [example: "Pizza Meeting"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String Notes about the meeting (agenda, plan, requirements, etc) [optional] [example: "Remember to bring your pizza sauces!"] Value constraints: Length must be between 65535 and 0 characters, inclusive
    • link → String Link that contains more information or the online meetup [optional] [example: "https://zoom.us/test"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • date → Date (Y-m-d, eg. 2019-12-31) date of the event [example: "2020-02-01"]
    • startTime → Time (H:i:s, eg 23:59:59) Time when the event starts [optional] [example: "14:00:00"]
    • endTime → Time (H:i:s, eg 23:59:59) Time when the event ends [optional] [example: "15:30:00"]
    • category → String One of the categories as defined in the calendar to which the event is added. It will happily accept other values, as there is no validation. [optional] [example: "Tasks"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • otherDates → Array of <Date (Y-m-d, eg. 2019-12-31)> An array of additional dates when the event should occur. When modifying an existing event, if you provide this attribute it WILL REMOVE the old otherDates and REPLACE all of them with [optional] [example: ["2020-02-01"]]
  • Relationships
    • calendar → [required] [single] expected type is webcalCalendar. Calendar to which the event will be added
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Webcal Calendar Events

Retrieves a page of instances of webcalCalendarEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

calendarIds
string

String Comma-separated list of calendar relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

dates
string

String Comma-separated list of dates to filter by. Checks both date and otherDates.. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Webcal Calendar Event

Deletes webcalCalendarEvent by ID

path Parameters
id
required
number

Number ID of the webcalCalendarEvent to delete. [example: 1]

Responses

Get Webcal Calendar Event

Retrieves a single instance of webcalCalendarEvent.

path Parameters
id
required
number

Number ID of the 'webcalCalendarEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Webcal Calendar Event

Updates an existing webcalCalendarEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendarEvent

  • ID is required
  • Exactly 1 instance
  • Attributes
    • title → String Title of the event [example: "Pizza Meeting"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String Notes about the meeting (agenda, plan, requirements, etc) [optional] [example: "Remember to bring your pizza sauces!"] Value constraints: Length must be between 65535 and 0 characters, inclusive
    • link → String Link that contains more information or the online meetup [optional] [example: "https://zoom.us/test"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • date → Date (Y-m-d, eg. 2019-12-31) date of the event [example: "2020-02-01"]
    • startTime → Time (H:i:s, eg 23:59:59) Time when the event starts [optional] [example: "14:00:00"]
    • endTime → Time (H:i:s, eg 23:59:59) Time when the event ends [optional] [example: "15:30:00"]
    • category → String One of the categories as defined in the calendar to which the event is added. It will happily accept other values, as there is no validation. [optional] [example: "Tasks"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • otherDates → Array of <Date (Y-m-d, eg. 2019-12-31)> An array of additional dates when the event should occur. When modifying an existing event, if you provide this attribute it WILL REMOVE the old otherDates and REPLACE all of them with [optional] [example: ["2020-02-01"]]
  • No relationships
path Parameters
id
required
number

Number ID of the webcalCalendarEvent that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Webcal Calendar Recurring Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

A recurring event inside a system calendar. Below is a reference for all the types of recurrence and what field values to expect: * Daily - `recurrence`, `recurrenceMonth`, `recurrenceMonthDay` and `recurrenceWeekDay` are all NULL, * Weekly - `recurrence`=`week`, `recurrenceWeekDay`=Day of the week (1=Monday, 7=Sunday), `recurrenceMonth` and `recurrenceMonthDay` are all NULL * Fortnightly - `recurrence`=`fortnight_even` or `fortnight_odd`, `recurrenceWeekDay`=Day of the week (1=Monday, 7=Sunday), `recurrenceMonth` and `recurrenceMonthDay` are all NULL. Even/Odd determine the parity of the week in a year. So 1st, 3rd, 5th, etc week of a year will be `fortnight_odd` and 2nd, 4th, 6th, etc will be `fortnight_even`. * Monthly (given day) - `recurrence`=NULL, `recurrenceMonthDay`=Day of the month (1-indexed), `recurrenceMonth` and `recurrenceWeekDay` are NULL. * Monthly (Nth weekday) - `recurrence`=`day1`-`day5`, `recurrenceWeekDay`=Day of the week (1=Monday, 7=Sunday), `recurrenceMonth` and `recurrenceMonthDay` are NULL. `day1` to `day4` refer to Nth week of a month, while `day5` refers to the last week of a month. * Yearly (given day) - `recurrence`=NULL, `recurrenceMonthDay`=Day of the week (1=Monday, 7=Sunday), `recurrenceMonth`=Month of the year, `recurrenceWeekDay` is NULL. * Yearly (Nth weekday of a month) - `recurrence`=`day1`-`day5`, `recurrenceWeekDay`=Day of the week (1=Monday, 7=Sunday), `recurrenceMonth`=Month of the year, `recurrenceMonthDay` is NULL. `day1` to `day4` refer to Nth week of a month, while `day5` refers to the last week of a month.

Post Webcal Calendar Recurring Event

Creates a new webcalCalendarRecurringEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendarRecurringEvent

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • title → String Title of the event [example: "Pizza Meeting"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String Notes about the meeting (agenda, plan, requirements, etc) [optional] [example: "Remember to bring your pizza sauces!"] Value constraints: Length must be between 65535 and 0 characters, inclusive
    • link → String Link that contains more information or the online meetup [optional] [example: "https://zoom.us/test"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • startDate → Date (Y-m-d, eg. 2019-12-31) Date which signifies the start of the range during which the occurences happen [example: "2020-02-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) Date which signifies the end of the range during which the occurences happen [example: "2020-02-01"]
    • startTime → Time (H:i:s, eg 23:59:59) Time when the event starts [optional] [example: "14:00:00"]
    • endTime → Time (H:i:s, eg 23:59:59) Time when the event ends [optional] [example: "15:30:00"]
    • category → String One of the categories as defined in the calendar to which the event is added. It will happily accept other values, as there is no validation. [optional] [example: "Tasks"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • recurrence → String Type of the event recurrence. The details are explained in the description of webcalCalendarRecurringEvent attributes. [optional] [example: "fortnight_even"] Value constraints: Allowed values: "day1", "day2", "day3", "day4", "day5", "week", "fortnight_even", "fortnight_odd", null
    • recurrenceMonthDay → Number When recurrence is null, this can be either null to make the event recur daily, or a number between 1 and 31 (inclusive) to to have the event recur once a month, on the provided day of the month. For other values of recurrence it MUST be null. [optional] [example: NULL] Value constraints: Minimum value: 1 [inclusive] Maximum value: 31 [inclusive]
    • recurrenceWeekDay → Number When recurrence is not null, this indicates the day of the week on which the repetition happens. 1=Monday, 7=Sunday. [optional] [example: "3"] Value constraints: Minimum value: 1 [inclusive] Maximum value: 7 [inclusive]
  • Relationships
    • calendar → [required] [single] expected type is webcalCalendar. Calendar to which the event will be added
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Webcal Calendar Recurring Events

Retrieves a page of instances of webcalCalendarRecurringEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

calendarIds
string

String Comma-separated list of calendar realtion IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Webcal Calendar Recurring Event

Deletes webcalCalendarRecurringEvent by ID

path Parameters
id
required
number

Number ID of the webcalCalendarRecurringEvent to delete. [example: 1]

Responses

Get Webcal Calendar Recurring Event

Retrieves a single instance of webcalCalendarRecurringEvent.

path Parameters
id
required
number

Number ID of the 'webcalCalendarRecurringEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch Webcal Calendar Recurring Event

Updates an existing webcalCalendarRecurringEvent

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webcalCalendarRecurringEvent

  • ID is required
  • Exactly 1 instance
  • Attributes
    • title → String Title of the event [example: "Pizza Meeting"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • notes → String Notes about the meeting (agenda, plan, requirements, etc) [optional] [example: "Remember to bring your pizza sauces!"] Value constraints: Length must be between 65535 and 0 characters, inclusive
    • link → String Link that contains more information or the online meetup [optional] [example: "https://zoom.us/test"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • startDate → Date (Y-m-d, eg. 2019-12-31) Date which signifies the start of the range during which the occurences happen [example: "2020-02-01"]
    • endDate → Date (Y-m-d, eg. 2019-12-31) Date which signifies the end of the range during which the occurences happen [example: "2020-02-01"]
    • startTime → Time (H:i:s, eg 23:59:59) Time when the event starts [optional] [example: "14:00:00"]
    • endTime → Time (H:i:s, eg 23:59:59) Time when the event ends [optional] [example: "15:30:00"]
    • category → String One of the categories as defined in the calendar to which the event is added. It will happily accept other values, as there is no validation. [optional] [example: "Tasks"] Value constraints: Length must be between 255 and 0 characters, inclusive
    • recurrence → String Type of the event recurrence. The details are explained in the description of webcalCalendarRecurringEvent attributes. [optional] [example: "fortnight_even"] Value constraints: Allowed values: "day1", "day2", "day3", "day4", "day5", "week", "fortnight_even", "fortnight_odd", null
    • recurrenceMonthDay → Number When recurrence is null, this can be either null to make the event recur daily, or a number between 1 and 31 (inclusive) to to have the event recur once a month, on the provided day of the month. For other values of recurrence it MUST be null. [optional] [example: NULL] Value constraints: Minimum value: 1 [inclusive] Maximum value: 31 [inclusive]
    • recurrenceWeekDay → Number When recurrence is not null, this indicates the day of the week on which the repetition happens. 1=Monday, 7=Sunday. [optional] [example: "3"] Value constraints: Minimum value: 1 [inclusive] Maximum value: 7 [inclusive]
  • No relationships
path Parameters
id
required
number

Number ID of the webcalCalendarRecurringEvent that should be updated. [example: 1]

Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Event

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

An event that was raised but not yet queued to be sent as a message to listeners.

Get Webhook Events

Retrieves a page of instances of webhookEvent.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

models
string

String Comma-separated list of Models to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

createdAtFrom
string

DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) Any events that have a created datetime occuring on or after the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

createdAtTo
string

DateTime (Y-m-d H:i:s, eg. 2019-12-31 23:59:59) Any events that have a created datetime occuring on or before the specified date. [optional] [example: "2018-01-01"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Webhook Event

Retrieves a single instance of webhookEvent.

path Parameters
id
required
number

Number ID of the 'webhookEvent' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Listener

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Post Webhook Listener

Registers a new endpoint to receive push notifications from Sentral. The following models are currently supported: activity, attendeeLink, ability, personAbilityLink, person, doctor, emergencyContactLink, medicalConditionAdd, medicalConditionAllergy, medicalConditionAsthma, medicalConditionDiabetes, medicalConditionEpilepsy, medicalConditionOther, prescribedMedication, vaccination, household, householdAddress, student, enrolment, familyChangeRequest, familyChangeRequestDetail, medicalChangeConditionAdd, medicalChangeConditionAllergy, medicalChangeConditionAsthma, medicalChangeConditionDiabetes, medicalChangeConditionEpilepsy, medicalChangeConditionOther, medicalChangeVaccination, medicalChangeDoctor, medicalChangeMisc, medicalChangeRequest, studentEnrolmentDraft, studentSelection, timetableDailyLesson, absence, consent, personConsentLink, activityInstance, activityResponse The following operation are supported: created, updated, deleted The push notification contains the data sent in JSON API format, with the payload being an array of resources of type 'webhookOperation', where the ID is unique for each event and there are three attributes:

  • op, the type of operation that was done on the model
  • model, the name of the model/resource as defined in schema
  • modelId, ID of the affected model/resource At the moment the push notifications are not signed.

Payload has the following requirements:

  • Expects a single resource.

And supports these models:

webhookListener

  • Must not have ID
  • Exactly 1 instance
  • Attributes
    • name → String Name for the webhook listener [example: "Client endpoint"] Value constraints: Length must be between 256 and 1 characters, inclusive
    • endpoint → String URL to which the push notifications will be sent [example: "https://example.com/sentral/webhook-push"] Value constraints: Must be a valid URL Length must be between 1024 and 1 characters, inclusive
    • secretKey → String Secret key used for signing push messages. [example: "d70a7c4e58e51901d9c7f5fed2d597c6"] Value constraints: Length must be between 256 and 32 characters, inclusive
    • models → Array of Models that the listener will trigger for, an empty list will trigger for all models. [optional] [example: ["activity","absence"]]
    • operations → Array of Operations that the listener will trigger for, an empty list will trigger for all operations. [optional] [example: ["created","updated","deleted"]]
  • No relationships
Request Body schema: application/vnd.api+json
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Webhook Listeners

Retrieves a page of instances of webhookListener.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

endpoints
string

String Comma-separated list of endpoints to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: 1] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete Webhook Listener

Removes existing 'webhookListener'.

path Parameters
id
required
number

Number ID of the webhookListener that should be deleted. [example: 1]

Responses

Get Webhook Listener

Retrieves a single instance of webhookListener.

path Parameters
id
required
number

Number ID of the 'webhookListener' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Webhook Listener Send Test

Sends a test request to the listener with fake data. Send md5() of the secret key of the tested listener as the body of the POST request to validate.

path Parameters
id
required
number

Number ID of the 'webhookListener' to test [example: 17]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pending Message

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A webhook message that is pending sending

Get Webhook Pending Messages

Retrieves a page of instances of webhookPendingMessage.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Webhook Pending Message

Retrieves a single instance of webhookPendingMessage.

path Parameters
id
required
number

Number ID of the 'webhookPendingMessage' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Award

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Award.

Get Awards

Retrieves a page of instances of award.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Award

Retrieves a single instance of award.

path Parameters
id
required
number

Number ID of the 'award' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Award Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category of an award.

Get Award Categories

Retrieves a page of instances of awardCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Award Category

Retrieves a single instance of awardCategory.

path Parameters
id
required
number

Number ID of the 'awardCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detention

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A past or future detention of a student.

Get Detentions

Retrieves a page of instances of detention.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Detention

Retrieves a single instance of detention.

path Parameters
id
required
number

Number ID of the 'detention' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detention Period

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Period during which a detention happened.

Get Detention Periods

Retrieves a page of instances of detentionPeriod.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Detention Period

Retrieves a single instance of detentionPeriod.

path Parameters
id
required
number

Number ID of the 'detentionPeriod' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Detention Status

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Status of a detention indicating the completion.

Get Detention Statuses

Retrieves a page of instances of detentionStatus.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Detention Status

Retrieves a single instance of detentionStatus.

path Parameters
id
required
number

Number ID of the 'detentionStatus' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Incident

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

A wellbeing incident that has occured in the past.

Get Incidents

Retrieves a page of instances of incident.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Incident

Retrieves a single instance of incident.

path Parameters
id
required
number

Number ID of the 'incident' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Incident Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category of an incident's type, defines certain common properties for incident type.

Get Incident Categories

Retrieves a page of instances of incidentCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Incident Category

Retrieves a single instance of incidentCategory.

path Parameters
id
required
number

Number ID of the 'incidentCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Incident Type

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Incident Types

Retrieves a page of instances of incidentType.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Incident Type

Retrieves a single instance of incidentType.

path Parameters
id
required
number

Number ID of the 'incidentType' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Wellbeing Note

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Get Wellbeing Notes

Retrieves a page of instances of wellbeingNote.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

enrolmentStudentIds
string

String Comma-separated list of enrolmentStudent relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Wellbeing Note

Retrieves a single instance of wellbeingNote.

path Parameters
id
required
number

Number ID of the 'wellbeingNote' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Wellbeing Note Related Attachments

Retrieves a page of wellbeingNoteAttachment related to wellbeingNote via relation attachments.

path Parameters
id
required
number

Number ID of the 'wellbeingNote', which related models will be retrieved. [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Wellbeing Note Attachment

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

object

List of relations

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    },
  • "relationships": {
    }
}

Attachment to a wellbeing note

Get Wellbeing Note Attachments

Retrieves a page of instances of wellbeingNoteAttachment.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

noteIds
string

String Comma-separated list of note relation IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Wellbeing Note Attachment

Retrieves a single instance of wellbeingNoteAttachment.

path Parameters
id
required
number

Number ID of the 'wellbeingNoteAttachment' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Wellbeing Note Category

type
string

Type of the model, the same as the one in the documentation.

id
string

Unique identifier.

object

Attributes of the model

object

Links to related models

{
  • "type": "string",
  • "id": "string",
  • "attributes": {
    },
  • "links": {
    }
}

Category of a wellbeing note.

Get Wellbeing Note Categories

Retrieves a page of instances of wellbeingNoteCategory.

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

limit
number

Number The number of models to return in a single request, value must be between 1-{maxLimit}. [optional] [default: 10] Value constraints: Minimum value: 1 [inclusive] Maximum value: 200 [inclusive]

offset
number

Number Offset by which to return the models from the database, must be larger or equal 0. [optional] [default: 0] Value constraints: Minimum value: 0 [inclusive]

ids
string

String Comma-separated list of IDs to filter by. [optional] [default: null] [example: "1,13,42"] Value constraints: Length must be between 1024 and 0 characters, inclusive

includeInactive
boolean

Boolean If true inactive (soft deleted) models will be included in the results. [optional] [default: false] [example: TRUE]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Wellbeing Note Category

Retrieves a single instance of wellbeingNoteCategory.

path Parameters
id
required
number

Number ID of the 'wellbeingNoteCategory' to retrieve [example: 17]

query Parameters
include
string

String Comma-separated list of relations to sideload. Allowed values are: None.. [optional] [default: null] [example: "None."] Value constraints: Length must be between 1024 and 0 characters, inclusive

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}