Offres

APIDescription
GET Offres?pageIndex={pageIndex}&pageSize={pageSize}&ST_CODE={ST_CODE}&DATE_DEBUT={DATE_DEBUT}&DATE_FIN={DATE_FIN}&AGE={AGE}&ID_SUPPORT={ID_SUPPORT}&ID_PRESTA={ID_PRESTA}&MAXPRICE={MAXPRICE}&LABEL_ID={LABEL_ID}

Retourne la liste de toutes les offres filtrées selon les recherches spécifiées (tous les paramètres sont optionnels et les retours peuvent être paginés)

GET Offres/Supports

Retourne La liste des supports et leurs ID à fournir lors de la création d'offre.

GET Offres/Prestations

Retourne La liste des prestations et leurs ID à fournir lors de la création d'offre.

GET Offres/{IdOffre}

Retourne le détail d'une offre par son id.

GET Structures/{st_Code}/Offres

Retourne la liste des Offres proposées pour une structure donnée.

POST Offres/Create

Crée une nouvelle offre dans l'API.

DELETE Offres/{IdOffre}

Supprime une offre par son ID. Ne fonctionne que pour les offres créés par le même clef API.

healthCheck

APIDescription
GET Healthcheck

Méthode pour savoir si le service est up

POST Whoami

Progression

Dédié à la gestion, modification, lecture du Carnet de Progression FFVoile

APIDescription
GET Progression?licence={licence}

No documentation available.

GET Progression/{NoLicence}/all

No documentation available.

GET Progression/{NoLicence}

No documentation available.

GET Progression/images/{image}

Retourne l'image du niveau associé (appeler sous la forme niveau-{id})

Classements

APIDescription
GET Ranking/{CodeBateau}/{Annee}

No documentation available.

Licencies

APIDescription
GET Licencies/Recherche?Nom={Nom}&Prenom={Prenom}&Naissance={Naissance}&Sexe={Sexe}

Permet de rechercher un licencié actif à partir de son quadruplet pour valider son numéro de licence. La recherche se fait à partir du nom et prénom approché, avec une tolérance d'erreur de faute DUPOND Jean-Pierre == DUPPOND Jean Piere.

GET Licencies/{NoLicence}/Completion

Permet de récupérer les informations d'un sportif à partir de son numéro de licence pour préremplissage de formulaire

GET Licencies/{NoLicence}/PDF

Permet de recupérer le support de licence d'un licencié actif au format PDF

GET Licencies/{NoLicence}/PNG

Permet de recupérer le support de licence d'un licencié actif au format PNG

POST Licencies/{NoLicence}/Login

Permet d'authentifier un licencié à partir de son no_licence / password FFVoile pour récupérer ses informations

GET Licencies/{NoLicence}/Details

Permet de fournir des informations détaillées relatives à un sportif. Route soumise à consentement et header Authorization-Ruid associé.

GET Licencies/{NoLicence}/Resultats

Permet de récupérer les résultats de régate des 12 derniers mois d'un sportif

GET Licencies/{NoLicence}/Palmares

Permet d'obtenir le palmares sportif d'un licencié

GET Licencies/{NoLicence}/ProfilHN

Permet de récupérer le profil Haut Niveau d'un licencié FFVoile

GET Licencies/{NoLicence}/Fonctions

Permet de récupérer les fonctions actives détenues par un licencié

GET Licencies/{NoLicence}/IsTiersEnabled?Email={Email}

Permet de savoir si la personne a donné son accord pour que la solution utilise ses données

POST Licencies/{NoLicence}/AskForConsent?Email={Email}

Demande d'accord à un licencié pour que la solution utilise ses données. Nécessite un header Authorization-Ruid comme identifiant unique du compte utilisateur dans la solution distante.

POST Licencies/{NoLicence}/RevokeConsent

Révocation de l'accord d'un licencié pour que la solution utilise ses données.

Regates

APIDescription
GET CodeBateau/{Discipline}

Listage des code bateaux à partir de la discipline

GET OSIRIS

Permet de récupérer la liste complète des certificats OSIRIS en cours de validité ou périmées depuis mois de 1 mois

GET OSIRIS/{NumVoile}

Permet la récupération des informations d'un certificat OSIRIS à partir de son numéro de voile

Calendrier

APIDescription
GET Competitions/Structure/{StCode}?pageIndex={pageIndex}&pageSize={pageSize}

Permet d'obtenir les informations des compétitions à venir pour un club (paginé).

GET Competitions/{CoId}

Permet d'obtenir les informations d'une compétition précise.

GET Competitions/{CoId}/Epreuves

Permet d'obtenir les informations des épreuves appartenant à une compétition précise.

GET Epreuves?pageIndex={pageIndex}&pageSize={pageSize}

Permet d'obtenir les informations de toutes les épreuves à venir. Retourne par défaut les 30 prochaines épreuves.

GET Epreuves/Structure/{StCode}?pageIndex={pageIndex}&pageSize={pageSize}

Permet d'obtenir les informations des épreuves à venir pour un club (paginé). Retourne par défaut les 30 prochaines épreuves.

GET Epreuves/{DateDebut}/{DateFin}/{StCode}?NiveauCode={NiveauCode}&Limite={Limite}

Permet d'obtenir les informations des épreuves entre 2 dates bornes. Optionnellement pour un club en particulier. Méthode limitée à 50 réponses par défaut.

GET Epreuves/{EpId}

Permet d'obtenir les informations d'une épreuve précise.

GET Epreuves/{EpId}/Invites

Permet de connaitre la liste des invités sur une épreuve fermée

GET Epreuves/{EpId}/Invites/{NoLicence}

Permet de savoir pour une épreuve fermée si le licencie est invité à s'inscrire ou pas

GET Epreuves/{EpId}/Modeles

Permet de récupérer la liste des modèles de bateau pouvant s'inscrire à une épreuve. Particulièrement dans le cas de l'intersérie pour proposer une droddown des modèles à disposition.

POST Plannings/{UserId}/Vues/{ViewId}/{ViewAlias}

Permet de mémoriser une session d'une vue planning FFVoile pour un utilisateur donné

GET Plannings/{UserId}/Vues

Permet de restituer la liste des sessions de vue planning FFVoile pour un utilisateur donné

Structures

APIDescription
GET Structures/{StCode}/Structures?pageIndex={pageIndex}&pageSize={pageSize}

Permet d'obtenir les informations de toutes les sous-structures FFVoile actives de la structure transmise (paginé).

GET Structures/{StCode}

Permet d'obtenir toutes les informations pour une structures FFVoile active.

GET Structures/{StCode}/Labels

Permet d'obtenir tous les Labels pour une structures FFVoile active.

GET Structures/{StCode}/Images

Permet d'obtenir les images d'illustration de la structure, mis en ligne par la structure elle-même via ses outils de gestion FFVoile.

GET Structures/{StCode}/IsTiersEnabled

Permet de savoir si un tiers peu agir au nom de la structure

GET Structures/{StCode}/Emplois

Permet d'obtenir toutes les annonces emplois publiées par la structure ou ses sous-structures.

GET Structures?pageIndex={pageIndex}&pageSize={pageSize}

Permet d'obtenir les informations de toutes les structures FFVoile actives (paginé).

Identifications

APIDescription
POST Identifications/{Identifiant}/Login

Méthode de vérification de couples identifiant / password pour l'authentification.

GET Identifications/{Identifiant}/Token

Méthode de génération d'un Token depuis un utilisateur connecté

GET Identifications/Token/{token}

Méthode de récupération d'un utilisateur à partir d'un Token