Astra Schedule Help (7.5)

API FAQ

Hide Navigation Pane

API FAQ

 Previous topic Next topic  

API FAQ

 Previous topic Next topic JavaScript is required for the print function  
hmtoggle_plus1The API overview exposes the high-level concepts behind the API, but does not give details about ALL of the endpoints available.  Is there additional information available?

The vast majority of what API users need is available through the Query and Entity API calls.  The Entity API call allows you to Create/Read/Update/Delete any entity defined in the system.  The Query API call allows you to search for lists of entities in the system using a powerful filtering syntax.  If you are trying to do things beyond this, other API calls may be available to suit your needs.  We can work with you to determine other specialized API calls you may need to call and how to call them.

 

hmtoggle_plus1Is application user security respected in the API?

No, the API does not limit access to API calls based on user permissions at this time.  Once the user has been authenticated by the system, they have access to all features available through the API.

 

If specific user permissions are required, authentication and security must be enforced in the application for which you are using the API.

 

I’m using the following API call to find activities on the calendar (whether classes i.e. “ACCT 101”, or other events i.e. “Faculty Conference”). In this example, I’m searching for events with the term “acct” in the title. Does this look right?

hmtoggle_plus1https://schoool.edu/AstraSchedule/~api/calendar/calendarList?fields=SectionMeetingId%3ASectionMeetInstanceByActivityId.SectionMeeting.Id%2CParentActivityName%2CDescription%2CLocationName&filter=(((ActivityName%3F%3D%22%25acct%25%22)%7C%7C(ParentActivityName%3F%3D%22%25acct%25%22))%7C%7C(Description%3F%3D%22%25acct%25%22))

Yes - Using the calandarList API to search for an Event or Section by name is a good approach.

 

In my code, after the user has found the course they were searching for with my first API call, I use the Section Meeting ID found to search for all section meeting instances of the course, with the following API call. I also need to find the title and the room location of the section meeting instance. How do I add those fields to this API call?

hmtoggle_plus1https://school.edu/AstraSchedule/~api/query/sectionmeetinstance?fields=id,MeetingDate,DayMask,StartMinute,Duration&filter=(SectionMeetingId==%224d326827-34d5-4fd9-a7d7-070e5f9f97c6%22)

You're on the right track.  I assume you wanted to get all instances back which is why you used the sectionMeetingInstances query API.  The associated data you are looking for is in related (joined) entities.  To access data from related entities, you will need to use the joins between them.  Most of the entities you are interested in are described here in our help system: 

 

Calendar API Data Elements and Associations

 

To access data from a joined entity you need to add a field to your fields parameter when you make the API call.  Add your new field with a name you would like to call the result column followed by a colon, then the dot notation join to the column.

 

For example, to add a field that is the associated room name for the sectionMeetingInstance add the following to your fields parameter:

 

RoomName: RoomConfiguration.Room.Name

 

I tracked this down by looking at the list of joins in the SectionMeetingInstance entity, followed the RoomConfiguration join to the RoomConfiguration entity then followed the Room join from there to the Room entity.

 

Using this approach you can connect to pretty much any data you need related to the Section or Event entity.