Codes d'exception
Si le serveur déclenche une exception, le service Web REST renvoie le code d'exception et un message d'exception au client sur le réseau. Le code d'exception fournit une description générale de l'erreur ; le message d'exception fournit une indication plus précise de la cause de l'exception.
Dans l'exemple suivant, une requête GET auprès du service Geocode contient un type de géocode incorrect « a ».
GET http://10.24.48.217:8082/Geocode/rest
/GeocodeService/geocode.json?mainAddress=
330%20Front%20St.%20W%20TORONTO%20ON%20M5V%203B7
&country=can&geocodeType=a HTTP/1.1
Le serveur renvoie l'erreur suivante :
HTTP/1.1 400 Bad Request
Server: Apache-Coyote/1.1
exceptionCode: INVALID_CLIENT_INPUT
exceptionMsg: Invalid geocodeType value: A
Date: Wed, 20 Sep 2017 14:33:03 GMT
Content-Type: application/json
Content-Length: 99
Connection: close
{"errors":[{"errorCode":"INVALID_CLIENT_INPUT","errorDescription":"Invalid geocodeType value: A"}]}
Exception Codes (datatype = String) | Description |
---|---|
REQUIRED_PARAMETER_MISSING | Il manque un paramètre obligatoire. |
DATA_NOT_LICENSED | Le fichier de licence d'un dictionnaire d'adresses n'est pas installé. |
INTERNAL_ERROR | Une erreur générale s'est produite avec le moteur de géocodage. |
MAPMARKER_EXCEPTION | Une exception générale s'est produite avec le moteur de géocodage MapMarker. |
MAPMARKER_FATAL_EXCEPTION | Une exception fatale s'est produite avec le moteur de géocodage MapMarker. |
INVALID_CLIENT_INPUT | Une entrée non valide a été rencontrée dans la requête. |
NO_COUNTRY_SPECIFIED | Le champ country est absent de la requête. |
COUNTRY_NOT_SUPPORTED | L'opération demandée n'est pas prise en charge pour le pays spécifié. |
GEOSTAN_FATAL_EXCEPTION | Une exception fatale s'est produite avec le moteur de géocodage GeoStan. |