L'API Amilia

Vous pouvez tester l'API directement dans votre navigateur. Les exemples d'appels GET fournis sont appelés en utilisant jQuery $.get. Appuyez sur F12 pour ouvrir une console de développeur et tapez les exemples d'appels GET décrits ci-dessous.

 

Il existe deux types d'API disponibles, qui renvoie JSON:

  • Appels publics ouverts: informations accessibles au public sur votre page boutique; et
  • Appels authentifiés: (nécessite un jeton): Informations accessibles aux titulaires de compte Amilia signés.

Limite de taux

Vous ne pouvez effectuer qu'un certain nombre d'appels à notre API par seconde pour une adresse IP donnée. Notre valeur par défaut sera 100 et nous pourrions modifier cela à l'avenir, mais ne vous inquiétez pas si votre page Web appelle Ajax du navigateur du client. Si vous atteignez cette limite, vous recevrez un code statut HTTP 429. Attendez un peu avant de passer vos prochains appels.

 

Appels d'API authentifiés <authenticated>

Certains points de terminaison nécessitent une authentification, qui sont marqués avec un libellé 
<Authenticated>.

Pour avoir accès à ces points de terminaison, vous avez besoin d'un jeton pouvant être obtenu sur demande auprès de l'API (voir ci-dessous) et d'un compte Amilia valide. Le compte doit être celui d'un administrateur de l'organisation et avoir le niveau d'accès "Propriétaire du compte".

NOTE: Pour éviter des problèmes liés aux changements de personnel au sein de l'organisation, nous vous recommandons d'utiliser un compte qui n'est pas lié à une personne spécifique, mais créé spécifiquement pour accéder à l'API. Notez que le compte a toujours besoin d'un courriel valide qui servira comme nom d'utilisateur.

L'authentification de base (Basic authentification): l'utilisation d'un nom d'utilisateur et mot de passe.

L'authentification par jeton (Bearer authentification): l'utilisation d'un jeton d'authentification pour accès.

  • Comment utiliser le jeton d'authentification

Voici une exemple d'authentification par jeton en ajax: 

$.ajax(
{
url:"https://www.amilia.com/org-name/PublicApi/en/Activities/Spots",
type:"GET",
beforeSend:function(xhr)
{
xhr.setRequestHeader("Authorization", "Bearer " + token));
}
})
  • Obtenir un jeton d'authentification

/PublicApi/[Lang]/Authentication/Login

Obtenez un jeton d'authentification. Un en-tête "Authentification de base" (Basic Authentification) doit être inclus dans cette demande, avec le nom d'utilisateur et le mot de passe du compte Amilia que vous avez choisi d'utiliser pour effectuer des requêtes sur les points de terminaison d'API nécessitant une authentification.

Exemple:

Dans ajax, le rappel "beforeSend" peut être utilisé pour ajouter l'en-tête d'autorisation de base, et les informations d'identification sont incluses à l'aide du format nom d'utilisateur: mot de passe (username: password).

Notez que vous devez transmettre un nom d'utilisateur et un mot de passe valides.

$.ajax(
{
url:"https://www.amilia.com/PublicApi/en/Authentication/Login",
type:"GET",
beforeSend:function(xhr)
{
xhr.setRequestHeader("Authorization", "Basic " + btoa("jhon.doe@doe.com"+":"+"123"));
}
})

Résultat:

{
"Token": "eyJ0exxxxxxxxxxxxxxxxxxxxxxxxxxiJ9.exxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxXYkZCQ2dzTXNpTlZVUTYiLCJ1YUlkcyI6WzczNjczNjFdfQ.PlEzq9ahzprp5xlust9eOQEPL- EVxxxxxxxxxxxxxyQ"
}

 

URL de base

À travers la documentation, les données destinées à être remplacées par vos propres valeurs sont entourées de crochets ([comme ça]).

Tous les points de terminaison de l'API partagent la même URL racine: https://www.amilia.com/PublicApi/[rewriteUrl]/[lang]/.

  • rewriteUrl représente votre jeton d'organisation unique. C'est le même jeton que celui utilisé dans l'URL de votre boutique Amilia. Vous pouvez le trouver dans Amilia sous l'onglet Compte>Options.
  • lang représente la langue dans laquelle les valeurs localisables doivent être renvoyées. Les valeurs actuellement supportées sont soit fr soit en. La localisation est uniquement appliquée aux valeurs. Les noms d'attribut et les URL ne sont pas localisés.

Pagination

Certains points de terminaison font de la pagination en utilisant des curseurs, qui seront marqués avec un libellé Paged_EN.png.

Les réponses paginées doivent toutes suivre le format ci-dessous:

{ "Items": [], 
"Page": {
"NextId": int|string,
"Next": url
}
}

 Pour paginer, incluez les paramètres facultatifs suivants dans l’URL:

IMAGE_PAGINATION_FR.png

Les articles doivent contenir une liste des éléments demandés. Page.Next est censé être l'URL pour demander la page de données suivante. Ce champ est nul s'il n'y a plus de données à récupérer. Un paramètre de chaîne de requête limite peut toujours être utilisé pour contrôler la taille de la page, permettant ainsi une sorte de contrôle sur la réponse attendue.

 

Informations utilisateur enregistrées

Moi(me)

 /PublicApi/[Lang]/Me

Renvoie les informations de l'utilisateur connecté. Valable uniquement lorsque l'utilisateur est connecté.

Exemple:https://www.amilia.com/PublicApi/en/Me

Résultat:

{ "Email": "jobdoe@email.com" }

 

Liste des organisations auxquelles l'utilisateur connecté est associé  

   

Renvoie une liste des organisations où l'utilisateur connecté est un administrateur ou un membre du personnel. 

Exemple: https://www.amilia.com/PublicApi/en//Me/Organizations

Résultat:

{ {
"Id": 1029
"Logo": "https://9af8441d9955da1e6b2f-37011465e523601d5de5e52536b64028.ssl.cf2.rackcdn.com/logo1029_f8bd.jpg"
"Name": "Demo Amilia Swim"
"RewriteUrl": "demo-amilia-swim-club"
} }

 

Personnes

Lister toutes les personnes dans une programmationPaged_EN.png<authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Programs/[Id]/Persons

Répertorie toutes les personnes inscrites à une programmation donné. L'utilisateur connecté doit être un administrateur.

Exemple: https://www.amilia.com/PublicApi/org-name/en/Programs/24505/Persons

Résultat:

{
  "Items": [
{
"Id": 3456789,
"AmiliaId": "P1234567",
"FirstName": "John",
"LastName": "Doe",
"Gender": 0,
"DateOfBirth": "2000-01-01T04:00:00",
"Email": "johndoe@email.com",
"Address": null,
"IsArchived": false
},
{
"Id": 34567810,
"AmiliaId": "P234567",
"FirstName": "Jane",
"LastName": "Smith",
"Gender": 1,
"DateOfBirth": "1999-02-02T04:00:00",
"Email": "smith.j@email.net",
"Address": {
"Telephone": "1234567890",
"AddressLine1": "123 Street Rd.",
"AddressLine2": "",
"City": "City Name",
"PostalCode": "12345",
"Province": "ZX",
"Country": "US"
},
"IsArchived": false
}
],
"Page": {
"NextId": null,
"Next": null
}
}

 

Obtenir une personne <authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Persons/[Id]

Récupérer les informations détaillées d'une personne à l'aide de son identifiant. L'utilisateur connecté doit être un administrateur.

Exemple:https://www.amilia.com/PublicApi/org-name/en/Persons/3954324

Résultat:

{
"Id": 34567810,
"AmiliaId": P234567,
"FirstName": "Jane",
"LastName": "Smith",
"Gender": 0,
"DateOfBirth": "1999-02-02T04:00:00",
"Email": "smith.j@email.net",
"Address": {
"Telephone": "1234567890",
"AddressLine1": "123 Street Rd.",
"AddressLine2": "",
"City": "City Name",
"PostalCode": "12345",
"Province": "ZX",
"Country": "US"
},
"IsArchived": false
}

 

Programmations

Lister les programmations Paged_EN.png

/PublicApi/[RewriteUrl]/[Lang]/Programs

Permet de lister les programmations disponibles que vous avez définis. Les options de chaîne de requête suivantes sont disponibles:

nom d'option valeur par défaut (si pas spécifié)
archived false inclure les programmations archivées
offline false inclure  les programmations qui ne sont pas visible aux clients

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Programs?archived=false&offline=false')

Résultat:

{
"Items": [
{
"Id": 8680,
"Name": "Professional Events"
},
{
"Id": 8688,
"Name": "Recreational Events / Activities "
},
{
"Id": 9173,
"Name": "Spring Schedule: Jan 2 - April 30, 2014"
}
],
"Page": {
"NextId": null,
"Next": null
}
}

 

Obtenir une programmation par Id

/PublicApi/[RewriteUrl]/[Lang]/Programs/[Id]

Récupère la programmation associé.

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Programs/9173')

Résultat:

{
  "Id": 9173,
  "Name": "Spring Schedule: Jan 2 - April 30, 2014"
}

 

Lister les activités d'une programmation Paged_EN.png

/PublicApi/[RewriteUrl]/[Lang]/Programs/[Id]/Activities

Répertorie toutes les activités disponibles dans une programmation. La liste des activités retournées est classée par Id. Les options de chaîne de requête suivantes sont disponibles:

Grid_FR.png 

Exemple:    

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Programs/9173/Activities')

Résultat: Show_hide_EN.png

 

Lister toutes les occurrences d'une programmation <authenticated>

 /PublicApi/[RewriteUrl]/[Lang]/Programs/[Id]/Occurrences

Obtient toutes les occurrences d'une programmation donnée. Le résultat peut inclure différents états d'occurrences.

  • Normal: est prévue;
  • Sauté (Skipped): l'occurrence spécifique a été ignorée en raison d'un conflit avec un jour férié ou manuellement par un administrateur;
  • Annulé (Canceled): l'activité a été annulée, donc cet événement aussi; et
  • Archivé (Archived): l'activité a été annulée, mais il y a eu une inscription lié à cet événement.

L'URL est un lien vers la page du boutique de l'activité parente de cette occurrence. Cela peut être utile si vous souhaitez afficher les occurrences dans un calendrier et vous reporter à la page d'inscription de l'activité.

 Occurrences_of_a_PROGRAM_FR.png

Les options de début et de fin doivent être transmises en tant que paramètres de requête dans l'URL.

L'utilisateur connecté doit être un administrateur.

Exemple:

https://www.amilia.com/PublicApi/org-name/en/Programs/23456/Occurrences

https://www.amilia.com/PublicApi/org-name/en/Activities/23456/Occurrences?start=2017-09-10&end=2017-09-31

Résultat:

[
{
"Id": 9123456,
"Start": "2017-09-10T15:30:00",
"End": "2017-09-10T17:15:00",
"TimeZone": "Eastern Standard Time",
"AllDay": false,
"Url": "http://www.amilia.com/store/en/org-name/shop/activities/1234567",
"State": "Normal",
"ActivityId": 1234567,
"ActivityName": "Activity name 1"
},
{
"Id": 9234567,
"Start": "2017-09-20T15:30:00",
"End": "2017-09-20T17:15:00",
"TimeZone": "Eastern Standard Time",
"AllDay": false,
"Url": "http://www.amilia.com/store/en/org-name/shop/activities/1234568",
"State": "Skipped",
"ActivityId": 1234568,
"ActivityName": "Activity name 2"
}
]

 

 Activités

Répertoriez toutes les personnes inscrites à une activité Paged_EN.png<authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/Persons

Répertorie toutes les personnes inscrites dans une activité donnée. L'utilisateur connecté doit être un administrateur.

 Obtenir une personne inscrite à une activité Paged_EN.png<authenticated>

Reviens avec la personne si elle est inscrite à une activité. L'utilisateur connecté doit être un administrateur.

Inscrit une personne à une activité Paged_EN.png<authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/Persons

Inscrit une personne existante dans une activité donnée. Vous devez utiliser le verbe HTTP POST et transmettre cette charge utile:

{
PersonId: 12345
}

L'utilisateur connecté doit être un administrateur.

Cela créera une facture dans le compte du client et les ajoutera à la liste des participants à l'activité. Reviens avec la personne enregistrée.

Cet appel a des restrictions:

 1. L'inscription est autorisée uniquement pour les activités à 0$.
 2. Vous ne pouvez pas inscrire une personne déjà inscrite. Une erreur sera renvoyée dans ce cas.
 3. La personne doit déjà exister dans l'organisation.
 4. Les contraintes telles que l'âge, le sexe et les appartenances requises ne sont pas vérifiées. L'appel d'API permet de contourner ces règles.

 

Annule l'inscription d'une personne d'une activité Paged_EN.png<authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/Persons/[Id]

Annule une inscription existante à une activité donnée. Vous devez utiliser le verbe HTTP DELETE.

Cela créera une note de crédit du montant payé pour l'activité et supprimera la personne de la liste des participants.

Rechercher une activité par Id

/PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Activities/630191');

Résultat:

{
  "Id": 630191,
  "Name": "(C) Trapeze (Static), Rope & Tissue / 9 yrs - Teen / 5:30pm - 6:55pm / (Beg-Mixed Levels)",
  "Description": "",
  "ResponsibleName": "",
  "Prerequisite": "",
  "Note": "",
  "ExtraInformation": "",
  "Url": "https://www.amilia.com/store/en/usa-amilia-group/shop/activities/630191",
  "LegacyLocation": "",
  "PictureUrl": null,
  "Price": 38.0000,
  "Schedule": [
    {
      "StartTime": "17:30:00",
      "EndTime": "18:55:00",
      "StartDate": "2014-01-13T00:00:00",
      "EndDate": "2014-01-13T00:00:00",
      "RecurenceEndDate": null,
      "Occurences": 0,
      "Staff": [
        
      ],
      "Facilities": [
        
      ],
      "ExceptOccurences": [
        
      ],
      "Days": [
        
      ]
    }
  ],
  "Age": {
    "Max": 15,
    "Min": 9,
    "Months": false
  },
  "TaxCredit": null,
  "SpotsRemaining": 2147483647,
  "SpotsReserved": 0,
  "ShortScheduleString": "5:30 PM",
  "HasSessionEnabled": true,
  "AgeSummary": "9-15",
  "SubCategoryName": "Monday's Classes",
  "CategoryName": "Week of January 13, 2014",
  "ProgramName": "Spring Schedule: Jan 2 - April 30, 2014"
}

 

Lister toutes les occurrences d'une activité <authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/Occurrences

Obtient toutes les occurrences pour une activité donnée. Le résultat peut inclure différents états d'occurrences:

  • Normal: est prévue;
  • Skipped (Ignoré): l'occurrence spécifique a été ignorée en raison d'un conflit avec un jour férié ou manuellement par un administrateur;
  • Canceled (Annulé): l'activité a été annulée, donc cet événement aussi; et
  • Archived (Archivé): l'activité a été annulée, mais il y a eu un inscription lié à cet événement.

L'URL est un lien vers la page du boutique de l'activité donc appartient cette occurrence. Cela peut être utile si vous souhaitez afficher les occurrences dans un calendrier et vous reporter à la page d'inscription de l'activité. Occurrences_of_a_PROGRAM_FR.png

Les options de début et de fin doivent être transmises en tant que paramètres de requête dans l'URL.

L'utilisateur connecté doit être un administrateur.

Exemple:

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/Occurrences

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/Occurrences?start=2017-09-10&end=2017-09-31

[
{
"Id": 9123456,
"Start": "2017-09-10T15:30:00",
"End": "2017-09-10T17:15:00",
"TimeZone": "Eastern Standard Time",
"AllDay": false,
"Url": "http://www.amilia.com/store/en/org-name/shop/activities/1234567",
"State": "Normal",
"ActivityId": 1234567,
"ActivityName": "Activity name 1"
},
{
"Id": 9234567,
"Start": "2017-09-20T15:30:00",
"End": "2017-09-20T17:15:00",
"TimeZone": "Eastern Standard Time",
"AllDay": false,
"Url": "http://www.amilia.com/store/en/org-name/shop/activities/1234567",
"State": "Skipped",
"ActivityId": 1234567,
"ActivityName": "Activity name 1"
}
]

 

 Obtenir les inscriptions à la carte d'une activité Paged_EN.png<authenticated>

URL /PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/Spots

Obtient les inscriptions à la carte pour une activité donnée. Le serveur effectuera une itération parmi toutes les occurrences de l'activité avec le statut "Normal" ou "Archivé", et les inscriptions à la carte de ces occurrences ayant un statut autre que "Non confirmé" feront partie du résultat.Spot_occurrence_FR.png

L' option de date doit être transmise en tant que paramètre de requête dans l'URL.

L'utilisateur connecté doit être un administrateur.

Exemple:

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/Spots

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/Spots?date=2017-10-09

Résultat:

{
"Items": [
{
"Id": 2955024,
"PersonId": 3922953,
"OccurrenceId": 9105103,
"SpotStatus": "Taken"
},
{
"Id": 2955025,
"PersonId": 3922953,
"OccurrenceId": 9105105,
"SpotStatus": "Taken"
},
{
"Id": 2955026,
"PersonId": 3922953,
"OccurrenceId": 9105107,
"SpotStatus": "Taken"
}
],
"Page": {
"NextId": null,
"Next": null
}
}

 

Occurrences des activités avec inscriptions à la cartePaged_EN.png<authenticated>

URL /PublicApi/[RewriteUrl]/[Lang]/Activities/[Id]/OccurrencesWithSpots

Obtient les occurrences pour une activité donnée et inclut les inscriptions à la carte pour chaque occurrence.

Spot_occurrence_FR.png

L' option de date doit être transmise en tant que paramètre de requête dans l'URL.

L'utilisateur connecté doit être un administrateur.

Exemple:

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/OccurrencesWithSpots

https://www.amilia.com/PublicApi/org-name/en/Activities/12345678/OccurrencesWithSpots?date=2017-10-09

Résultat:

{
"Items": [
{
"Id": 9105103,
"StartDateTime": "2017-09-18T15:30:00",
"EndDateTime": "2017-09-18T17:15:00",
"Spots": [
{
"Id": 2955024,
"PersonId": 3922953,
"OccurrenceId": 9105103,
"SpotStatus": "Taken"
},
{
"Id": 3014093,
"PersonId": 3985142,
"OccurrenceId": 9105103,
"SpotStatus": "Taken"
}
]
},
{
"Id": 9105105,
"StartDateTime": "2017-09-25T15:30:00",
"EndDateTime": "2017-09-25T17:15:00",
"Spots": [
{
"Id": 2955025,
"PersonId": 3922953,
"OccurrenceId": 9105105,
"SpotStatus": "Taken"
},
{
"Id": 3032095,
"PersonId": 3985142,
"OccurrenceId": 9105105,
"SpotStatus": "Taken"
}
]
},
{
"Id": 9105106,
"StartDateTime": "2017-09-28T15:30:00",
"EndDateTime": "2017-09-28T17:15:00",
"Spots": [
{
"Id": 3032096,
"PersonId": 3985142,
"OccurrenceId": 9105106,
"SpotStatus": "Archived"
}
]
}
],
"Page": {
"NextId": null,
"Next": null
}
}

 

Occurrences

Obtenir une occurrence

/PublicApi/[RewriteUrl]/[Lang]/Occurrences/[Id]

Obtient les informations de base d'une occurrence donné.

Exemple:

http://www.amilia.localhost/PublicApi/org-name/en/Occurrences/12345678

Résultat:

{
"Id": 12345678,
"Start": "2017-09-10T15:30:00",
"End": "2017-09-10T17:15:00",
"TimeZone": "Eastern Standard Time",
"State": "Normal"
"AllDay": false,
"Url": "http://www.amilia.com/store/en/org-name/shop/activities/1234567",
"ActivityId": 1234567,
"ActivityName": "Activity name 1"
}

 

Créer une occurrence <authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Occurrences/

Crée une nouvelle occurrence pour une activité donnée. Vous devez utiliser le verbe HTTP POST et transmettre cette charge utile:

{
"ActivityId": 1635890,
"Start": "2018-08-02 18:45:00",
"End": "2018-08-02 19:45:00",
"AllDay": false,
"Facilities": [
{Id: 15382}
]
}

Où 'ActivityId' est l'activité dans laquelle on ajoute l'occurrence. L'occurrence doit avoir des dates de début(Start) et de fin (End) logiques (la fin doit être après le début). Pour une occurrence d'une journée entière, définissez l'indicateur AllDay sur true. Si omis sera faux (False). Vous pouvez éventuellement transmettre un identifiant de plateau (Facility Id) via Facilities en utilisant la signature exacte indiquée ci-dessus. Bien qu’il prenne une liste d’objets, un seul plateau est actuellement prise en charge. Si vous essayez de passer plus d'un plateau, un code d'erreur 400 sera renvoyé.

L'utilisateur connecté doit être un administrateur. Un membre du personnel ne peut pas créer une occurrence.

 

Liste de Présence

Obtenir la liste de présence d'une occurrence <authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Occurrences/[Id]/PersonAttendance

 Obtient une liste de présence des personnes inscrites à cette occurrence. Renvoie une liste de personnes avec leur statut de présence et une liste de valeurs définies par l'utilisateur. Le statut de présence a des valeurs possibles de Aucune (None) et Présent.

L'utilisateur connecté doit être un administrateur ou un membre du personnel.

Exemple:

http://www.amilia.localhost/PublicApi/org-name/en/Occurrences/1234/PersonAttendance

Résultat:

[
{
Id: 43037,
AmiliaId: "P1223",
SegmentId: 1234,
FirstName: "Étienne",
LastName: "Cardinal",
UpdatedOn: "2018-04-19T01:50:22.937",
Status: "None",
Values: [ ],
},
{
Id: 31194,
AmiliaId: "P1173",
SegmentId: 1234,
FirstName: "Jaëlle",
LastName: "Tremblay",
UpdatedOn: "2018-04-19T01:50:22.937",
Status: "Present",
Values: [ "GOAL" ],
}
]

 

Obtenir la liste de présence d'une personne <authenticated>

 /PublicApi/[RewriteUrl]/[Lang]/Occurrences/[Id]/PersonAttendance/[Id]

Obtient la présence d'une seule personne fournie avec l'identifiant de la personne.

L'utilisateur connecté doit être un administrateur ou un membre du personnel.

 

Mettre à jour la liste de présence d'une personne <authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Occurrences/[Id]/PersonAttendance/[Id]

Met à jour la liste de présence d'une personne pour une occurrence donné. Vous devez utiliser le verbe HTTP PUT pour transmettre JSON au serveur. Les attributs que vous pouvez modifier sont les suivants:

  • Status (Statut): Les valeurs possibles sont "None" ou "Present". Les autres valeurs donneront la valeur "None" (Aucune).
  • Values (Valeurs): Une liste de chaînes définies par l'utilisateur à ranger avec la présence de la personne. Peut être utilisé pour les métadonnées telles que le suivi des scores. Par exemple, vous pouvez passer ["GOAL", "GOAL", "ASSIST"] pour indiquer deux buts et un assist.

Les attributs UpdatedOn seront automatiquement modifiés à la date et à l'heure actuelles. Les autres attributs seront ignorés. Renvoie le record avec un mis à jour.

L'utilisateur connecté doit être un administrateur ou un membre du personnel.

 

Laissez-passer

Obtenir le laissez-passer d'un client <authenticated>

 /PublicApi/[RewriteUrl]/[Lang]/Multipasses/[Id]

Obtient les informations de base d'un laissez-passer donné, par Id.

NOTE: Ceci correspond au laissez-passer d'un client. Le client associé peut utiliser le nombre restant de passes (le cas échéant) sur un laissez-passer pour réserver à la carte.

Pour examiner les laissez-passer du point de vue de l'organisation (c'est-à-dire visualiser et éditer les laissez-passer pouvant être achetés dans la boutique, ainsi que le prix, le délai d'expiration, etc.), visitez le site Web d'Amilia.

L'utilisateur connecté doit être un administrateur.

Exemple:

http://www.amilia.localhost/PublicApi/org-name/en/Multipasses/12345678

Résultat:

{
"Status": "Active",
"Id": 12345678,
"Name": "5 Class Pack",
"NbTokens": 3,
"HasUnlimitedTokens": false,
"EffectiveDate": null,
"ExpirationDate": "2018-10-08T00:00:00",
"IsEffective": true,
"IsExpired": false,
"IsUsable": true
}

 

Obtenir les laissez-passer de tous les clients dans une organization Paged_EN.png<authenticated>

/PublicApi/[RewriteUrl]/[Lang]/Multipasses

Obtient les occurrences pour une activité donnée et inclut les taches pour chaque occurrence.

client_multipasses_image_10.png

 L'utilisateur connecté doit être un administrateur.

Exemple:

https://www.amilia.com/PublicApi/org-name/en/Multipasses

https://www.amilia.com/PublicApi/org-name/en/Multipasses?onlyIncludeUsable=true

Résultat:

{
"Items": [
{
"Status": "Active",
"Id": 123,
"Name": "1 Class",
"NbTokens": 1,
"HasUnlimitedTokens": false,
"EffectiveDate": null,
"ExpirationDate": "2017-09-26T00:00:00",
"IsEffective": true,
"IsExpired": true,
"IsUsable": false
},
{
"Status": "Active",
"Id": 456,
"Name": "20 Class Pack",
"NbTokens": 18,
"HasUnlimitedTokens": false,
"EffectiveDate": null,
"ExpirationDate": "2018-08-25T00:00:00",
"IsEffective": true,
"IsExpired": false,
"IsUsable": true
},
{
"Status": "Active",
"Id": 789,
"Name": "1 Class",
"NbTokens": 0,
"HasUnlimitedTokens": false,
"EffectiveDate": null,
"ExpirationDate": "2017-10-26T00:00:00",
"IsEffective": true,
"IsExpired": true,
"IsUsable": false
},
],
"Page": {
"NextId": null,
"Next": null
}
}

 

Étiquettes

Liste des étiquettes disponibles.

/PublicApi/[RewriteUrl]/[Lang]/Tags

Répertorie toutes les étiquettes définies pour votre organisation.

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Tags')

Résultat:

[
  {
    "Id": 1051050,
    "Name": "Art",
    "Color": "orange",
    "Icon": null
  },
  {
    "Id": 1085084,
    "Name": "Sports",
    "Color": "green",
    "Icon": null
  },
  {
    "Id": 1085085,
    "Name": "Circus",
    "Color": "red",
    "Icon": null
  }
]

 

Obtenir une étiquette par Id

 /PublicApi/[RewriteUrl]/[Lang]/Tags/[Id]

Obtient une étiquette par Id. 

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Tags/1051050')

Résultat: 

{
  "Id": 1051050,
  "Name": "Art",
  "Color": "orange",
  "Icon": null
}

 

Obtenir la liste d'activités qui ont l'étiquette donnée

 /PublicApi/[RewriteUrl]/[Lang]/Tags/[Id]/Activities?v2

Récupère la liste des activités pour une étiquette donnée.Ceci est utilisé pour donner un contrôle précis sur un groupe d'activités lorsque la structure du programmation n'est pas idéale.

NOTE: Il existe deux versions de cette API. Nous suggérons fortement d'utiliser la version2 (v2) 

 car nous prévoyons de déprécier la première version à l'avenir.

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Tags/1051050/Activities?v2')

Résultat:  Show_hide_EN.png

 

Évènements

Obtenir la liste des activités pour les programmations actifs

/PublicApi/[RewriteUrl]/[Lang]/Events[?start=date[&end=date]][&programId=ID][&showHidden=true]

Récupère tous les occurrences d'activité survenant dans les programmations actifs, pour la plage de dates donnée. Les arguments START (début) et END (fin) sont des dates au format AAAA-MM-JJ. Si END (fin( est omis, ne récupère que pendant un jour spécifié par START (début). Lorsque le début et la fin sont omis, renvoie les événements d'aujourd'hui. Vous pouvez également limiter la recherche à une programmation donnée à l'aide de l'argument PROGRAMID. Vous pouvez lister les activités cachées en passant à showHidden = true. Cet appel est utile pour créer un calendrier. La sortie est compatible avec FullCalendar.

NOTE: Pour des raisons de performances, la plage de dates est limitée à 50 jours, ce qui suffit pour couvrir une vue mensuelle dans FullCalendar.

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Events?start=2013-10-28');

Résultat:

[
  {
    "Id": 1051050,
    "Name": "Art",
    "Color": "orange",
    "Icon": null
  },
  {
    "Id": 1085084,
    "Name": "Sports",
    "Color": "green",
    "Icon": null
  },
  {
    "Id": 1085085,
    "Name": "Circus",
    "Color": "red",
    "Icon": null
  }
]

NOTE:  L'attribut Location a été remplacé par Facilities (Plateaux). L'attribut Location sera supprimé, veuillez donc mettre à jour votre code.

 

 Plateaux

/PublicApi/[RewriteUrl]/[Lang]/Facilities

 Répertorie tout les plateaux définies par votre organisation.

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Facilities')

 Résultat:

[
  {
    "ParentId": 0,
    "Description": "Centre sportif principal",
    "State": "Normal",
    "Id": 606,
    "Name": "Centre Sportif",
    "Address": {
      "Latitude": null,
      "Longitude": null,
      "Telephone": "",
      "AddressLine1": "",
      "AddressLine2": "",
      "City": "",
      "ZipPostalCode": "",
      "StateProvince": "",
      "Country": ""
    }
  },
  {
    "ParentId": 606,
    "Description": null,
    "State": "Normal",
    "Id": 1313,
    "Name": "Aile A",
    "Address": {
      "Latitude": null,
      "Longitude": null,
      "Telephone": "",
      "AddressLine1": "",
      "AddressLine2": "",
      "City": "",
      "ZipPostalCode": "",
      "StateProvince": "",
      "Country": ""
    }
  },
  {
    "ParentId": 606,
    "Description": null,
    "State": "Normal",
    "Id": 1314,
    "Name": "Aile B",
    "Address": {
      "Latitude": null,
      "Longitude": null,
      "Telephone": "",
      "AddressLine1": "",
      "AddressLine2": "",
      "City": "",
      "ZipPostalCode": "",
      "StateProvince": "",
      "Country": ""
    }
  }
]

 

Obtenir un plateau par Id

 /PublicApi/[RewriteUrl]/[Lang]/Facilities/[Id]

Obtenir un plateau par Id.

Exemple:

$.get('https://www.amilia.com/PublicApi/usa-amilia-group/en/Facilities/606')

Résultat:

{
  "ParentId": 0,
  "Description": "Centre sportif principal",
  "State": "Normal",
  "Id": 606,
  "Name": "Centre Sportif",
  "Address": {
    "Latitude": null,
    "Longitude": null,
    "Telephone": "",
    "AddressLine1": "",
    "AddressLine2": "",
    "City": "",
    "ZipPostalCode": "",
    "StateProvince": "",
    "Country": ""
  }
}

Cet article est mis à jour lorsque de nouveaux appels sont créés. Vous pouvez vérifier à votre convenance ou suivre cette page!

Vous avez d’autres questions ? Envoyer une demande

0 Commentaires

Veuillez vous connecter pour laisser un commentaire.