WS Optipro - Aide API

Create a glasses order from the Smart Kiosk. Recevoir les infos de prescription ,monture, lentille et succursale et retourner une valeur de statut

Paramètres reçus

- Clé de l'API

- Code client lunetterie

- Code succursale

- Prescription

o Sphère(OD / OS)

o Cylindre(OD / OS)

o Axe(OD / OS)

o Addition(OD / OS)

o Vertex(OD / OS)

o Acuité visuelle (OD/OS)

o Prisme 1 (OD/OS)

o Base prisme 1 (OD/OS)

o Prisme 2 (OD/OS)

o Base prisme 2 (OD/OS)

o Balance(OD / OS)

o Image prescription (pour imagerie)

- Code monture fournisseur

- Code lentille Opti-Pro

1 Returned value (integer) :

0 - Successful Order

1 - Store Id invalid

2 - Store connection error

3 - Client Id invalid

4 - Frame Id invalid

5 - Lens Id invalid

6 - Error saving the exam

7 - Error when registering the order

8 - Non-existent resource code when saving the imagery

9 - Imaging Type not found

10 - Error saving the imaging

11 - Invalid API Key

12 - Invalid CSV file

POST: wsoptipro/InscriptLunette

Create a glasses order from Glasses Gallery. Receieve prescription,frames,lens and store infos from a CSV file encoded in Base64. The webservice returns a single status value

Received parameters

- API Key

- Order id

- String of the encoded CSV file

1 Returned value (integer) :

0 - Successful Order

1 - Store Id invalid

2 - Store connection error

3 - Client Id invalid

4 - Frame Id invalid

5 - Lens Id invalid

6 - Error saving the exam

7 - Error when registering the order

8 - Non-existent resource code when saving the imagery

9 - Imaging Type not found

10 - Error saving the imaging

11 - Invalid API Key

12 - Invalid CSV file

POST: wsoptipro/CreateGlassesFileGG

Create an order from the shopping cart. Receieve prescription,frames,lens and store infos from a CSV file encoded in Base64. The webservice returns a single status value

Received parameters

- API Key

- Order id (filename)

- String of the encoded CSV file

1 Returned value (integer) :

0 - Successful Order

1 - Store Id invalid

2 - Store connection error

3 - Client Id invalid

4 - Frame Id invalid

5 - Lens Id invalid

6 - Error saving the exam

7 - Error when registering the order

8 - Non-existent resource code when saving the imagery

9 - Imaging Type not found

11 - Invalid API Key

12 - Invalid CSV file

POST:/CreateGlassesFilePA

Create an exam. Receieve infos from a CSV file encoded in Base64. The webservice returns a single status value

Received parameters

- API Key

- StoreCode: Store code

- PatientHCN: Patient's health insurance number

- OptoProfCode: Professional code of the optometrist

- String of the encoded CSV file

1 Returned value (integer) :

0 - Exam file succesfully created

1 - Store not found

2 - Store connection error

3 - Patient not found

4 - Error saving the exam file

11 - Invalid API Key

12 - Invalid CSV file

POST:/CreateExam

Fonctions qui recoit le code de la monture et retourne la quantité disponible en inventaire. Si erreur la fonction retourne -999

Paramètres reçus

- Clé de l'API

- Code monture fournisseur

1 Returned value (integer) :

If successful Qty in stock

if error code -999 is returned

POST: /GetQteInvMonture

Fonction de récupération du catalogue de montures. Si erreur la fonction retourne une string vide

Paramètres reçus

- Clé de l'API

1 Returned value (string) :

If successful Base64 encoded CSV file containing the Frames catalog

if error empty string is returned

POST: /GetCatMontures

Fonction de récupération des rendez-vous à confirmer pour une journée donnée. Si Succès: Un tableau contenant la liste des rendez-vous. Si Erreur: tableau vide

Paramètres reçus

- Clé de l'API

- Date(Format yyyy-MM-dd) pour laquelle les rendez-vous à confirmer doivent être retournés

1 Returned value (string) :

If successful an Array of all the appointment for that date

if error empty Array is returned

POST: /GetLstRV

Fonction de définition de la présence d'un client à son rendez-vous. Si Succès: 0 Inscription réussie. Si Erreur: Id de plage horaire invalide

Paramètres reçus

- Clé de l'API

- Id du RV à confirmer

1 Returned value (integer) :

If successful returns 0

if error returns 1

POST: /SetPresenceRV

Fonction s'occupant de définir si un patient est abonné à l'envoi du publicité

Paramètres reçus

- Clé de l'API

- Email: Courriel du ou des patients concernés

- AbonneEtat: État d'abonnement à définir (O = Abonner / N = Désabonner)

1 Returned value (integer) :

If successful returns 0

Email not found returns 1

if error returns 2

POST: /SetPresenceRV

Fonction de définition de la présence d'un client à son rendez-vous. Si Succès: 0 Inscription réussie. Si Erreur: Id de plage horaire invalide

Paramètres reçus

- Clé de l'API

- Id du RV à confirmer

1 Returned value (integer) :

If successful returns 0

if error returns 1

POST: /SetPresenceRV

Fonction de demande d'affichage d'un patient à partir du système téléphonique ReseauTel.

Paramètres reçus

- Clé de l'API

- Code de poste téléphonique ReseauTel correspondant au poste Opti-Pro concerné par la demande d'affichage

- Numéro de téléphone du patient concerné par la demande d'affichage

1 Valeur retournée (integer) :

0 - Demande d'affichage inscrite avec succès

1 - Erreur lors de l'inscription de la demande

2 - Code de poste invalide

3 - No de téléphone inexistant dans Opti-Pro

POST: /AffichePatient

Fonction de création d'un patient à partir de la réservation de rendez-vous en ligne.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- Nom: Nom du patient

- Prenom: Prénom du patient

- Sexe: Sexe du patient

- Langue: Langue du patient

- Email: Courriel du patient

- DateNais: Date de naissance du patient AAAA-MM-JJ (optionnel)

- TelRes: No de tél. résidence du client (optionnel) Ex 4185256969

- TelCell: No de tél. cellulaire du client (optionnel) Ex 4185256969

1 Valeur retournée (integer) :

0 - Erreur de création

1 - Patient déjà existant

2 - Erreur connexion à la base de donnée

9 - Clé API invalide

Id patient = Création réussie

POST: /CreatePatient

No documentation available.

Fonction d'identification d'un patient à partir de la réservation de rendez-vous en ligne.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- Email: Courriel du patient

- TypeNoDossier: Type du numéro de dosssier

- NoDossier: Numéro de dossier du patient

- PatientId: Id du patient (optionnel - Utilisé suite à une nouvelle inscription de patient) - Valeur par défaut 0

- JSON info patient et ressources disponibles

1 Valeur retournée (string) pour validation :

0 - Info patient et ressources disponible

1 - Info patient et aucune ressources disponible

2 - Erreur connexion à la succursale

6 - Erreur connexion à la base de donnée

7 - Erreur de concordance de patient

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

10 - Patient exclu

Get: /GetInfoPatient

Fonction renvoyant de l'information sur un rendez-vous à déplacer

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- PlageId: Id de la plage horaire

- PatientId: Id du patient

- JSON info de la plage horaire du rendez-vous

- Propriétés vide si aucun rdv

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

4 - Plage passée

8 - Autre erreur

9 - Clé API invalide

POST: /GetInfoRdvDepl

Fonction renvoyant de l'information sur un rendez-vous à déplacer

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- PlageId: Id de la plage horaire

- PatientId: Id du patient

- JSON info de la plage horaire du rendez-vous

- Propriétés vide si aucun rdv

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

4 - Plage passée

8 - Autre erreur

9 - Clé API invalide

GET: /GetInfoRdvDepl

Fonction renvoyant de l'information sur les raisons d'annulation et déplacement de rendez-vous

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- JSON info sur les raisons

- Propriétés vide si aucun rdv

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

9 - Autre erreur

10 - Clé API invalide

POST: /GetInfoRdvDepl

Fonction renvoyant de l'information sur les catégories de plage horaire

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- JSON info sur les catégories de plage

- Propriétés vide si aucun rdv

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

9 - Autre erreur

10 - Clé API invalide

GET: /GetInfoCategPlage

Fonction renvoyant de l'information sur les codes d'activité

Paramètres reçus

- SuccCode : Code de succursale

Valeurs retournées :

- JSON info sur les raisons

- Vide si aucune catégorie trouvée

Codes d'erreur (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

9 - Autre erreur

Ouverture de la connexion à la base de données locale ou de la succursale si spécifiée

GET: /GetInfoCodesActiv

Fonction renvoyant de l'information sur les catégories de plage horaire avec critère d'age

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- JSON info sur les catégories de plage

- Propriétés vide si aucun rdv

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

9 - Autre erreur

10 - Clé API invalide

GET: /GetCategPlage

Fonction d'identification d'un patient à partir de la réservation de rendez-vous en ligne.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessId: Id de la ressource

- DateDebutPlage: Date de début des plages à retourner

- DateFinPlage: Date de fin des plages à retourner

- JSON info plages Web disponibles

1 Valeur retournée (string) pour validation :

0 - Plages disponible

1 - Aucune plage disponible

2 - Erreur connexion à la succursale

6 - Erreur connexion à la base de donnée

7 - Dates invalide

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

POST: /GetPlagesWebDisp

Fonction validant les informations de connexion à l'agenda en ligne

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- UserEmail: Courriel de l'usager

- UserPsw: Mot de passe crypté de l'usager

- Succès

1 Valeur retournée (string) pour validation :

- Accès ressource = Code de la ressource

- Accès admin = blanc

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

4 - Usager introuvable

5 - Mot de passe invalide

8 - erreur générique

9 - Clé API invalide

POST: /ValidAccesAgenda

Fonction de suppression d'une plage horaire

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- PlageId: Id de la plage horaire

0 = Suppression réussie

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

4 - Usager introuvable

8 - Autre générique

9 - Clé API invalide

POST: /SupprimePlageAgenda

Fonction permettant de récupérer les informations de ressource utiles pour l’affichage et la sélection (en mode admin)

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessCode: Code de ressource (optionel)

- JSON info sur les ressources

1 Valeur retournée (string) pour validation :

Code d'erreur 0 / Aucune erreur

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

8 - aucune succursale trouvée

9 - Autre erreur

10 - Clé API invalide

GET: /GetInfoRessAgenda

Fonction s'occupant de définir un nouveau mot de passe pour un accès ressource

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- UserEmail: Courriel de l'usager

- UserPsw: Nouveau mot de passe crypté de l'usager

0 = Reset réussi

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

4 - Usager introuvable

8 - erreur générique

9 - Clé API invalide

POST: /SetNouvMdpWeb

Insère une ou plusieurs nouvelles plages horaires dans l'agenda d'une ressource.

Code de la succursale.

Code de la ressource.

Date de la plage à insérer.

Heure de début de la plage à insérer.

Durée de la plage en minutes.

Chaîne contenant les codes d'activité associés à la plage.

Identifiant de la catégorie de la plage.

Heure de fin utilisée pour l'insertion répétitive des plages.

Si vide, une seule plage est créée.

Code de résultat :

0 = Insertion réussie

1 = Erreur de connexion à la base de données

2 = Erreur de connexion à la succursale

3 = Code de succursale invalide

5 = Erreur lors de l'insertion

9 = Autre erreur

Modifie une plage horaire existante dans l'agenda d'une ressource.

Paramètres :

SuccCode : Code de succursale

PlageId : Identifiant de la plage horaire

DureePlage : Durée de la plage en minutes

CodesAct : Chaîne contenant les codes d'activité de la plage

CategPlageId : Identifiant de la catégorie de la plage

PlageDispo : Disponibilité de la plage

PlageNote : Note manuelle de la plage

PlageComment : Remarque de la plage

Code de résultat :

0 = Modification réussie

1 = Plage horaire inexistante

2 = Erreur de connexion à la succursale

3 = Code de succursale invalide

4 = Erreur de connexion à la base de données

5 = Erreur lors de la modification

9 = Autre erreur

Fonction renvoyant de l'information sur les catégories de plage horaire avec critère d'age

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessCode: Code de la ressource

- JSON info sur les catégories de plage

- Propriétés = 8 si aucune succursale trouvée

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

8 - aucune succursale trouvée

9 - Autre erreur

10 - Clé API invalide

GET: /GetSuccAgenda

Fonction renvoyant le code et le nom de toutes les succursales du client

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessCode: Code de la ressource

- JSON info sur les catégories de plage

- Propriétés = 8 si aucune succursale trouvée

1 Valeur retournée (string) pour validation :

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

8 - aucune succursale trouvée

9 - Autre erreur

10 - Clé API invalide

GET: /GetSuccClient

Fonction renvoyant le l'information sur les plages horaires d’une ou de toutes les ressources avec agenda Web pour une période donnée

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessCode: Code de la ressource

-AgendaMois: Mois

-AgendaAnnee: Annee

- JSON info plages horaires

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

4 - dates invalide

9 - Autre erreur

10 - Clé API invalide

GET: /GetJoursAgenda

Fonction renvoyant de l'information sur les catégories de plage horaire avec critère d'age

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessCode: Code de la ressource

- DateDebutPlage: Date de début des plages à retourner (obligatoire)

- DateFinPlage: Date de fin des plages à retourner (obligatoire)

- JSON info plages horaires

1 - Erreur de connexion à la BD

2 - Erreur connexion à la succursale

3 - Code de succursale invalide

4 - dates invalide

9 - Autre erreur

10 - Clé API invalide

GET: /GetPlagesAgenda

Fonction validant qu’un usager lié au courriel de la ressource existe

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- UserEmail: Courriel de l'usager

- Succès

1 Valeur retournée (string) pour validation :

Mode non admin = Code de la ressource

- Accès admin = blanc

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

4 - Usager introuvable

8 - erreur générique

9 - Clé API invalide

POST: /ValidUserAgenda

Fonction d'identification d'un patient à partir de la réservation de rendez-vous en ligne.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- RessId: Id de la ressource

- DateDebutPlage: Date de début des plages à retourner

- DateFinPlage: Date de fin des plages à retourner

- CodeActPlage: Code d'activité des plages à retourner

- ProchDispo: Indique d'avancer la date de début de période de plages à la prochaine disponibilité ou non

- JSON info plages Web disponibles

1 Valeur retournée (string) pour validation :

0 - Plages disponible

1 - Aucune plage disponible

2 - Erreur connexion à la succursale

6 - Erreur connexion à la base de donnée

7 - Dates invalide

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

GET: /GetPlagesWebDisp

Fonction renvoyant de l'information sur le prochain rendez-vous d'un patient.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- PatientId: Id du patient

- JSON info plages Web disponibles

1 Valeur retournée (string) pour validation :

0 - Plages disponible

1 - Erreur connexion à la base de donnée

1 - Aucune plage disponible

2 - Erreur connexion à la succursale

3 - Code succursale invalide

4 - Aucun RDV Disponible

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

GET: /GetNextRdvPatient

Fonction de création d'un patient à partir de la réservation de rendez-vous en ligne.

Paramètres reçus

- Clé de l'API

- PatientId: Id du patient

- PlageId: Id de la plage horaire

- PlageNote: Note a sauvegarder dans le plage horaire

1 Returned value (integer) :

0 = Réservation réussi

1 = Plage horaire déjà occupée ou inexistante

2 = Erreur de connexion à la succursale

3 = Code de succursale invalide

5 - Le maximum de rendez-vous de la catégorie de plage pour la journée pour la ressource est atteint

4 - Erreur connexion à la base de donnée

8 - Erreur format de réception des données d'entrée

11 - Clé API invalide

POST: /ReserveRdv

Pdf optometric results file transmission function in imaging.

Received parameters

- API Key

- StoreCode: Store code

- FileTypeCode: Imagery type code

- PatientHCN: Patient's health insurance number

- OptoProfCode: Professional code of the optometrist

- FileExam: Base64 encoded PDF file

1 Returned value (integer) :

0 - Transmission completed successfully

1 - Store not found

2 - Store connection error

3 - Patient not found

4 - Imagery type not found

5 - Error saving imagery

11 - Invalid API Key

12 - Invalid PDF file

POST: wsoptipro/TransmisFileExam

Fonction renvoyer les succursales avec rendez-vous en ligne

Paramètres reçus

- Clé de l'API

1 Valeur retournée (string) pour validation :

- JSON info succursales web

0 - Succès

1 - Erreur de connexion à la BD

2 - aucune succursale disponible

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

POST: /GetSuccRdvWeb

No documentation available.

Fonction s'occupant de vérifier si le courriel fourni en paramètre correspont à un ou plusieurs patient.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- Email: Courriel du patient

- JSON info patient et ressources disponibles

1 Valeur retournée (string) pour validation :

0 - Info patient disponible

1 - Code d'erreur 1 / Erreur de connexion à la BD

2 - Code d'erreur 2 / Erreur de connexion à la succursale

3 - Code d'erreur 3 / Code de succursale invalide

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

Get: /GetPatientsExist

Fonction renvoyant les coordonnées de la lunetterie.

Paramètres reçus

- Clé de l'API

1 Valeur retournée (string) pour validation :

- JSON coordonnées de la succ/lunetterie

0 - Succès

1 - Erreur de connexion à la BD

2 - Erreur de connexion à la succursale

3 - Code de succursale invalide

9 - Clé API invalide

POST: /GetCoordRdv

Fonction d'annulation de rendez-vous.

Paramètres reçus

- Clé de l'API

- SuccCode: Code de succursale

- PlageId: Id de la plage horaire

- DeplaceRdv: True si l'annulation à lieu dans le câdre d'un déplacement de rendez-vous

MntFrais: Montant des frais chargés au patient pour l'annulation ou le déplacement.

AnnuleRaison: Raison de l'annulation

1 Returned value (integer) :

0 = Annulation réussie

1 = Plage horaire inoccupée ou inexistante

Code d'erreur 4 / Erreur de connexion à la BD

Code d'erreur 2 / Erreur de connexion à la succursale

Code d'erreur 3 / Code de succursale invalide

Code d'erreur 5 / Erreur de sauvegarde

8 - Erreur format de réception des données d'entrée

9 - Clé API invalide

POST: /AnnuleRdv