Akkroo
  1. Support
  2. Developers
  3. API
  4. Endpoints
  5. Event Methods

Events

Events define what questions are asked of the end user and the data required from them, and contain a collection of registrations.

Collection https://akkroo.com/api/events OPTIONS, HEAD, GET, POST
Model https://akkroo.com/api/events/<id> OPTIONS, HEAD, GET, PUT, PATCH, DELETE

Field definitions

Property Required Type Methods Description
name String GET, POST, PUT, PATCH
{ "name" : "Oxford Questionnaire" }
Name of the event
type Integer GET, POST, PUT
{ "type" : 1 }
Type of event. See the list of event types.
status Integer GET, POST, PUT
{ "status" : 1 }
Status of event:
  • 1 (default) — active
  • 2 — archived
date Integer GET, POST, PUT, PATCH
{ date : "2013-06-19" }
Start date of the event in the format YYYY-MM-DD
questions 1 Array GET, POST, PUT, PATCH
{ "questions" : [ ] }
The definitions of any questions asked at the event, presented in an array. Read the Questions Definition for more information.
lastModified String GET
{ "lastModified" : "Mon, 25 Jul 2016 14:33:56 GMT" }
The date of the last change to the event configuration
eventCSS String, null GET, POST, PUT, PATCH
{ "eventCSS" : null }
Custom CSS applied in the Akkroo App per event.
styleJSON String, null GET, POST, PUT, PATCH
{ "styleJSON" : null }
Defines the form style in the Akkroo App per event.
brandingImageResourceName String, null GET, POST, PUT, PATCH
{ "brandingImageResourceName" : "wexler-logo.png" }
The name of the branding image resource displayed on the event form.
checkinCancelButton String, null GET, POST, PUT, PATCH
{ "checkinCancelButton" : "Not me..." }
The text shown on the cancel button when confirming your email address during check-in (check-in events only).
checkinCancelButton String, null GET, POST, PUT, PATCH
{ "checkinCancelButton" : "Not me..." }
The text shown on the cancel button when confirming your email address during check-in (check-in events only).
checkinConfirmButton String, null GET, POST, PUT, PATCH
{ "checkinConfirmButton" : "Yes, that's me!" }
The text shown on the Confirmation button when confirming your email address during check-in (check-in events only).
checkinToolbarTitle String, null GET, POST, PUT, PATCH
{ "checkinToolbarTitle" : "Check in" }
The title shown in along the top of the screen when confirming your email address during check-in (check-in events only).
combinedLandingQuestion String, null GET, POST, PUT, PATCH
{ "combinedLandingNo" : "Did you register before the event?" }
The question posed on the first page of an event where both pre-registered and unregistered guests are able to attend.
combinedLandingNo String, null GET, POST, PUT, PATCH
{ "combinedLandingNo" : "No" }
The label text of the "No" button as an answer to the combinedLandingQuestion on the first page of an event where both pre-registered and unregistered guests are able to attend.
combinedLandingYes String, null GET, POST, PUT, PATCH
{ "combinedLandingYes" : "Yes" }
The label text of the "Yes" button as an answer to the combinedLandingQuestion on the first page of an event where both pre-registered and unregistered guests are able to attend.
doneButton String, null GET, POST, PUT, PATCH
{ "doneButton" : "Done" }
The text label of the "Done" button at the end of the sign-up/check-in process.
doneMessage String, null GET, POST, PUT, PATCH
{ "doneMessage" : "We've saved your details and sent you an email with more info." }
The text displayed at the end of the sign-up/check-in process.
doneToolbarTitle String, null GET, POST, PUT, PATCH
{ "doneToolbarTitle" : "Thanks!" }
The text displayed at the end of the sign-up/check-in process.
registerButton String, null GET, POST, PUT, PATCH
{ "registerButton" : "Register" }
The text displayed on the button at the end of a sign-up form.
registerToolbarTitle String, null GET, POST, PUT, PATCH
{ "registerToolbarTitle" : "Register" }
The text displayed on the toolbar on the sign-up form.
selectOneButton String, null GET, POST, PUT, PATCH
{ "selectOneButton" : "Checkin" }
The text displayed on the button to confirm your email address when checking in
tags Array GET
{ "tags" : ["example tag 1","another-tag"] }
An array of tags that can be used for storing metadata as strings. For key-value pairs, we suggest using your own name-spacing convention e.g. mykey:myvalue:mysubvalue
preRegEndDate String, null GET
{ "preRegEndDate" : "2013-06-19" }
End date for event pre-registration in the format YYYY-MM-DD
preRegMaxCount Integer, null GET
{ "preRegMaxCount" : 50 }
Maximum number of pre-registrations allowed
registrationsLastModified String GET
{ "registrationsLastModified" : "Mon, 25 Jul 2016 14:33:56 GMT" }
Date of the last update to the event registrations, including any new registrations, new check-ins and new pre-registrations

1 Except event type 2

Query Parameters

These query parameters can be used when fetching the collection to alter the set of results you receive. These query parameters are in addition to the common query parameters available on all collections.

Parameter Values Default Description
lastModifiedFrom Unix Timestamp No value (i.e. returns all records) Will restrict returned results to events created or updated before or on the timestamp value you provide
lastModifiedTo Unix Timestamp No value (i.e. returns all records) Will restrict returned results to events created or updated on or after the timestamp value you provide
registrationsLastModifiedFrom Unix Timestamp No value (i.e. returns all records) Will restrict the returned results to only events which contain registrations that have a last modified timestamp on or before the timestamp value you provide
registrationsLastModifiedTo Unix Timestamp No value (i.e. returns all records) Will restrict the returned results to only events which contain registrations that have a last modified timestamp on or after the timestamp value you provide

Validation errors

In addition to the general field validation error types the following validation errors may also occur on this endpoint:

Error type Error description Error parameters
dateInPast The event date provided is in the past
registrationNotAllowed A registration is not allowed with the current event type.

Example document

{
	"id":134,
	"name":"Registration test - do not delete",
	"type":5,
	"status" : 1,
	"date":"2015-09-26",
	"lastModified" : "Mon, 17 Aug 2015 09:01:15 GMT",
	"tags" : [
		"Test event"
	],
	"preRegEndDate": "2015-09-24",
	"preRegMaxCount": 60,
	"registrationsLastModified": "Wed, 19 Aug 2015 14:33:56 GMT",
	"questions":[
		{
			"type":"text",
			"label":"Full Name",
			"required":true,
			"autoCorrect":"off",
			"autoCapitalize":"words",
			"id":"fullName"
		},
		{
			"type":"email",
			"label":"Email",
			"required":true,
			"autoCorrect":"off",
			"id":"email"
		}
	]
}