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

Registrations

A registration is a document of data collected from an individual. It describes the time they entered the data, the answers to questions, any additional comments or starring, who collected the data, and more.

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

Field definitions

Property Required Type Methods Description
id String GET, POST, PUT, PATCH
{ "id" : "51278cc7fd1dc9055b000000" }
Name of the event
timeArrived 1 Integer GET, POST, PUT, PATCH
{ "timeArrived" : 1375833802197 }
Unix timestamp the delegate arrived at the event in milliseconds. Either the time they checked-in or signed up. This field is unique to avoid accidently record duplication.
1 This field is only required if the delegate is a new sign-up, as check-ins can be created before the event.
isCheckIn Boolean GET, POST, PUT
{ "isCheckIn" : true }
Defines if the registration is a check-in and should be shown in the check-in list, or not
values String, null GET, POST, PUT, PATCH
{ "values" : { "fullName" : { "value":"Greg Goodguy" } } }
The responses to the questions defined in the event. The keys are the IDs of the questions, the values are objects containing a "value" attribute. See Expected Response Types for more details on the expected value for different question types.
When PATCHing, you can use the dot syntax to just update a specific value. For example, {"values.fullName":{"value":"Steve S"}}
starred Integer, null GET, POST, PUT, PATCH
{ "starred" : 4 }
The star rating of the registration. 1 to 5 or null.
comments String, null GET, POST, PUT, PATCH
{ "comments" : "Good guy Greg" }
Comments on a delegate. Max 5000 characters
eventID Boolean GET
{ "eventID" : 6214 }
For information only, the eventID the registration is associated with
appUserID Boolean GET, POST, PUT, PATCH
{ "appUserID" : 1375833802197 }
The 'app user' the data was collected or checked-in with
source String GET
{ "source" : "API" }
The source the registration originated from. One of "API", "upload", "dashboard", "widget"
APIClient String GET
{ "APIClient" : "App" }
If "source" is "API", the API client the data was submitted from — either App, your client credentials client id, or the client id of another service integrated with Akkroo
lastModified String GET
{ "lastModified" : "Wed, 27 Jul 2016 15:13:48 GMT" }
For information only, the date of the last update to the registration
created String GET
{ "created" : "Wed, 27 Jul 2016 15:13:48 GMT" }
For information only, the date the registration was first saved within Akkroo
otherData Object GET
{ "otherData" : { } }
For information only, the eventID the registration is associated with

Expected response types

Event question type Expected response type
Text String
Email String, email format (see question definition)
Date String, date formats (see question definition)
Drop down select String (id, when multiselect: false), Array (of ids, when multiselect: true)
Single checkbox Boolean (true for checked)
Checkbox group Array (of ids)
Radio group String (id)
Number Numeric string, integer, float
Telephone String
URL String, URL format (see question definition)
Twitter username String
Rating / Stars Integer

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
isCheckIn true, false No value (i.e. get all) Restricts returned results to only check-ins or new registrations
hasArrived true, false No value (i.e. get all) Restricts the returned results to only arrived (new signups and checked-in) or not arrived (not checked-in)
createdFrom Unix Timestamp No value (i.e. return all registrations) Restricts the returned results to items created before or on the timestamp you provide
createdTo Unix Timestamp No value (i.e. return all registrations) Restricts the returned results to items created on or after the timestamp you provide
lastModifiedFrom Unix Timestamp No value (i.e. return all registrations) Restricts the returned results to items created or updated before or on the timestamp you provide
lastModifiedTo Unix Timestamp No value (i.e. return all registrations) Restricts the returned results to items created or updated on or after the timestamp you provide

Validation errors

New registrations are validated against the defined questions. If creating a new check-in that has not arrived, the data is only validated against the fullName and email fields.

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
checkinNotAllowed A check-in is not allowed for this event type
registrationNotAllowed A registration is not allowed for this event type
eventArchived The event has been archived and registrations cannot be changed
eventExpired The event is past its endDate and new registrations or check-ins are not allowed

Example document

{
	"values":
	{
		"textfield":
		{
			"value": "ABC123"
		},
		"email":
		{
			"value": "username@example.com"
		},
		"date":
		{
			"value": "1992-01-01"
		},
		"select":
		{
			"value":
			[
				"2",
				"Three",
				"4"
			]
		},
		"emailMe":
		{
			"value": true
		},
		"fullName":
		{
			"value": "joe bloggs"
		},
		"twitter":
		{
			"value": "nrbrook"
		}
	},
	"timeArrived":1469632428696,
	"appUserID":1,
	"eventID" : "118",
	"isCheckIn":false,
	"source" : "API",
	"APIClient" : "App",
	"lastModified": "Wed, 27 Jul 2016 15:13:48 GMT",
	"created": "Wed, 27 Jul 2016 15:13:48 GMT",
	"id" : "51278cc7fd1dc9055b000000"
}