REST web service interface

GET events

Updated, 2012-06-19 14:28

Returns a list of available events.

Resource Information

Rate Limited? No
Authentication Optional
Response Formats json,xml
HTTP Methods GET
Response Object list<Event>

Resource URL

https://ecommerce.dexero.com/service/rest/2/merchant/catalog/events.format

Parameters

Parameter Description
count Indicates the number of records to retrieve. The default value 20.
Example Values : 30
offset The offset starting point (0-based) to return the first object in the list. The default value is 0.
Example Values : 20
page The page of data to retrieve.
Example Values : 6
locale Language
Example Values : fr, en
product_image_size Image size of returned product
Example Values : 80 , 80x90
include_products When set to true or 1, each event will include a node called "products" which contains a list of related products. The default value is false
Example Values : true

Example Request

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/events.json

Example Response

XML JSON 
{
  "events" : {
    "totalResults" : 2,
    "startIndex" : 0,
    "itemsPerPage" : 20,
    "pageCount" : 1,
    "event" : [
      {
        "id" : 2,
        "name" : "Test event checkin",
        "url" : "http:\/\/ecommerce.dexero.com\/shopping\/testforms\/testforms\/event\/test_event_checkin\/Detail.view",
        "url_key" : "test_event_checkin",
        "available_places" : -14,
        "sold_places" : 24,
        "description_short" : "Performing Arts, Comedy",
        "start_date" : "2012-04-19T14:00:00-04:00",
        "end_date" : "2012-04-19T20:00:00-04:00",
        "timezone" : "America\/Montreal",
        "capacity" : 10,
        "logo" : "http:\/\/ecommerce.dexero.com\/repository\/testforms\/testforms\/logo\/logo_2.png",
        "venue" : {
          "title" : "Players Theatre",
          "address" : "McGill Student Services Building",
          "address_2" : "3480 McTavish, 3rd Floor",
          "city" : "Montreal",
          "iso_country" : "CA",
          "iso_region" : "CA-QC",
          "phone_number" : "",
          "phone_number_2" : "",
          "postal_code" : "H3A-1X9",
          "map_point_url" : "http:\/\/maps.google.com\/maps?q=H3A-1X9&hl=en&ll=45.503189,-73.576984&spn=0.022017,0.055747&sll=37.0625,-95.677068&sspn=50.51141,114.169922&hnear=Montreal,+Quebec+H3A+1X9,+Canada&t=m&z=15"
        }
      },
      {
        "id" : 3,
        "name" : "Test create event",
        "url" : "http:\/\/ecommerce.dexero.com\/shopping\/testforms\/testforms\/event\/test_create_event\/Detail.view",
        "url_key" : "test_create_event",
        "available_places" : 12,
        "sold_places" : 0,
        "start_date" : "2012-05-16T00:00:00-04:00",
        "end_date" : "2012-05-16T23:59:59-04:00",
        "timezone" : "America\/Montreal",
        "capacity" : 12,
        "venue" : ""
      }
    ]
  }
}

Response Object "Event"

Field Data Type Description
id long The unique identifier of the event. The ID is automatically generated and can not be changed.
name string The name of the event.
url string The URL of the details of the event
url_key string The url key "unique identifier"
available_places int The number of places available.
sold_places int The number of tickets sold.
description_short string The short description of the event.
description_full text The full description of the event.
start_date Date ISO-8601 Start date.
end_date Date ISO-8601 End date.
timezone string The timezone of the event.
capacity int The maximum number of participants.
logo string The url of the logo.
venue EventVenue Event venue.
products list<Product> The list of products related to the event

Response Object "EventVenue"

Field Data Type Description
title string The title of the site.
address string The address line 1.
address_2 string The address line 2.
city string The city.
iso_country string The ISO country code.
iso_region string The ISO code of the region.
phone_number string Telephone number.
phone_number_2 string The second phone number.
postal_code string The zip code.
fax_number string The fax number.
map_point_url string URL of the Google map.


Pagination information

Property Description
totalResults The total number of elements in the list.
startIndex The offset starting point (0-based) to return the first object in the list. The default value is 0.
itemsPerPage The total number of items per page.
pageCount The number of pages.