Back to Index

GET v1/Events/{token}?languageCode={languageCode}

Gets details of an event by its token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The token for an event

string

Required

languageCode

The language code for the event data

string

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

event_detail_response
NameDescriptionTypeAdditional information
event_token

The unique identifier for the event.

string

None.

name

The name for the event.

string

None.

description

The description for the event.

string

None.

start_datetime

The date time at which the event enters the Active state.

date

None.

end_datetime

The date time at which the event enters the Complete state.

date

None.

friendly_url_path

The 'friendly' identifier for the event.

string

None.

state

The state of the event.

state

None.

items

The list of items associated with an event.

Collection of event_item

None.

terms_and_conditions_content

The terms and conditions associated with the event.

string

None.

refund_policy_content

The refund policy associated with the event.

string

None.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "event_token": "sample string 1",
  "name": "sample string 2",
  "description": "sample string 3",
  "start_datetime": "2019-03-19T11:42:20.5322955-07:00",
  "end_datetime": "2019-03-19T11:42:20.5322955-07:00",
  "friendly_url_path": "sample string 6",
  "state": {
    "name": "sample string 1",
    "code": "sample string 2"
  },
  "items": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "quantity_selector": true,
      "default_unit_quantity": 4,
      "unit_quantity_description": "sample string 5",
      "unit_amount": 1.0,
      "amount": 1.0,
      "amount_adjustable": true,
      "custom_fields": [
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        },
        {
          "name": "sample string 1",
          "default_value": "sample string 2",
          "type": {
            "name": "sample string 1",
            "code": "sample string 2"
          },
          "display_order": 3,
          "required": true
        }
      ]
    }
  ],
  "terms_and_conditions_content": "sample string 7",
  "refund_policy_content": "sample string 8",
  "success": true,
  "message": "sample string 10",
  "message_code": 11,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}