Parameter | Description | Operators | Values | Type | Example |
---|---|---|---|---|---|
isFav | returns favorite organizations | = | true | boolean | ::isFav = true |
name | returns organizations with a name matching a value | = startsWith endsWith contains | any string | string | ::name startsWith 'student' |
formal | returns organizations with a formal name matching a value | contains | any string | string | ::formal contains 'student' |
key | returns organizations with a key | = | true | boolean | ::key = true |
code | returns organizations matching the specified accounting code | = | any string | string | ::code = '2018Q2' |
modifiedSince | returns organizations with a modified date greater than or equal to the given date | = | today, '2018-05-04', or any other date value | date | ::modifiedSince = today ::modifiedSince = today - 5 ::modifiedSince = today + 3 ::modifiedSince = '2018-05-04' |
modifiedBy | returns organizations modified by a given person | = | any contact | string | ::modifiedBy = 'Bob' |
org | returns the exact organizations selected from the suggestion dropdown | in | one or more organizations, selected from the suggestion dropdown | string | ::org in ('American Red Cross') |
orgSearch | returns organizations associated with the organizations returned from a organization search | = | an organization search | string | ::orgSearch = 'Academic Organizations' |
address | returns organizations associated with address fields | in | address type and various string fields for an address, such as street, city, zip, country, phone, fax | string | ::address in ('(none)', '1234 SE 10th', 'Portland', '97201', 'USA', '503-123-4567', '503-123-4567') ::address in ('(none)', '1234 SE 10th', '', '', '', '', '') ::address in ('Billing', '1234 SE 10th', '', '', '', '', '') ::address in ('Administration', '', '', '', '', '503-123-4567', '') |
category | returns organizations associated with categories | in notIn all | one or more organization categories, selected from the suggestion dropdown | string | ::cat in ('Off-Campus') ::cat notIn ('Student Sponsored') ::cat all ('Student Government', 'President Sponsored') |
contact | returns organizations associated with some contacts who play a certain organization role in the organization | 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:-1', 'Corwin') |
type | returns organizations of a certain organization type | in | one or more organization types selected from the suggestion dropdown | string | ::type in ('Academic') |
rating | returns organizations of a certain rating | in | one or more ratings selected from the suggestion dropdown | string | ::rating in ('Do Not Allow Bookings', 'Risk of Nonpayment', 'Suspended') |
event | returns organizations within selected events | in | one or more events, selected from the suggestion dropdown | string | ::event in ('Book Club Meeting', 'How to Fight Chaos') |
eventSearch | returns organizations returned from a saved search | = | an event search | string | ::eventSearch = 'Events On Main Campus' |
custAtrb | returns organizations 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', '2018-01-01') ::custAtrb in ('Amount Received', 'exists', 'F') |