API Reference

/events

get
https://api.securevan.com/v4/events

Find Events

Description

Use this endpoint to find Events available in the current context using a number of filter options.

Request

This endpoint accepts standard pagination parameters and returns a standard paginated response.

By default, this endpoint returns 10 records per request. A maximum of 50 records per request is allowed via the $top parameter.

Valid expansion properties are: locations, codes, shifts, roles, notes. Note that the number of $expand sections requested may impact the speed with which this endpoint will respond.

The endpoint takes the optional filter parameters as described below

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to 20513,20515

Filters Events to those with the given Code(s) applied (multiple codeIds should be comma-delimited)

string
Defaults to 20036,81987

Filters Events to those of the given Event Type(s) (multiple eventTypeIds should be comma-delimited)

int32
Defaults to 1374

Filters to Recurring Events that are recurrences of the given Event ID

date
Defaults to 2019-06-23

Filters Events to those starting after (and not including) a given date (in the format yyyy-MM-dd)

date
Defaults to 2019-06-26

Filters Events to those starting before (and not including) a given date (in the format yyyy-MM-dd)

string
Defaults to 003

Filters Events to those which are associated with the specified District Field Value

int32
Defaults to 123

Filters Events to those which were created by the specified CommitteeID

string
Defaults to locations,codes

Optional; comma-delimited list of expansion properties: locations, codes, shifts, roles, notes

int32
Defaults to 10
Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago