Docs home

Get Student Calendar

Returns every scheduled session in one calendar month for a user. When a student calls it, they get the sessions of the batches they are enrolled in. Admins can pass a student's `user_id` to see that student's calendar.

GET/user/schedule/month
Get Student Calendar
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/user/schedule/month?ORGID=<organizationId>&month=11-2023&user_id=123456' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "classes": [
    [
      6690052,
      1698777000,
      "Diploma in Advanced Contract Drafting, Negotiation and Dispute Resolution",
      1200,
      1260,
      -1,
      "",
      5,
      1698847844,
      221090,
      "Get To Know Our New Portal: Optional Session",
      89752308,
      792,
      "Arshi Naaz",
      80894,
      "ACD: Nov-01-2023",
      1,
      3,
      "We are transitioning to a more seamless way of attending classes. Say goodbye to Zoom links and welcome our new portal. You can now join your classes directly from here.",
      "",
      3,
      "",
      ""
    ],
    [
      6733503,
      1699036200,
      "Diploma in Advanced Contract Drafting, Negotiation and Dispute Resolution",
      1200,
      1320,
      -1,
      "",
      0,
      -1,
      221090,
      "Get To Know Our New Portal: Optional Session",
      89752308,
      792,
      "Arshi Naaz",
      80894,
      "ACD: Nov-01-2023",
      1,
      1,
      "We are transitioning to a more seamless way of attending classes. Say goodbye to Zoom links and welcome our new portal. You can now join your classes directly from here.",
      "",
      3,
      "",
      ""
    ],
    [
      6693106,
      1699036200,
      "Diploma in Advanced Contract Drafting, Negotiation and Dispute Resolution",
      1200,
      1260,
      -1,
      "",
      0,
      -1,
      221090,
      "Get To Know Our New Portal: Optional Session",
      89752308,
      792,
      "Arshi Naaz",
      80894,
      "ACD: Nov-01-2023",
      1,
      1,
      "We are transitioning to a more seamless way of attending classes. Say goodbye to Zoom links and welcome our new portal. You can now join your classes directly from here.",
      "",
      3,
      "",
      ""
    ],
    [
      6733522,
      1699122600,
      "Diploma in Advanced Contract Drafting, Negotiation and Dispute Resolution",
      1200,
      1320,
      -1,
      "",
      0,
      -1,
      221090,
      "Get To Know Our New Portal: Optional Session",
      89752308,
      792,
      "Arshi Naaz",
      80894,
      "ACD: Nov-01-2023",
      1,
      1,
      "We are transitioning to a more seamless way of attending classes. Say goodbye to Zoom links and welcome our new portal. You can now join your classes directly from here.",
      "",
      3,
      "",
      ""
    ]
  ]
}

Access: Any logged-in user. Students and tutors always get their own schedule; user_id is ignored for them. Other roles must pass user_id.

Query parameters
monthstringrequired
The month to return, as MM-YYYY (for example 07-2022) or a month name and year separated by a space (for example July 2022). The request fails without it.
user_idinteger
The user whose calendar you want. Only used when the caller is not a student or tutor. If this user is a student, their enrolled batch sessions are returned; if a tutor, the sessions they take.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
classesinteger[][]

Notes: Only sessions in your organizations and in active classes are returned. Extra sessions appear for a student only if they were added to that extra session. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI