Skip to content
Kevin Glover edited this page Apr 3, 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",
	"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
  • name - name of experience
  • description - description of experience
  • image - url of image
  • author - name of author
  • actions - list of actions
  • availabilities - list of object used to

Actions

  • name - name of action
  • codes - list of string representations of artcode markers
  • match - used to configure matching behaviour
    • any - url is triggered if any of the codes are scanned
    • all - url is triggered 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 restricts when are where the experience is available.

  • start - the experience is available from this date
  • end - the experience is available to this date
Clone this wiki locally