Expédition avec convention
Obtenir le manifeste – Module REST
Résumé
Nom : | Obtenir le manifeste |
---|---|
Raison pour utiliser le service : |
|
Données d'entrée : | Il faut utiliser le lien ou les liens associés au service Transmettre les envois lorsque rel="manifest". |
Données de sortie : | Les renseignements suivants sont présentés pour le manifeste déterminé.
|
Exemple d'erreur : | 404 – Introuvable |
Demande de service précédente habituelle : | |
Prochaine demande de service habituelle : | |
Historique des versions : |
Détails sur la demande
Structure de la demande pour obtenir le manifeste
Point finalIl faut utiliser le lien associé à une demande de service précédente lorsque rel= “manifest” (voir la section Points finaux fournis).
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
application/vnd.cpc.manifest-v8+xml (Remarque : */* à la place de la valeur de l'en-tête affichera un message d'erreur) |
Authorization |
Basic {Encodage en base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Corps du message
Aucun
Éléments de la demande
Les données d'entrée XML ne sont pas nécessaires pour le service Obtenir le manifeste.
Détails de la réponse
Réponse – Éléments
Le tableau suivant décrit les champs XML dans la réponse.
Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez le diagramme ci-dessous.
Obtenir le manifeste – Aperçu détaillé des éléments de réponse | ||
---|---|---|
Nom de l'élément | Type | Description |
manifest |
Complexe |
Niveau supérieur de la structure |
customer-request-id |
Simple |
Pour utilisation future. |
po-number |
Simple |
(Chaîne alphanumérique – Jusqu'à 10 lettres/chiffres) Fait partie de manifest. Il s'agit du numéro de bon de commande associé au manifeste, sauf dans le cas des manifestes vides, qui sont toujours réglés à « EMPTY ». (Consultez la page Transmettre les envois pour obtenir plus de détails.) |
links |
Complexe |
Fait partie de manifest. Cette structure comprend les liens vers les artefacts et les détails du manifeste déterminé. |
link |
Complexe |
Fait partie de manifest-links. Occurrence (1 à N fois). Toutefois, à l'heure actuelle, il y a quatre liens :
Chaque lien vous permet de récupérer différents renseignements sur le manifeste. Pour obtenir une description des attributs des liens, consultez la section Points finaux fournis.
(Nota : Le lien de l'élément XML est « Complexe », car il contient de nombreux attributs. L'élément de lien ne comprend pas de sous-éléments.) |
Réponse – Diagramme XML
Nota : L'attribut « index » de l'élément du lien dans l'image ci-dessous n'est pas utilisé dans le service Obtenir le manifeste.
Réponse – Réponses d'erreur possibles
Consultez la section Codes de statut HTTP pour obtenir des renseignements généraux concernant le traitement des erreurs.
Les messages d'erreur possibles de type « 400 » pour ce service sont les suivants :
Code | Message |
---|---|
1182 | La transaction a été refusée. Veuillez sélectionner une autre carte de crédit ou une autre méthode de paiement et retransmettre la commande. |
1185 | La transaction a été refusée. Veuillez sélectionner un autre compte ou une autre méthode de paiement et retransmettre la commande. |
Les messages d'erreur possibles de type « 200 » pour ce service sont les suivants :
Code | Message |
---|---|
1653 | La méthode de paiement Porte au Compte n'est pas disponible. Veuillez choisir une autre méthode de paiement. |
Les messages d'erreur possibles de type « 202 » pour ce service sont les suivants :
Code | Message |
---|---|
9153 | Le processus de transmission n'est pas encore complété. Veuillez essayer de nouveau. |
Les messages d'erreur possibles de type « 412 » pour ce service sont les suivants :
Code | Message |
---|---|
9154 |
Une erreur système est survenue. Veuillez essayer de nouveau plus tard. Si le problème persiste, contactez la ligne d'assistance de la SCP. * Vous recevrez cette erreur si vous essayez d'utiliser le service Obtenir le manifeste (numéro d'identification de l'artefact) alors que la dernière tentative de Transmettre les envois a échoué. Les envois sont accompagnés d'un manifeste en différé; par conséquent, l'erreur est renvoyée à la demande suivante. L'absence d'une carte de crédit par défaut est la cause courante d'un échec de transmission. |
Exemples
Exemple de demande REST – Obtenir le manifeste
GET https://XX/rs/1234567/1234567/manifest/123456789012345678
Accept:application/vnd.cpc.manifest-v8+xml
Authorization:Basic s7HD7gwsennesc==
Exemple de réponse XML – Obtenir le manifeste
<manifest>
<po-number>P906367941</po-number>
<links>
<link rel="self" href="https://XX/rs/111111111/222222222/manifest/33333333" media-type="application/vnd.cpc.manifest-v8+xml"></link>
<link rel="details" href="https://XX/rs/111111111/222222222/manifest/666666666/details" media-type="application/vnd.cpc.manifest-v8+xml"></link>
</links>
</manifest>