Event

An event is a device that other Satellite Tag devices and delegates can be joined to and that other devices can filter to, to limit the scope of the data sent.

• an event is generally the top level device that all other devices and delegates get joined to;

POST /event/new

Creates a new event.

Example request:

POST /event/new

{
  "eventName": "Extravaganza Event Name",
  "eventExternalID":"123456",
  "eventStartAt": "2018-18-10 00:00:00",
  "eventEndAt": "2018-22-10 00:00:00",
  "eventManagerEmail":"sally@example.com",
  "eventManagerPhone": "+123456789",
}

Example response:

{
  "id": 29,
  "eventName": "Extravaganza Event Name",
  "eventExternalID":"123456",
  "eventStartAt": "2018-18-10 00:00:00",
  "eventEndAt": "2018-22-10 00:00:00",
  "sources": [
      "api"
  ],
  "createdAt": "2018-03-13T23:31:32+00:00",
  "updatedAt": "2018-03-13T23:31:32+00:00"
}

GET /event/{id}

Gets a specific event.

All available properties will be shown.

GET /event/id:820.json

PATCH /event/{id}

Patches an event.

All properties provided in the request will be updated to the given value.

Note

There is a notable exception: the event id cannot be unset.

That is if you try and set the id property to null for example, nothing will happen.

The id of a event can never change.

DELETE /event/{id}

Deletes an event.

This will soft-delete a event from the system, hard deletion is available only from the Control Room. Trying and getting or patching a deleted event will result in a 404 Not Found error.