The Calendar API test tool may be used to test the results returned by a certain filter and output, as well as to help formulate the filter syntax that can be used in the API queries.
To access the Calendar API Test page, the user role must include permission to View Activity Calendars and Manage Calendars.
The test tool can be accessed by going to the following URL from within the Astra Schedule application:
The API test tool consists of the following elements:
A filter panel is provided on the far left side of the page. The filter controls here work similarly to other list page filters throughout the application. You may enter a keyword search, date range, and/or one or more filter criteria from the list. When "Search" is clicked, the list grid will update to show the matching results.
The purpose of this tool is to test certain filters to see if the data returned is what is desired.
Activity List Grid
This grid shows a list of all activities returned by the search criteria. Activities may include event activities, section activities, holidays, and announcements. Review the data to be sure that the results are desired.
When satisfied with the results, the API query that returned the results can be copied directly by using the "Show URL" option. This can help you formulate the required API calls when creating a program that utilizes the API.
List Output Options
The buttons across the top of the page allow you to test the list output formats supported by the API. Click one of the output buttons and the list of activities in the search results will be displayed or exported in the format desired.
Detail Output Options
The buttons to the left of each row in the search results allow you to test the detail output formats supported by the API. Click one of the output buttons and the detail information for that specific activity will be displayed or exported in the format desired.
Please sign in to leave a comment.