Skip to content
Kevin Glover edited this page Apr 4, 2017 · 7 revisions

Experience JSON file format

{
	"id": "http://aestheticodes.appspot.com/experience/4c758e29-0759-4583-a0d4-71ee692b7f86",
	"name": "Experience Name",
	"description": "Experience Description",
	"image": "https://image.com/image.png",
	"icon": "https://image.com/icon.png",
	"author": "Kevin Glover",
	"actions": [
		{
			"name": "Action Name",
			"url": "http://www.artcodes.co.uk",
			"codes": [
				"1:1:1:3:3",
				"1:1:2:4:4"
			],
			"match": "any"
		}
	],
	"availabilities": [
		{}
	]
}

Experience

  • id - url of experience, this will be generated by the server if the experience is uploaded
  • name - name of experience
  • description - description of experience
  • image - url of image
  • icon - url of icon
  • author - name of author
  • actions - list of actions, see below
  • availabilities - list of availabilities, see below

Actions

  • name - name of action
  • codes - list of codes
  • url - the url
  • match - used to configure matching behaviour
    • any - url is opened if any of the codes are scanned
    • all - url is opened if all of the codes are scanned at the same time

Availability

If the availability list is empty, the experience is considered unlisted. It can still be found by url, but won't appear in searches and won't be recommended. Each availability specifies a place and time when that experience is public. All properties are optional, with a completely empty availability meaning that the experiences is available anywhere at any time.

  • start - the experience is available from this date
  • end - the experience is available to this date
  • lat - latitude. Used to determine if the user is near the experience
  • lon - longitude. Used to determine if the user is near the experience
  • name - human-readable name of the location
  • address - location address
Clone this wiki locally