Skip to content

Réserver un cours

Le scénario est le suivant : une application à destination des membres du club affiche le planning de la semaine et permet de réserver une place sur un cours et de l'annuler.

Suivez au préalable la documentation permettant de récupérer le planning.

Une fois le cours identifié, il ne reste plus qu'à déclarer la participation d'un contact. Une inscription sera alors automatiquement reversée au regard des places disponibles :

  • dans la liste principale des inscrits au cours
  • dans la liste d'attente servant de débord à la liste principale
  • dans la liste des refus une fois la liste d'attente pleine

Il est possible de prédire l'arrivée avec les données du cours.

Faire une requête POST à l'API Resamania comme suit :

https://{api_base_url}/{client_token}/attendees/

Body

json5
{
    "classEvent": "{class_event_id}",
    "contactClubId": "{club_id}",
    "contactCreatedAt": "{created_at}",
    "contactFamilyName": "{family_name}",
    "contactGivenName": "{given_name}",
    "contactId": "{contact_id}",
    "contactNumber": "{contact_number}",
    "contactPictureId": "{picture_id}"
}
paramètredescription
api_base_urlL'url de l'API que vous souhaitez utiliser. Celle-ci varie selon les environnements d'intégration et de production
client_tokenChaque chaîne de club possède son identifiant Resamania appelé client_token
class_event_idIdentifiant textuel du cours auquel ajouter l'inscription. Il est de la forme /{client_token}/class_events/{id}
club_idIdentifiant textuel du club du contact qui participera au cours.
created_atDate de création du contact qui participera au cours
family_nameNom de famille du contact qui participera au cours
given_namePrénom du contact qui participera au cours
contact_idIdentifiant textuel du contact qui participera au cours
contact_numberNuméro de membre du contact qui participera au cours
picture_idIdentifiant textuel de la photo de profil du contact.

Annuler une réservation

L'annulation de réservation se traduit par un changement d'état et non une suppression "physique" de la réservation.

Faire une requête POST à l'API Resamania comme suit :

https://{api_base_url}/{client_token}/attendees/{attendee_id}/transitions

Body

json5
{
    "transition": "cancel"
}
paramètredescription
api_base_urlL'url de l'API que vous souhaitez utiliser. Celle-ci varie selon les environnements d'intégration et de production
client_tokenChaque chaîne de club possède son identifiant Resamania appelé client_token
attendee_idIdentifiant de la réservation à annuler

Liste des erreurs que vous pouvez rencontrer

Lors du process de réservation et d'annulation de réservation, plusieurs règles métiers configurées par le client peuvent interdire la prise de réservation ou son annulation. Voici la liste des codes erreurs que vous pourrez rencontrer et leur définition :

Code erreurDescription
api.error.attendee.event-in-the-pastLa date de début du cours est déjà passée.
api.error.attendee.already-attendingVous êtes déjà inscrit au cours.
api.error.attendee.contact-attendees-blockedVous n'avez plus le droit de réserver
api.error.attendee.contact-debtRéservation impossible car vous avez une dette à régler
api.error.attendee.no-unitsVous n'avez pas de carnet.
api.error.attendee.no-valid-counter-creditVous n'avez pas de carnet pour cet événement avec suffisamment de crédit.
api.error.attendee.no-valid-counter-typeVous n'avez pas de carnet qui corresponde à cet événement.
api.error.attendee.no-valid-tagVous n'avez pas d'abonnement qui corresponde à cet événement.
api.error.attendee.is-suspendedRéservation impossible car votre abonnement est suspendu à cette date
api.error.attendee.limit-reachedIl n'y a plus de place disponible pour cet événement.
api.error.attendee.limitVous avez dépassé le nombre de réservation autorisée.
api.error.attendee.anticipationLe délai d'anticipation n'est pas respecté.
api.error.attendee.automatic-rejectLe cours n'accepte pas de réservation.
api.error.attendee.club-restrictionVous n'avez pas d'abonnement ou de carnet vous permettant de réserver un cours dans ce club.
api.error.attendee.coach-restrictionVous n'avez pas d'abonnement ou de carnet vous permettant de réserver un cours avec ce coach.
api.error.attendee.deadlineLa deadline n'est pas respectée.
api.error.attendee.delay-exceedLe délai d'annulation de réservation n'est pas respecté.
api.error.attendee.missing-mandateRéservation impossible car vous n'avez pas de mandat valide
api.error.attendee.no-counters-with-ruleVous n'avez pas de carnet qui corresponde à cet événement.
api.error.attendee.no-tags-with-ruleVous n'avez pas d'abonnement qui corresponde à cet événement.
api.error.attendee.no-tagsVous n'avez pas d'abonnement.
api.error.attendee.online.limitLe nombre d'inscription ne permet plus l'inscription en ligne
api.error.attendee.period-restrictionLa restriction horaire n'est pas respectée.
api.error.attendee.studio-restrictionVous ne pouvez pas vous inscrire à cet événement.
api.error.attendee.tags-and-countersVous n'avez pas d'abonnement ou pas de carnet.
api.error.attendee.tags-or-countersVous n'avez ni abonnement ni carnet valide pour la réservation.
api.error.attendee.unable-to-debitImpossible de débiter le(s) carnet(s) actuellement