Announcements

Search announcements

Search for one or more announcements.

get/v1/Announcements

Request

Query parameters

search.announcement_idinteger[]

Query by announcement identifier.

search.body_htmlstring[]

Query by HTML body.

search.created_date_startstring date-time

Query by created date.

search.created_date_endstring date-time

Query by created date.

search.locationstring[]

Query by location.

search.titlestring[]

Query by title.

search.is_activeboolean

Query by what is active

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.