Donne la liste des statuts par défaut paramétrés dans l'application.
Les valeurs de ces statuts par défaut sont utiles pour la création de demandes de devis et de commandes.
Type de statut: intervention / provider_quote / provider_request / provider_invoice / customer_quote / customer_invoice
staPar_code
VARCHAR(30)
Code du paramètre statut interne ELAN
staPar_descriptionFr
VARCHAR(255)
Description du paramètre
staPar_value
INTEGER
Valeur du statut (identifiant)
Exemple json retour
[
{
"staPar_id": 1,
"staPar_type": "intervention",
"staPar_code": "sta_defaut_admin",
"staPar_descriptionFr": "Statut par défaut création de DI en admin",
"staPar_value": "200"
},
...
A noter:
L'utilisation des statuts par défaut est importante lors de la création d'une demande de devis ou de la création d'une commande.
Pour une commande, utiliser la valeur de sta_defaut_client_quo pour une demande de devis et la valeur de sta_defaut_client_req pour une commande.
Interventions (consultation)
Description
Permet de consulter la liste des interventions et de réaliser une nouvelle demande.
Dans ELAN, une demande de devis ou une commande est référencée comme "une demande d'intervention".
Appels possibles
Verbe HTTP
Adresse
Description
/api/interventions
Liste des interventions
/api/intervention/int_id
Détail intervention par identifiant "int_id"
/api/intervention_bynumber/int_number
Détail d'une intervention par numéro
/api/intervention_bycustomerref/int_number
Détail d'une intervention par N° de référence client
Permet d'ajouter une demande de devis ou de passer une commande dans ELAN.
La demande sera référencée comme une "Demande d'intervention" dans ELAN avec un statut particulier ("Nouvelle demande de devis" ou "Nouvelle commande").
Appels possibles
Verbe HTTP
Adresse
Description
/api/interventions
Ajout d'une demande d'intervention
Exemples
http://elan_providers/api/interventions
Liste des champs attendus dans la requête d'appel
Champ
Type
Description
Obligatoire
sit_id
INTEGER
Identifiant interne ELAN du site
oui
act_id
INTEGER
Identifiant interne ELAN de l'activité
oui
actDet_id
INTEGER
Identifiant interne ELAN de la sous-activité
non
int_title
VARCHAR(255)
Titre de la DI
oui
int_description
TEXTE
Description de la demande
oui
int_urgency
INTEGER
Urgence oui/non, valeurs 0 ou 1
oui
type_request
CHAR(1)
Demande de devis ou commande ? D : demande de devis C : Commande
oui
int_customerRef
VARCHAR(255)
Référence client de la demande d'intervention (sans espaces ni caractères spéciaux)
Cette référence doit être unique. Vous ne pouvez pas effectuer deux demandes avec la même réference.
oui
int_datePossible
DATE
Intervention possible à partir du YYYY-MM-DD
non
int_dateLater
DATE
Intervention au plus tard le YYYY-MM-DD
non
int_desiredPlanningDate
DATE
Date de planification souhaitée le YYYY-MM-DD
non
int_desiredDateReturn
DATE
Date retour souhaitée du devis le YYYY-MM-DD
non
con_id
INTEGER
Identifiant contrat de maintenance préventive
non
int_category
VARCHAR(255)
Catégorie de la demande
non
equSit_id
INTEGER
Identifiant équipement du site
non
equSit_serialNumber
VARCHAR(255)
N° de série équipement
non
equSit_internalNumber
VARCHAR(255)
N° interne équipement
non
Les champs peuvent être envoyés dans le body en format JSON (Content-Type=application/json) ou en tant que "params".
Liste des codes retour possibles
Code
Description
200
Statut HTTP 200 OK
En cas de succès le JSON renvoyé est
Statut HTTP 403 Forbidden si mauvais token ou mauvaise code-site-ws
409
Statut HTTP 409 Conflict
Lors de l'appel, ELAN va vérifier:
- si une demande a déjà été faite et si elle a abouti pour le couple sit_id, act_id lors des 30 dernières secondes.
- si la réference int_customerRef existe déjà
Si c'est le cas, le werservice va renvoyer le statut HTTP 409 Conflict.
400
Statut HTTP 400 Bad Request
Lorsque l'on détecte une erreur dans les données :
Un champ obligatoire n'est pas renseigné
Le code site sit_code n’existe pas
Le code activité act_id n’existe pas
Le code sous-activité actDet_id n’existe pas (si renseigné)
La société de facturation (billing_company) n'est pas effectée par défaut pour le site.
Les champs sit_id et act_id peuvent être récupérés via les webservices GET.
Pour le site, vous devez normalement avoir un code site client, vous pouvez récupérer le
sit_id correspondant dans ELAN en appelant le webservice GET ..../api/site_bycode/XXX.
Pour l'activité (act_id), vous devrez avoir une table de correspondante pour affecter la bonne valeur.
Une demande d'intervention doit impérativement être rattachée à une société de facturation.
Le site concerné par la demande doit donc avoir une société de facturation affectée par défaut. Dans le cas
contraire, le webService va renvoyer une Erreur 400.
Ce paramétrage se fait au niveau de la gestion interne Elan providers.
A noter
Une fois la commande ou la demande de devis effectuée, vous pouvez ajouter un ou plusieurs fichiers joints à la demande (cf paragraphes suivants).
Ajout de fichier joint
Description
Lors d'une commande ou d'une demande de devis, vous avez la possibilité d'ajouter un ou plusieurs fichiers joints.
Cela peut être des photos ou des documents PDF.
Appels possibles
Verbe HTTP
Adresse
Description
/api/intervention_addfile
Ajout d'un fichier joint
Headers
Content-Type
multipart/form-data
Exemples
http://elan_providers/api/intervention_addfile
Liste des champs attendus dans la requête d'appel
NB : Les champs doivent être passés dans le Body en type "form-data"
Champ
Type
Description
Obligatoire
int_id
INTEGER
Identifiant intervention
oui
intFil_file
FILE
Fichier à ajouter
oui
intFil_description
VARCHAR(255)
Description du fichier
oui
intFil_category
INTEGER
Catégorie du fichier joint 1 : photo / image 6 : demande intervention (pdf) 3 : autres documents
oui
Liste des codes retour possibles
Code
Description
200
Statut HTTP 200 OK
En cas de succès le JSON renvoyé est
{
"success": true,
"intFil_id": "123453"
}
403
Statut HTTP 403 Forbidden si mauvais token ou mauvaise code-site-ws ou mauvais int_id (non autorisé)
409
Statut HTTP 409 Conflict
Lors de l'appel, ELAN va vérifier si un fichier avec le même nom original a déjà été inséré pour cette intervention.
Si c'est le cas, le werservice va renvoyer le statut HTTP 409 Conflict.
{
"error": "Already inserted."
}
400
Statut HTTP 400 Bad Request
Lorsque l'on détecte une erreur sur le champ int_id
Ajout de fichier joint au format BASE64
Description
Lors d'une commande ou d'une demande de devis, vous avez la possibilité d'ajouter un ou plusieurs fichiers joints au format BASE64
Cela peut être des photos ou des documents PDF.
Appels possibles
Verbe HTTP
Adresse
Description
/api/intervention_addfile_base64
Ajout d'un fichier joint
Headers
Content-Type
multipart/form-data
Exemples
http://elan_providers/api/intervention_addfile
Liste des champs attendus dans la requête d'appel
NB : Les champs doivent être passés dans le Body en type "form-data"
Champ
Type
Description
Obligatoire
int_id
INTEGER
Identifiant intervention
oui
intFil_file
TEXT
Fichier à ajouter encodé en base64
oui
intFil_description
VARCHAR(255)
Description du fichier
oui
intFil_category
INTEGER
Catégorie du fichier joint 1 : photo / image 6 : demande intervention (pdf) 3 : autres documents
oui
file_extension
CHAR(3)
Extension du fichier joint
oui
Liste des codes retour possibles
Code
Description
200
Statut HTTP 200 OK
En cas de succès le JSON renvoyé est
{
"success": true,
"intFil_id": "123453"
}
403
Statut HTTP 403 Forbidden si mauvais token ou mauvaise code-site-ws ou mauvais int_id (non autorisé)
409
Statut HTTP 409 Conflict
Lors de l'appel, ELAN va vérifier si un fichier avec le même nom original a déjà été inséré pour cette intervention.
Si c'est le cas, le werservice va renvoyer le statut HTTP 409 Conflict.
{
"error": "Already inserted."
}
400
Statut HTTP 400 Bad Request
Lorsque l'on détecte une erreur sur le champ int_id