NGngpvan

/events

Changed on

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

get/events

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/events
  • Auth
    HTTP basic

Query parameters

codeIdsstring

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

eventTypeIdsstring

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

inRepetitionWithEventIdinteger

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

startingAfterstring date

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

startingBeforestring date

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

districtFieldValuestring

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

createdByCommitteeIdinteger

Filters Events to those which were created by the specified CommitteeID

$expandstring

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

$topinteger

Response

200

nextPageLinkstring
countinteger

Example response

{
  "items": [
    {
      "eventId": 1370,
      "name": "Neighbors Calling Neighbors",
      "shortName": "NeighborCall",
      "description": "Come help get the word out about our great campaign.",
      "startDate": "2015-06-01T15:00:00-04:00",
      "endDate": "2015-06-01T20:00:00-04:00",
      "eventType": {
        "eventTypeId": 143856,
        "name": "Phone Bank"
      },
      "shifts": [
        {
          "eventShiftId": 2162,
          "name": "Setup",
          "startTime": "2015-06-01T15:00:00-04:00",
          "endTime": "2015-06-01T16:00:00-04:00"
        }
      ],
      "districtFieldValue": "003",
      "createdDate": "2015-04-05T13:18:00Z"
    }
  ],
  "nextPageLink": "https://api.securevan.com:443/v4/events?startingAfter=2015-05-31&$expand=shifts&$top=2&$skip=2",
  "count": 1
}

Changes