How to query student schedules

There isn’t an official API supported for it, but a little web snooping shows https://your-district.incidentiq.com/api/v1.0/sis/classes/for/user/{UserID}?$s=999 as the potential endpoint to hit. You’ll need an API key with admin credentials to hit that page.

​@DPassey 20080e0 everettsd Good Morning! Your best option for API documentation is to reach out to our support team. I have reached out to our API expert to follow up with you on this thread. 😄

​@LCampbell Thanks for jumping in on this!! 

I HAVE reached out several times to the support team but I get absolutely nowhere, hence I’m using this avenue.  I post a question like I did above and then get a reply of “how can I help you” or “what is your concern”.  Just a waste of time in my mind.

If the API is for our usage, and I really want to use it to it’s fullest extent, then why is the documentation so lacking?  I’m trying to build out my application so we can better leverage the product but don’t know how to do that unless I know exactly what the endpoints, methods and parameters are.  I would really love a full-blown document of everything the API has to offer. I don’t know why you would publish an API this robust (it appears) without all of the documentation.

We do have an SIS classes endpoint. It returns every class section the user is enrolled in, along with the course, the school, and the room.  Here are the details on how to use it.

Endpoint

GET /api/v1.0/sis/classes/for/user/{UserId}

{UserId} is the IncidentIQ UserId (the user's GUID in IncidentIQ), not the SIS user id and not the student ID number.

Headers

Finding the UserId

If you are starting from a student ID number, resolve it first:

POST /api/v1.0/users

{
  "Filters": [
    { "Facet": "schoolidnumber", "Value": "100482", "Selected": true }
  ],
  "FieldsToReturn": ["UserId", "SchoolIdNumber", "Name"]
}

Take Items[0].UserId and pass it into the classes call.

What comes back

A standard list response: Items[] plus a Paging block.

Section records cover the course, the school, and the room. Meeting dates come from the enrollment record, covered below.

Current enrollments

The endpoint returns what the student is enrolled in today. Sections from a finished term drop off on their own, and sections for a term that has not started yet appear once the start date arrives, so there is nothing to filter on your side.

This call takes an IncidentIQ UserId, so it covers students who have an IncidentIQ account. To work directly from SIS identities instead, use the enrollment query below, which is keyed on SisUserId.

Paging and sorting

Results are sorted by Name ascending by default.

Prior terms and full enrollment history

To see enrollments outside the current window, including prior terms and dropped sections, query the enrollment records directly:

POST /api/v1.0/sis/courseusers/query/get

Filter by SisUserId, the SIS user id from GET /api/v1.0/sis/users. Filters must be nested inside RequestOptions:

{
  "RequestOptions": {
    "Filters": [
      { "Facet": "SisUserId", "Ids": ["00000000-0000-0000-0000-000000000001"] }
    ],
    "Paging": { "PageIndex": 0, "PageSize": 100 }
  }
}

Each record carries SisCourseUserId, SisUserId, SisClassId, SisCourseId, RoleId, IsPrimary, ExternalId, AppId, and the BeginDate and EndDate of the enrollment itself. Those two dates are where a section's term window lives. Resolve section names by passing SisClassId to GET /api/v1.0/sis/classes/{SisClassId}.

SisClassId and SisCourseId filter the same way. Nest every filter under RequestOptions.

Related endpoints

Full example

curl -X GET \
  'https://yourdistrict.incidentiq.com/api/v1.0/sis/classes/for/user/00000000-0000-0000-0000-000000000001?$p=0&$s=100' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'SiteId: YOUR_SITE_GUID' \
  -H 'ProductId: 88DF910C-91AA-E711-80C2-0004FFA00010' \
  -H 'Content-Type: application/json'

Response shape

{
  "Items": [
    {
      "SisClassId": "3f21b0c4-8a55-4a1e-9f70-2c1d5b7e4a10",
      "Name": "Algebra I Section 3",
      "ClassCode": "ALG1-003",
      "ClassType": "scheduled",
      "Subjects": "Mathematics",
      "SisCourseId": "b8d4e2a1-77c3-4f19-8e52-9a0f3c6d1b44",
      "CourseName": "Algebra I",
      "CourseCode": "ALG1",
      "LocationId": "c1a7f930-5d62-4b88-a3e1-6f2b9d40c755",
      "LocationName": "Central High School",
      "LocationDetails": "Room 214",
      "IsActive": true,
      "EnrolledStudents": 27,
      "EnrolledUsers": 28,
      "ExternalId": "SIS-SEC-88213",
      "CourseGroupName": "Mathematics 9",
      "SearchText": "Algebra I Section 3 ALG1",
      "SiteId": "9d2c5b71-3f84-4a06-b512-77e8c1904d33",
      "ClassImage": "/media/img/sis-classes/default.png",
      "AppId": "oneroster"
    }
  ],
  "Paging": { "PageCount": 1, "PageIndex": 0, "PageSize": 100, "TotalRows": 6 },
  "ItemCount": 6,
  "StatusCode": 200
}

Sections are one per row, so a student's full course load is the Items array.

​@DPassey 20080e0 everettsd I am excited to introduce you to ​@scopous_iiq who is the API man at iiQ! As we are continuing to build out our API knowledge, we appreciate your patience. 😄