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

 

Si vous n'utilisez pas le Content Type application/json dans l'entête Accept, vous aurez la réponse suivante:

{
    "status": "error",
    "message": "Wrong content type in Accept header
}

S'il manque des champs d'identification dans l'entête, vous aurez la réponse suivante:

{
    "status": "error",
    "message": "Authentication parameters missing or malformed."
}

Si vous appelez un service web et que les informations de connexion ne sont pas bonnes, ou que vous n'avez pas activé les droits d'accès à un service Web dans PRIM, vous aurez la réponse suivante:

Exemple avec le service web newJobCount

{
  "status": "error",
  "data": null,
  "message": "Acces denied::newJobCount:<Mon adresse IP>:<Ma clé>:[{\"ParamName\":\"JobType\",\"ParamValue\":\"B\"},{\"ParamName\":\"JobFilled\",\"ParamValue\":\"N\"}]"
}

Si vous appelez un service Web (action) qui n'existe pas, vous aurez la réponse suivante:

{
    "status": "error",
    "message": "Action not found in db."
}

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:

{
  "status": "error",
  "data": null,
  "message": "incorrect parameter"
}

Si le JSON envoyé au service Web est mal formé, vous aurez la réponse suivante:

{
  "status": "error",
  "data": null,
  "message": "Invalid JSON sent to request­."
}