Parameter | Description | Operators | Values | Type | Example |
---|---|---|---|---|---|
isFav | returns favorite events | = | true | boolean | ::isFav = true |
name | returns events with a name matching a value | = startsWith endsWith contains | any string | string | ::name startsWith 'foot' |
title | returns events with a title matching a value | contains | any string | string | ::title contains 'foot' |
ref | returns events with a ref matching a value | = | any string | string | ::ref = '2022-ABCDEF' |
any | a shortcut for name or title or ref matching a value. Note that name will use the chosen operator but title and ref will just default to 'contains' and '=', respectively, regardless of your chosen operator. | = startsWith endsWith contains | any string | string | ::any contains 'foot' translates to: ::name contains 'foot' or title contains 'foot' or ref = 'foot' ::any startsWith 'foot' translates to: ::name startsWith 'foot' or title contains 'foot' or ref = 'foot' ::any = 'foot' translates to: ::name = 'foot' or title contains 'foot' or ref = 'foot' |
structure | determines whether the search returns either events, folders, or cabinets | = | E (event), F (folder), C (cabinet) | string | ::structure = 'E' |
earliestStart | returns events with a start date greater than or equal to the given date | = | today, '2022-05-04', or any other date value | date | ::earliestStart = today ::earliestStart = today - 5 ::earliestStart = today + 3 ::earliestStart = '2022-05-04' |
latestEnd | returns events with an end date less than or equal to the given date | = | today, '2022-05-04', or any other date value | date | ::latestEnd = today ::latestEnd = today - 5 ::latestEnd = today + 3 ::latestEnd = '2022-05-04' |
createDt | returns events with a creation date greater than or equal to the given date | >= | today, '2022-05-04', or any other date value | ::createDt >= '2022-06-01' | |
modifiedSince | returns events with a modified date greater than or equal to the given date | = | today, '2022-05-04', or any other date value | date | ::modifiedSince = today ::modifiedSince = today - 5 ::modifiedSince = today + 3 ::modifiedSince = '2022-05-04' |
modifiedBy | returns events modified by a given person | = | any contact | string | ::modifiedBy = 'Bob' |
alienUID | returns events that were imported into the Series system from an external source | = | any string representing an imported id | string | ::alienUID = 'LYNX1234' |
cabinet | returns events in some cabinet | in | one or more cabinets selected from the suggestion dropdown | string | ::cabinet in ('Academic Events', 'Conferences') |
type | returns events of a certain event type | in notIn | one or more event types selected from the suggestion dropdown | string | ::type in ('Luncheon') ::type notIn ('Audition') |
state | returns events in a certain state | in | one or more event states selected from the suggestion dropdown | string | ::state in ('Tentative', 'Confirmed') |
org | returns events associated with some organization | in notIn all | one or more event organizations selected from the suggestion dropdown | string | ::org in ('Student Government', 'Basketball Boosters') ::org notIn ('Delta Delta Delta', 'Epsilon Lambda Omega') ::org all ('Chess Club', 'Magic the Gathering Young Wizardry Club') |
contact | returns events associated with some contacts who play a certain event role in the event | in | a single role type and one or more contacts, selected from the suggestion dropdown | string | ::contact in ('role:0', 'service25, collegenet') ::contact in ('role:-3', 'Corwin') ::contact in ('role:3', 'Merlin') |
event | returns the exact events selected from the suggestion dropdown | in | one or more events, selected from the suggestion dropdown | string | ::event in ('Student Rebellion') |
category | returns events associated with a certain category | in notIn all | one or more event categories, selected from the suggestion dropdown | string | ::category in ('Off-Campus') ::category notIn ('Conference Call') ::category all ('Debate', 'Political Party') |
requirement | returns events with certain requirements | in notIn all | one or more event requirements, selected from the suggestion dropdown | string | ::requirement in ('Publish to Calendar') ::requirement notIn ('Do not publish to any calendar') ::requirement all ('Bartender', 'Bouncer') |
location | returns events associated with certain locations | in all | one or more locations, selected from the suggestion dropdown | string | ::location in ('Ballroom') ::location all ('Gym', 'Locker Room', 'Coaches'' Staff Room') |
resource | returns events associated with certain resources | in all | one or more resources, selected from the suggestion dropdown | string | ::resource in ('Microphone') ::resource all ('Spaceship', 'HAL 9000', 'Laser') |
eventSearch | returns events returned from a saved search | = | an event search | string | ::eventSearch = 'Campus Events' |
orgSearch | returns events associated with the organizations returned from an organization search | = | an organization search | string | ::orgSearch = 'Academic Organizations' |
resourceSearch | returns events associated with the resources returned from an resource search | = | a resource search | string | ::resourceSearch = 'Equipment Resources' |
locationSearch | returns events associated with the locations returned from a location search | = | a location search | string | ::locationSearch = 'Ground-floor Locations' |
hasRelated | returns events that have related events and their related events as well must be included with at least one other criterion | = | true | boolean | ::resource in ('Microphone') and hasRelated = true |
hasBound | returns events that have bound events and their bound events as well must be included with at least one other criterion | = | true | boolean | ::resource in ('Microphone') and hasBound = true |
vCalNeedsLocation | returns events that have outstanding vCalendar To-Dos for a location | = | true | boolean | ::vCalNeedsLocation = true |
vcalExceedsHeadCount | returns events that have outstanding vCalendar To-Dos for exceeding head count | = | true | boolean | ::vCalExceedsHeadCount = true |
vCalExport | returns events that have outstanding vCalendar To-Dos for export | = | true | boolean | ::vCalExport = true |
occDate | returns events with occurrences between the specified dates | between | today, '2022-05-04T10:00', or any date or datetime value | date | ::occDate between today and today + 1 ::occDate between today and '2022-04-19T03:00' ::occDate between '2018-04-19T00:00' and '2022-04-19T14:00' |
daysOfWeek | returns events with occurrences that meet on the specified days of the week | in | U, M, T, W, R, F, S | string | ::daysOfWeek in ('M', 'W', 'F') ::daysOfWeek in ('U', 'S') |
expected | returns events with expected head count between the specified values | between | any positive integer | integer | ::expected between 10 and 20 ::expected between 0 and 100 |
registered | returns events with registered head count between the specified values | between | any positive integer | integer | ::registered between 10 and 20 ::registered between 0 and 100 |
reservationName | returns events matching a certain reservation name | = | any string representing a reservation | string | ::reservationName = 'Break out session' |
missingLocationAssn | returns events with missing location assignments between the specified dates | between | today, '2022-05-04T10:00', or any date or datetime value | string | ::missingLocationAssn between today and today + 1 ::missingLocationAssn between '2022-04-19' and today + 1 ::missingLocationAssn between '2022-04-19' and '2022-05-04' |
custAtrb | returns events matching a selected custom attribute and its value | in | Varies | string | ::custAtrb in ('Cancel if Bad Weather?', 'is True', 'B') ::custAtrb in ('Course Section', 'starts with', 'S', 'computational theory') ::custAtrb in ('Date Time', 'is earlier than or equal to', 'E', '2022-01-01') ::custAtrb in ('Amount Received', 'exists', 'F') |