Criteria Variables
| Variable | Abbreviation | Description / Usage | ||
|---|---|---|---|---|
 |
||||
| timeZone | tz | Specifies that the retrieval interface should return only events occuring within the timezone(s) identified by a comma separated list of locale names. Available Values | ||
|
||||
| type | et | Specifies that the retrieval interface should return only events of a given type as identified by a comma separated list of event type codes. Available Values | ||
|
||||
| securityGroup | sg | Specifies that the retrieval interface should return only events information for which the security group(s) identified by a comma separated list of group codes have read privileges. Available Values | ||
|
||||
| status | st | Specifies that the retrieval interface should return only events of a status identified within a comma separated list of status codes. Available Values | ||
|
||||
| sponsor | sp | Specifies that the retrieval interface should return only events sponsored by one or more sponsors identified by a comma separated list of sponsor codes. Available Values | ||
|
||||
| typeFilter | Specifies that the retrieval interface should return only events of a given type as identified by a comma separated list of event type id numbers. Available Values | |||
|
||||
| legacyTypeFilter | legacyTypeFilter functions like typeFilter, but the ID numbers refer to types in Calendar3, which will be returned alongside Sundial events. | |||
|
||||
| inheritSponsors | is | Specifies whether the retrieval interface should return only events that are directly related to the sponsor(s) specified by the sponsor or sponsorFilter criteria, or also return events that inherit an association with the specified sponsor(s). | ||
|
||||
| inheritPopulations | ip | Specifies whether the retrieval interface should return only events that are directly related to the population(s) specified by the population or populationFilter criteria, or also return events that inherit an association with the specified population(s). | ||
|
||||
| inheritGroups | ig | Specifies whether the retrieval interface should return only events that are directly related to the group(s) specified by the group or groupFilter criteria, or also return events that inherit an association with the specified group(s). | ||
|
||||
| inheritTypes | it | Specifies whether the retrieval interface should return only events that are directly related to the type(s) specified by the type or typeFilter criteria, or also return events that inherit an association with the specified type(s). | ||
|
||||
| audienceAffil | Specifies that the retrieval interface should return only events that have been suggested for publication to the target audience(s) specified. Available Values | |||
|
||||
| publicationStatus | ps | Specifies that the retrieval interface should return events whose publication status is specified. The publication status format string is a string of the publication status values 'A', 'C', 'P', 'Q', 'X', which correspond to Approved, Conditionally Approved, Pending, Queued, and Declined. An absense of a publication status value results in that publication status type not being returned by the retrieval interface. | ||
|
||||
| effectiveDate | ed | Specifies a date for which to simulate the requested listing. This allows for authenticated target audience administrators to view their calendar at a future date. This variable will not work for non-authenticated requests. | ||
|
||||
| eventFilter | id | Specifies that the retrieval interface should return only events corresponding to the one event id number or a comma separated list of event id numbers. | ||
|
||||
| categoryFilter | ca | Specifies that the retrieval interface should return events in an order specified by a category format string. The category format string is a string of the category type values 'A', 'E', 'T', which correspond to All Day events, Ending events, and Today's events. An absense of a category type value from the category format string results in that category type not being returned by the retrieval interface. | ||
|
||||
| dateUpdated | du | Specifies that events returned by the retrieval interface must have been updated on or after the date specified by dateUpdated. Any string containing an English date format may be specified as per GNU date syntax. | ||
|
||||
| dateStart | ds | Specifies that events returned by the retrieval interface must begin on or after the date specified by dateStart. Any string containing an English date format may be specified as per GNU date syntax. If unspecified, the calendar system assumes from this moment onwards. | ||
|
||||
| site | es | Specifies that the retrieval interface should return only events corresponding to the site(s) specified within a comma separated list of site identifiers.
To specify that events corresponding all sites within a given site collection should be returned, simply specify the site collection's code as the site identifer. {$CALENDAR_FULL_HTTP_URL}webapi/get.php?site=<Site Collection Code> To specify that events corresponding to a specific site should be returned, provide a full site identifier. {$CALENDAR_FULL_HTTP_URL}webapi/get.php?site=<Site Collection Code>.<Site Code> |
||
|
||||
| groupFilter | Specifies that the retrieval interface should return only events information for which the security group(s) identified by a comma separated list of group id numbers have read privileges. Available Values | |||
|
||||
| populationFilter | Specifies that the retrieval interface should return only events that have been approved for publication to the population(s) identified by a comma separated list of population id numbers. Available Values | |||
|
||||
| population | pop | Specifies that the retrieval interface should return only events that have been approved for publication to the population(s) identified by a comma separated list of population codes. Available Values | ||
|
||||
| keyword | kw | Specifies that events returned by the retrieval interface must contain any of the comma separated words specified by the keyword variable within their name, summary, or description fields. | ||
|
||||
| legacyGroupFilter | Functions like groupFilter, but refers to Calendar3 group IDs. Events retrieved will be displayed next to retrieved Sundial events. | |||
|
||||
| dateEnd | de | Specifies that events returned by the retrieval interface must begin prior or up to the date specified by dateEnd. Any string containing an English date format may be specified as per GNU date syntax. If unspecified, the calendar system assumes 30 days relative to the dateStart specified to or defaulted to within the retrieval interface. Dates may also be specified as relative to the start date by specifying <number of days>. For example, R50 would specify an end date 50 days after the start date. | ||
Revised: July 21, 2009