Interface service Web REST

GET events

Mis à jour, 2014-22-12 16:14

Retourne une liste des évenements disponible.

Information sur la ressource

Taux limité ? Non
Authentification Facultatif
Formats de réponse json,xml
Methodes HTTP GET
Objet de réponse list<Event>

URL de la ressource

https://ecommerce.dexero.com/service/rest/2/marchand/catalogue/events.format

Paramètres

Paramètre Description
count Indique le nombre d'enregistrements à récupérer. La valeur par défaut 20.
Exemple de valeur : 30
offset Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0.
Exemple de valeur : 20
page La page de valeurs à récupérer.
Exemple de valeur : 6
sort_key Le champ sur lequel trier les résultats retournés. Si le champ n'est pas présent sur une entrée, la valeur de chaîne vide est utilisée. La valeur par défaut est le nom.
Exemple de valeur : name , id, date
sort_dir La direction de triage des resultats. La valeur par défaut est asc.
Exemple de valeur : asc, desc
locale Langue de retour de l'événement
Exemple de valeur : fr, en
start_date Filtres des objets retournés par leur horodatage. Seuls les objets qui ont un horodatage qui est >= start_date seront retournés. Le format date est formatée ISO-8601
Exemple de valeur : 2011-11-25T15:58:50-05:00
product_image_size Grandeur de l'image de produit retourné
Exemple de valeur : 80 , 80x90
include_products Lorsqu'il est réglé à true ou 1, chaque événement comprendra un nœud appelé «products» qui contient la liste des produits associés. La valeur par défaut est false
Exemple de valeur : true

Exemple de requête

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

Exemple de réponse

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" : ""
      }
    ]
  }
}

Objet de réponse "Event"

Champ Type de donnée Description
id long Le numéro d'identification unique de l'événement . L'ID est généré automatiquement et ne peut pas être changé .
name string Le nom de l'événement.
url string L'adresse URL du détail de l'événement
url_key string La clé url "identifiant unique"
available_places int Le nombre de places disponibles.
sold_places int Le nombre de places vendues.
description_short string La description courte de l'événement.
description_full text La description complète de l'événement.
start_date Date ISO-8601 Date de début.
end_date Date ISO-8601 Date de fin.
timezone string Le fuseau horaire de l'événement.
capacity int Le nombre maximal de participants.
logo string L'adresse url du logo.
venue EventVenue Lieu de l'événement.
products list<Product> La liste des produits reliés à l'événement

Objet de réponse "EventVenue"

Champ Type de donnée Description
title string Le titre du lieu.
address string L'adresse ligne 1.
address_2 string L'adresse ligne 2.
city string La ville.
iso_country string Le code iso de pays.
iso_region string Le code iso de la région.
phone_number string Le numéro de téléphone.
phone_number_2 string Le deuxième numéro de téléphone.
postal_code string Le code postale.
fax_number string Le numéro de fax.
map_point_url string URL de la carte Google.


Information de pagination

Propriété Description
totalResults Le nombre total d'éléments dans la liste.
startIndex Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0.
itemsPerPage Le nombre total d'éléments par page.
pageCount Le nombre de pages.