Eventyaydroid HTTP API

The eventyaydroid plugin provides a HTTP API that the eventyaydroid Android app uses to communicate with the eventyay server.

Warning

This API is DEPRECATED and will probably go away soon. It is used only to serve the eventyaydroid Android app. There are no backwards compatibility guarantees on this API. We will not add features that are not required for the Android App. There is a general-purpose REST API that provides all features that you need to check in.

Changed in version 1.12: Support for check-in-time questions has been added. The new API features are fully backwards-compatible and negotiated live, so clients which do not need this feature can ignore the change. For this reason, the API version has not been increased and is still set to 3.

Changed in version 1.13: Support for checking in unpaid tickets has been added.

POST /eventyaydroid/api/(organizer)/(event)/redeem/

Redeems a ticket, i.e. checks the user in.

Example request:

POST /eventyaydroid/api/demoorga/democon/redeem/?key=ABCDEF HTTP/1.1
Host: demo.eventyay.com
Accept: application/json, text/javascript
Content-Type: application/x-www-form-urlencoded

secret=az9u4mymhqktrbupmwkvv6xmgds5dk3&questions_supported=true

You must set the parameter secret.

You must set the parameter questions_supported to true if you support asking questions back to the app operator. You must not set it if you do not support this feature. In that case, questions will just be ignored.

You may set the additional parameter datetime in the body containing an ISO8601-encoded datetime of the entry attempt. If you don”t, the current date and time will be used.

You may set the additional parameter force to indicate that the request should be logged regardless of previous check-ins for the same ticket. This might be useful if you made the entry decision offline. Questions will also always be ignored in this case (i.e. supplied answers will be saved, but no error will be thrown if they are missing or invalid).

You may set the additional parameter nonce with a globally unique random value to identify this check-in. This is meant to be used to prevent duplicate check-ins when you are just retrying after a connection failure.

You may set the additional parameter ignore_unpaid to indicate that the check-in should be performed even if the order is in pending state.

If questions are supported and required, you will receive a dictionary questions containing details on the particular questions to ask. To answer them, just re-send your redemption request with additional parameters of the form answer_<question>=<answer>, e.g. answer_12=24.

Example successful response:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "status": "ok"
  "version": 3,
  "data": {
    "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
    "order": "ABCDE",
    "item": "Standard ticket",
    "item_id": 1,
    "variation": null,
    "variation_id": null,
    "attendee_name": "Peter Higgs",
    "attention": false,
    "redeemed": true,
    "checkin_allowed": true,
    "addons_text": "Parking spot",
    "paid": true
  }
}

Example response with required questions:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "status": "incomplete"
  "version": 3
  "data": {
    "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
    "order": "ABCDE",
    "item": "Standard ticket",
    "item_id": 1,
    "variation": null,
    "variation_id": null,
    "attendee_name": "Peter Higgs",
    "attention": false,
    "redeemed": true,
    "checkin_allowed": true,
    "addons_text": "Parking spot",
    "paid": true
  },
  "questions": [
    {
      "id": 12,
      "type": "C",
      "question": "Choose a shirt size",
      "required": true,
      "position": 2,
      "items": [1],
      "options": [
        {
          "id": 24,
          "answer": "M"
        },
        {
          "id": 25,
          "answer": "L"
        }
      ]
    }
  ]
}

Example error response with data:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "status": "error",
  "reason": "already_redeemed",
  "version": 3,
  "data": {
    "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
    "order": "ABCDE",
    "item": "Standard ticket",
    "item_id": 1,
    "variation": null,
    "variation_id": null,
    "attendee_name": "Peter Higgs",
    "attention": false,
    "redeemed": true,
    "checkin_allowed": true,
    "addons_text": "Parking spot",
    "paid": true
  }
}

Example error response without data:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "status": "error",
  "reason": "unkown_ticket",
  "version": 3
}

Possible error reasons:

  • unpaid - Ticket is not paid for or has been refunded

  • already_redeemed - Ticket already has been redeemed

  • product - Tickets with this product may not be scanned at this device

  • unknown_ticket - Secret does not match a ticket in the database

Query Parameters:

  • key – Secret API key

Status Codes:
GET /eventyaydroid/api/(organizer)/(event)/search/

Searches for a ticket. At most 25 results will be returned. Queries with less than 4 characters will always return an empty result set.

Example request:

GET /eventyaydroid/api/demoorga/democon/search/?key=ABCDEF&query=Peter HTTP/1.1
Host: demo.eventyay.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "results": [
    {
      "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
      "order": "ABCE6",
      "item": "Standard ticket",
      "variation": null,
      "attendee_name": "Peter Higgs",
      "redeemed": false,
      "attention": false,
      "checkin_allowed": true,
      "addons_text": "Parking spot",
      "paid": true
    },
    ...
  ],
  "version": 3
}
Query Parameters:

  • query – Search query

  • key – Secret API key

Status Codes:
GET /eventyaydroid/api/(organizer)/(event)/download/

Download data for all tickets.

Example request:

GET /eventyaydroid/api/demoorga/democon/download/?key=ABCDEF HTTP/1.1
Host: demo.eventyay.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "version": 3,
  "results": [
    {
      "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
      "order": "ABCE6",
      "item": "Standard ticket",
      "variation": null,
      "attendee_name": "Peter Higgs",
      "redeemed": false,
      "attention": false,
      "checkin_allowed": true,
      "paid": true
    },
    ...
  ],
  "questions": [
    {
      "id": 12,
      "type": "C",
      "question": "Choose a shirt size",
      "required": true,
      "position": 2,
      "items": [1],
      "options": [
        {
          "id": 24,
          "answer": "M"
        },
        {
          "id": 25,
          "answer": "L"
        }
      ]
    }
  ]
}
Query Parameters:

  • key – Secret API key

Status Codes:
GET /eventyaydroid/api/(organizer)/(event)/status/

Returns status information, such as the total number of tickets and the number of performed check-ins.

Example request:

GET /eventyaydroid/api/demoorga/democon/status/?key=ABCDEF HTTP/1.1
Host: demo.eventyay.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Content-Type: text/json

{
  "checkins": 17,
  "total": 42,
  "version": 3,
  "event": {
    "name": "Demo Conference",
    "slug": "democon",
    "date_from": "2016-12-27T17:00:00Z",
    "date_to": "2016-12-30T18:00:00Z",
    "timezone": "UTC",
    "url": "https://demo.eventyay.com/demoorga/democon/",
    "organizer": {
      "name": "Demo Organizer",
      "slug": "demoorga"
    },
  },
  "items": [
    {
      "name": "T-Shirt",
      "id": 1,
      "checkins": 1,
      "admission": False,
      "total": 1,
      "variations": [
        {
          "name": "Red",
          "id": 1,
          "checkins": 1,
          "total": 12
        },
        {
         "name": "Blue",
          "id": 2,
          "checkins": 4,
          "total": 8
        }
      ]
    },
    {
      "name": "Ticket",
      "id": 2,
      "checkins": 15,
      "admission": True,
      "total": 22,
      "variations": []
    }
  ]
}
Query Parameters:

  • key – Secret API key

Status Codes: