|
ATTENTION : cette section est destinée aux utilisateurs avancés et "Super users" de PRIM Logix.
Les éléments de configuration présentés dans cette section peuvent en effet avoir un impact sur vos opérations.
En cas de doute, consultez votre administrateur système.
Veuillez noter que seuls les utilisateurs disposant des groupes de sécurité adéquats peuvent accéder aux fenêtres de configuration du logiciel. |
Réponse retournée par le service Web
La réponse des services web est un JSON, en général, de la forme suivante:
{
"status": "<etat>",
"data": "<données retournées>"
}
Voici à quoi correspond chacun des éléments retournés:
status
string
Indique l'état de la requête
Valeurs possibles: success ou error
data
json
Retourne les données de la requête
Résultat vide
Si aucune valeur n'existe pour la requête demandée, le service web retourne le JSON suivant:
{
"status" : "success",
"data": null
}
Erreurs
La forme que prendra la réponse dépend de quelle version de l'API vous utilisez :
V1 - /api/<service web\>
Le serveur répondra toujours avec soit un HTTP Status Code "200", soit "500", et il faudra se fier à la propriété status et la propriété message du corps de la réponse pour identifier les vraies erreurs.
Très important : Cette version est marquée comme deprecated. Il est préférable d'utiliser la V2 pour tout nouveau développement ou mise à jour d'intégration existante.
V2 - /api-v2/<service web\>
Le serveur répondra avec le HTTP Status Code "200" seulement si aucune erreur n'est survenue. Le cas échéant, un Status Code adéquat sera utilisé selon la nature de l'erreur.
Erreur: En-tête Content Type
Si vous n'utilisez pas application/json dans l'entête Content Type, vous aurez la réponse suivante:
En V2
HTTP Status Code: 422
{
"message": "The given data was invalid.",
"errors": {
"actionParameters": [
"Action parameters are required"
]
}
}
En V1
HTTP Status Code: 500
{
"status": "error",
"data": null,
"message": "Les paramètres passés à la procédure sont incomplets."
}
Erreur: En-tête Accept
Si vous n'utilisez pas application/json dans l'entête Accept, vous aurez la réponse suivante:
En V2
HTTP Status Code: 406 Étant donné que ce header est manquant, le serveur répond avec la page d'erreur complète (HTML)
En V1
HTTP Status Code: 200
{
"status": "error",
"message": "Wrong content type in Accept header
}
Erreur: En-têtes prim-username et prim-userkey
S'il manque des champs d'identification dans l'entête, vous aurez la réponse suivante:
En V2
HTTP Status Code: 403
{
"status": "error",
"message": "Authentication parameters missing or malformed."
}
En V1
HTTP Status Code: 200
{
"status": "error",
"message": "Authentication parameters missing or malformed."
}
Erreur: Info. de connexion et/ou droits d'accès
Si vous appelez un service web et que les informations de connexion ne sont pas bonnes, ou que vous n'avez pas activer dans PRIM les droits d'accès à un service web, vous aurez la réponse suivante:
Exemple avec le service web newJobCount:
En V1 et V2
HTTP Status Code: 500
{
"status": "error",
"data": null,
"message": "Acces denied::newJobCount:<Mon username>:<ID du service web>:<Nom du service web>:<Mon adresse IP>:<Ma clé>:[{\"ParamName\":\"JobType\",\"ParamValue\":\"B\"},{\"ParamName\":\"JobFilled\",\"ParamValue\":\"N\"}]"
}
Erreur: Service web inexistant
Si vous appelez un service web (action) qui n'existe pas, vous aurez la réponse suivante:
En V1 et V2
HTTP Status Code: 500
{
"status": "error",
"data": null,
"message": "Web service call. Wrong action call: <nom du service web>"
}
Erreur: Propriétés attendues
Si une erreur dans le nom des champs du JSON passés par la requête se produit, ou si vous passez un champ qui n'existe pas pour un service web, vous aurez la réponse suivante:
En V1 et V2
HTTP Status Code: 500
{
"status": "error",
"data": null,
"message": "Les paramètres passés à la procédure sont incomplets."
}
Erreur: JSON invalide
Si le JSON envoyé au service web est malformé, vous aurez la réponse suivante:
En V2
HTTP Status Code: 422
{
"message": "The given data was invalid.",
"errors": {
"actionParameters": [
"Action parameters are required"
]
}
}
En V1
HTTP Status Code: 500
{
"status": "error",
"data": null,
"message": "Les paramètres passés à la procédure sont incomplets."
}
