Viviot.Api

<back to all web services

ExternalEvents

Requires Authentication
Requires the role:EventPublisher
The following routes are available for this service:
POST/client/{externalOrganizationId}/eventsAccepts and stores a collection of IoT events from an external system.
ExternalEvents Parameters:
NameParameterData TypeRequiredDescription
ExternalOrganizationIdpathstringYesExternal Organization Id
EventsbodyList<ExternalOrganizationEvent>No
ExternalOrganizationEvent Parameters:
NameParameterData TypeRequiredDescription
AccessIdformstringNo
TimestampformDateTimeNo
EventformintNo
EventDataformObjectNo
EventTypeformstringNo
AccessPointIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /client/{externalOrganizationId}/events HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	externalOrganizationId: String,
	events: 
	[
		{
			access_id: String,
			timestamp: -62135596800000,
			event: 0,
			event_data: {},
			event_type: String,
			access_point_id: String
		}
	]
}