School Configuration

GET 
/school/config

Fetches school configuration data including school details and structure. This will provide a picture of how a school is set-up with regards to things like campuses, year levels, houses, and other key school details.

Request

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
id uuidnullablerequired
tenantId uuidrequired
schoolSystemCode stringnullablerequired
enrolmentSchemeStartDate date-timenullablerequired
governmentLocationIdentifier numbernullablerequired
Australian Government Education ID number
governmentSchoolCode stringnullablerequired
createdId uuidnullablerequired
createdDateTime date-timenullablerequired
modifiedId uuidnullablerequired
modifiedDateTime date-timenullablerequired
schoolType objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
readOnly booleanrequired
archived booleanrequired
originalCode stringnullablerequired
createdId uuidrequired
modifiedId uuidnullablerequired
createdDateTime date-timerequired
modifiedDateTime date-timenullablerequired
schoolName stringrequired
addressDetails objectnullablerequired
addLine1 stringnullablerequired
addLine2 stringnullablerequired
addLine3 stringnullablerequired
suburb stringnullablerequired
postCode stringnullablerequired
state objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
country objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
campuses object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
headOfCampusName stringnullablerequired
headOfCampusId uuidnullablerequired
locationAGEID numbernullablerequired
Australian Government Education ID number
createdDateTime date-timerequired
modifiedDateTime date-timerequired
]
subSchools object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
]
yearLevels object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
subSchoolId uuidnullablerequired
subSchoolCode stringnullablerequired
yearsToGraduation numbernullablerequired
]
houses object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
forms object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
tutorGroups object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
rollGroups object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
homeRooms object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
personId uuidnullablerequired
UUID of the person in charge of this group"
personName stringnullablerequired
Name of the linked person
createdDateTime stringrequired
modifiedDateTime stringnullablerequired
campus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
academicYears object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
startDateTime stringnullablerequired
endDateTime stringnullablerequired
createdDateTime stringrequired
modifiedDateTime stringrequired
]
academicPeriods object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
enrolmentYear objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
defaultAcademicPeriod booleanrequired
startDateTime date-timerequired
endDateTime date-timerequired
createdDateTime date-timerequired
modifiedDateTime date-timenullablerequired
]
departments object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
sortOrder int32required
active booleanrequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "schoolSystemCode": "string",
    "enrolmentSchemeStartDate": "2025-03-12T03:31:59.256Z",
    "governmentLocationIdentifier": 0,
    "governmentSchoolCode": "string",
    "createdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdDateTime": "2025-03-12T03:31:59.256Z",
    "modifiedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "modifiedDateTime": "2025-03-12T03:31:59.256Z",
    "schoolType": {
      "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
      "description": "Junior School",
      "code": "JS",
      "sortOrder": 1,
      "active": true
    },
    "schoolName": "string",
    "addressDetails": {
      "addLine1": "123 Queen Street",
      "addLine2": "Apt 4B",
      "addLine3": "Central Business District",
      "suburb": "Auckland",
      "postCode": "1010",
      "state": {
        "id": "c94056f4-c249-4c2c-9c7e-d68a30b8cee4",
        "code": "test",
        "description": "test"
      },
      "country": {
        "id": "385df538-66fc-45b9-860c-65f01314abef",
        "code": "NZ",
        "description": "New Zealand"
      }
    },
    "campuses": [
      true
    ],
    "subSchools": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "yearLevels": [
      true
    ],
    "houses": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "forms": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "tutorGroups": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "rollGroups": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "homeRooms": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "academicYears": [
      true
    ],
    "academicPeriods": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ],
    "departments": [
      {
        "id": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
        "description": "Junior School",
        "code": "JS",
        "sortOrder": 1,
        "active": true
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "id": "2a9b139d-9b3f-40cc-8c25-f09249fece32",
    "tenantId": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
    "createdId": "f6e60d4b-2c3b-4c61-bf98-f4c67bcd2f57",
    "createdDateTime": "2021-10-05T05:22:05.623+00:00",
    "modifiedId": null,
    "modifiedDateTime": "2022-04-27T05:10:37.418+00:00",
    "schoolSystemCode": "KPS",
    "enrolmentSchemeStartDate": "2021-10-30T05:22:36.360+00:00",
    "governmentLocationIdentifier": null,
    "governmentSchoolCode": "1000",
    "lookupSchoolTypeId": "04e75088-a0f3-4204-88a4-0b49be537ce8",
    "schoolType": {
      "id": "04e75088-a0f3-4204-88a4-0b49be537ce8",
      "createdId": "f2b10c12-c4ae-4b0b-8576-bfd382d3f9b4",
      "modifiedId": null,
      "tenantId": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
      "createdDateTime": "2021-10-05T04:59:07.899+00:00",
      "modifiedDateTime": "2021-10-05T04:59:07.899+00:00",
      "code": "01",
      "description": "QA",
      "sortOrder": 0,
      "active": true,
      "readOnly": false,
      "archived": false,
      "originalCode": null
    },
    "addressDetails": {
      "addLine1": "007",
      "addLine2": "ss",
      "addLine3": "testaaa",
      "suburb": "test",
      "postCode": "3000",
      "countryId": null,
      "country": {
        "id": "385df538-66fc-45b9-860c-65f01314abef",
        "code": "NZ",
        "description": "New Zealand",
        "sortOrder": 0,
        "active": true
      },
      "stateId": null,
      "state": {
        "id": "c94056f4-c249-4c2c-9c7e-d68a30b8cee4",
        "code": "test",
        "description": "test",
        "sortOrder": 0,
        "active": true
      }
    },
    "campuses": [
      {
        "id": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "code": "BE_CAMP1",
        "description": "BE Campus 1 Edit",
        "sortOrder": 0,
        "active": true,
        "value": "BE Campus 1 Edit",
        "title": "BE Campus 1 Edit",
        "createdDateTime": "2022-07-19T21:19:06.007Z",
        "modifiedDateTime": "2022-08-31T06:16:05.650Z",
        "headOfCampusName": null,
        "headOfCampusId": null,
        "locationAGEID": null
      }
    ],
    "subSchools": [
      {
        "id": "1c6a1b3a-7ebe-404d-91df-52e3cbeb95d3",
        "code": "SUBSCHOOL11",
        "description": "Sub school 11",
        "sortOrder": 0,
        "active": false
      }
    ],
    "yearLevels": [
      {
        "id": "3c99e96e-9d26-4b43-8c5e-ee0d8f44c60d",
        "code": "BY7",
        "campusCode": "BE_CAMP1",
        "campusId": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "campus": "BE Campus 1 Edit",
        "description": "BE Year Level 7 Edit",
        "sortOrder": 0,
        "active": false,
        "createdDateTime": "2022-07-19T23:14:29.547Z",
        "modifiedDateTime": "2022-09-05T05:54:04.037Z",
        "personName": null,
        "personId": null,
        "subSchoolId": null,
        "subSchoolCode": null,
        "yearsToGraduation": null
      }
    ],
    "houses": [
      {
        "id": "504bca8f-e2f1-4260-9757-314ace4f9b5f",
        "code": "BH1",
        "campusCode": "BE_CAMP1",
        "campusId": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "campus": "BE Campus 1 Edit",
        "description": "BE House 1",
        "sortOrder": 0,
        "active": false,
        "createdDateTime": "2022-07-19T23:15:18.117Z",
        "modifiedDateTime": "2022-07-20T05:26:25.180Z",
        "personName": null,
        "personId": null
      }
    ],
    "forms": [
      {
        "id": "267a2c07-2b3f-47d4-8a96-ac9023b71718",
        "code": "S25",
        "campusCode": "S",
        "campusId": "e1171570-c533-4dd9-ab5a-a8489886fdaf",
        "campus": "Senior",
        "description": "S25",
        "sortOrder": -1,
        "active": true,
        "createdDateTime": "2021-09-17T01:23:04.512Z",
        "modifiedDateTime": "2023-09-11T00:50:28.240Z",
        "personName": null,
        "personId": null
      }
    ],
    "tutorGroups": [
      {
        "id": "62f3cd5c-a7e4-43d3-b322-d51f59ac6805",
        "code": "BTG1",
        "campusCode": "BE_CAMP1",
        "campusId": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "campus": "BE Campus 1 Edit",
        "description": "BE Tutor Group 1",
        "sortOrder": 0,
        "active": false,
        "createdDateTime": "2022-07-19T23:20:34.499Z",
        "modifiedDateTime": "2022-07-20T05:26:40.945Z",
        "personName": null,
        "personId": null
      }
    ],
    "rollGroups": [
      {
        "id": "33326a40-a33e-4868-82f3-6f45a360bcc9",
        "code": "BRG1",
        "campusCode": "BE_CAMP1",
        "campusId": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "campus": "BE Campus 1 Edit",
        "description": "BE Roll Group 1",
        "sortOrder": 0,
        "active": false,
        "createdDateTime": "2022-07-19T23:21:22.845Z",
        "modifiedDateTime": "2023-05-04T01:02:47.061Z",
        "personName": "Krillin",
        "personId": "3583b3c2-09a1-400e-b78f-3b5cf479f43c"
      }
    ],
    "homeRooms": [
      {
        "id": "9e9d8970-9ff0-458e-8791-a636465c51d3",
        "code": "BHR1",
        "campusCode": "BE_CAMP1",
        "campusId": "496dee75-b347-4bf9-b4cf-137d7abbd259",
        "campus": "BE Campus 1 Edit",
        "description": "BE Home room 1",
        "sortOrder": 0,
        "active": false,
        "createdDateTime": "2022-07-19T23:23:17.408Z",
        "modifiedDateTime": "2023-05-04T01:03:38.005Z",
        "personName": "Ms Wendy Judy BURTON",
        "personId": "1b32ae98-abb0-4c36-ba67-259941b62cd3"
      }
    ],
    "academicYears": [
      {
        "id": "48ca0b27-bb19-44bc-a7cc-db1094e2998c",
        "code": "2020",
        "description": "Year 2020",
        "sortOrder": 0,
        "active": true,
        "createdDateTime": "2020-09-10T05:56:47.765Z",
        "modifiedDateTime": "2021-01-03T22:55:21.121Z",
        "startDateTime": "2020-01-01T00:00:00.000Z",
        "endDateTime": "2020-12-31T00:00:00.000Z"
      }
    ],
    "academicPeriods": [
      {
        "sortOrder": 0,
        "active": true,
        "id": "60158d89-506e-4574-baed-b4e413ee7423",
        "description": "QA",
        "code": "1",
        "createdDateTime": "2021-02-09T12:40:34.727Z",
        "modifiedDateTime": "2021-03-09T22:09:48.323Z",
        "defaultAcademicPeriod": false
      }
    ],
    "departments": [
      {
        "id": "bc7b70db-c338-490d-ad82-58ddec309b53",
        "code": "NEWDEP",
        "description": "NEWDEP",
        "sortOrder": -5,
        "active": true,
        "value": "NEWDEP",
        "title": "NEWDEP",
        "totalRecordCount": 4
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...