Class Manager
GET /v1/students/birthdays

List Birthdays Student

Query parameters

  • fromDate string Required

    Start date for birthday range

  • toDate string Required

    End date for birthday range

Responses

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • familyId string Required

      Family ID

    • firstname string Required

      Firstname

    • lastname string Required

      Lastname

    • gender string | null Required

      Values are male, female, non-binary, prefer-not-to-say, or other.

    • dateOfBirth string(date) | null Required

      Date of birth

    • mediaConsent boolean Required

      Photo & Video Consent

    • medicalInfo string | null Required

      Medical Info

    • profilePicture string | null Required

      Profile Picture

    • discountable boolean Required

      Discountable

    • joinedAt string(date) | null Required

      Join date

    • deletedAt string(date-time) | null Required

      Deleted at date

    • archivedAt string(date-time) | null Required

      Archived at date

    • createdAt string(date-time) Required

      Created at date
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/students/birthdays 
curl \
 --request GET 'https://localhost/v1/students/birthdays?fromDate=string&toDate=string'
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
[
  {
    "id": "stn_123123123123",
    "companyId": "co_123123123123",
    "familyId": "fml_123123123123",
    "firstname": "John",
    "lastname": "Doe",
    "gender": "male",
    "dateOfBirth": "2010-12-05",
    "mediaConsent": "Not enabled",
    "medicalInfo": "Medical Info",
    "profilePicture": "https://",
    "discountable": "1",
    "joinedAt": "2023-10-05",
    "deletedAt": "2023-12-05 14:30:41",
    "archivedAt": "2023-12-05 14:30:41",
    "createdAt": "2023-12-05 14:30:41"
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}