Condition d'erreur
Une condition d'erreur survient lorsqu'un utilisateur n'est pas autorisé à utiliser votre service Web ou que votre service ne peut pas être exécuté avec succès.
En cas de condition d'erreur, votre service Web doit générer un code de statut HTTP de niveau 400 ou 500. Selon le code de statut HTTP, vous pouvez également fournir un élément XML de niveau supérieur et une structure connexe pour les messages et les codes d'erreur dans le corps de la réponse.
Veuillez noter que vous générerez les données de sortie normales (sous un élément XML de niveau supérieur, au besoin), la structure XML d'erreur ou ni l'un ni l'autre (selon la nature de l'erreur).
Exemples
Exemple de demande selon le module REST
GET https:///ValidateRsa/99999999999999? AdditionalInfo=PO123-45678- XY&RsaNumberIssueDate=2012-09-22 HTTP/1.1
Exemple de réponse selon le module REST – XML
HTTP/1.1 200 Good
Content-Type: application/canadapost.rsa+xml
<?xml version=”1.0” encoding=”UTF-8”?>
<?ns1:ValidateRsaResponse xmlns:ns1=”http://www.canadapost.ca/webservices/validatersa”>
<ValidationStatus>true</ValidationStatus>
</ns1:ValidateRsaResponse>
Exemple de réponse selon le module REST – XML pour une condition d'erreur
HTTP/1.1 500 Error
Content-Type: application/canadapost.rsa+xml
<?xml version=”1.0” encoding=”UTF-8”?>
<ns2:Messages xmlns:ns2=”http://www.canadapost.ca/webservices/messages”>
<Message>
<Code>8304</Code>
<Description>Sample error</Description>
</Message>
</ns2:Messages>
Exemple de réponse selon le module REST – JSON
HTTP/1.1 200 Good
Content-Type: application/candapost.rsa+json
{
"ValidateRsaResponse":{ "ValidationStatus":true
}
}
Exemple de réponse selon le module REST – JSON pour une condition d'erreur
HTTP/1.1 500 Error
Content-Type: application/candapost.rsa+json
{
"Messages":[
{ "Code":"8304", "Description":"Sampleerror"
}
]
}