calendar

Return the Events for a place in a given service.

Returns up to 100 events, starting after the current time. The time range can be set using the before and after Query parameters.

If a Client instance ID header is set (X-App-Instance> or X-Widget-Instance), OR if the caller is an administrator, then any Client Events for the given place are also included.

get/places/{place_id}/services/{svc_id}/events

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/places/{place_id}/services/{svc_id}/events
  • Auth: none declared

Path parameters

place_idstring required

Place ID is the UUID for a given place within ReCollect

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Query parameters

include_messagestring

Which reminder target type of message would you like? (eg: "email" or "sms" or "voice")

nomergeboolean

Should we not merge events together into one per day? (Default is false: merge them into one per day)

localestring

The locale code for this request. (eg: "en" or "fr")

afterstring

A date timestamp in the format YYYY-MM-DD. Query will be filtered to only show resources after the given date.

beforestring

A date timestamp in the format YYYY-MM-DD. Query will be filtered to only show resources before the given date.

Response

200 OK

Changes

No recorded changes to this operation across all 1 revision of this API.