Interface service Web REST

GET events/{id}/attendes

Mis à jour, 2012-06-19 14:28

Retourne la liste des participants à un événement.

Information sur la ressource

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

URL de la ressource

https://ecommerce.dexero.com/service/rest/2/marchand/catalogue/events/{id}/attendes.format

Paramètres

Paramètre Description
id L'identifiant système de l'événement.
Exemple de valeur : 381
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

Exemple de requête

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

Exemple de réponse

XML JSON 
{
  "attendees" : {
    "totalResults" : 3,
    "startIndex" : 0,
    "itemsPerPage" : 20,
    "pageCount" : 1,
    "attendee" : [
      {
        "title" : "1, 1",
        "extra_info" : [
          {
            "label" : "Email",
            "value" : "info+ecom@dexero.com",
            "position" : 2
          },
          {
            "label" : "Company",
            "value" : "Dexero",
            "position" : 3
          }
        ]
      },
      {
        "title" : "3, 2",
        "extra_info" : [
          {
            "label" : "Email",
            "value" : "info+ecom@dexero.com",
            "position" : 2
          },
          {
            "label" : "Company",
            "value" : "Dexero",
            "position" : 3
          }
        ]
      },
      {
        "title" : "3, 3",
        "extra_info" : [
          {
            "label" : "Email",
            "value" : "info+ecom@dexero.com",
            "position" : 2
          }
        ]
      }
    }
  ]
}
}

Objet de réponse "Attendee"

Champ Type de donnée Description
title string Le titre
extra_info list<ExtraInfo> Liste d'informations complémentaires sur le participant.

Objet de réponse "ExtraInfo"

Champ Type de donnée Description
label string Le label.
value string La valeur de l'information.
position int La position de l'élément dans la liste.

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.