Student Legal Information

GET 
/students/:id/legal

Fetches a student's relevant legal information such as court orders and custody notes.

Request

Path Parameters

id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data objectnullable
id uuidnullablerequired
parentsSeparated booleanrequired
parentsSeparatedDetails stringnullablerequired
deceasedParent booleanrequired
deceasedParentDetails stringnullablerequired
privacyPolicy booleanrequired
parentalArrangement object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
]
courtOrders CourtOrder[]required
Array [
id uuidrequired
courtOrderStart daterequired
courtOrderEnd datenullablerequired
courtOrderDetails stringnullablerequired
courtOrderType objectnullablerequired
id stringnullablerequired
description stringnullablerequired
]
parentalNotes object[]required
Array [
id uuid
start date
end datenullable
description string
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentsSeparated": true,
    "parentsSeparatedDetails": "string",
    "deceasedParent": true,
    "deceasedParentDetails": "string",
    "privacyPolicy": true,
    "parentalArrangement": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string"
      }
    ],
    "courtOrders": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "courtOrderStart": "2025-03-12",
        "courtOrderEnd": "2025-03-12",
        "courtOrderDetails": "string",
        "courtOrderType": {
          "id": "string",
          "description": "string"
        }
      }
    ],
    "parentalNotes": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "start": "2025-03-12",
        "end": "2025-03-12",
        "description": "string"
      }
    ]
  }
}

successful

{
  "id": "caf1850a-4e1d-4fdd-b1f5-a024c74667fd",
  "parentsSeparated": false,
  "parentsSeparatedDetails": "Parents are legally separated",
  "deceasedParent": false,
  "deceasedParentDetails": null,
  "privacyPolicy": false,
  "parentalArrangement": [
    {
      "id": "b9d48792-d984-48c5-a526-e2168df837a0",
      "description": "Custody",
      "code": "CUSTODY"
    }
  ],
  "courtOrders": [
    {
      "id": "2d16348c-bd63-4386-a891-dbbc11a9a9c1",
      "courtOrderStart": "2020-10-20",
      "courtOrderEnd": null,
      "courtOrderDetails": null,
      "courtOrderType": {
        "id": "cc2eaf01-d930-4b2b-9fe4-41cc4b52a563",
        "description": "Custody Order"
      }
    }
  ],
  "parentalNotes": [
    {
      "id": "9fc63159-6290-4899-af0c-9a9f82d40aa1",
      "start": "2020-10-20",
      "end": null,
      "description": "test"
    }
  ]
}

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