Expédition sans convention
Obtenir l'envoi sans convention – Module REST
Résumé
| Nom : | Obtenir l'envoi sans convention |
|---|---|
| Raison pour utiliser le service : | Cette demande de service est utilisée pour obtenir les liens vers un envoi, notamment l'artefact (étiquette), les détails ou le reçu. |
| Données d'entrée : | Il faut utiliser le lien associé à une demande de service précédente désignée par rel="ncShipment". |
| Données de sortie : | Il s'agit du NIP de repérage de l'envoi et des liens vers les artefacts de l'envoi (étiquettes). L'état de l'envoi est également fourni. |
| Demande de service précédente habituelle : | Obtenir les envois sans convention |
| Prochaine demande de service habituelle : | Obtenir l'artefact |
| Historique des versions : | Notes de mise à jour |
Détails sur la demande
Demande – Structure pour le service « Obtenir l'envoi sans convention »
Point final
Il faut utiliser le lien associé à l'une de ces demandes de service précédentes.
« Créer l'envoi sans convention » lorsque rel="self"
« Obtenir les envois sans convention » lorsque rel="ncShipment"
POST https://XX/rs/{Client « Expédié par »}/ncshipment/{Numéro d'identification de l'envoi} |
|
|---|---|
| Remplacez... | Par... |
XX (Conception) |
ct.soa-gw.canadapost.ca |
XX (Production) |
soa-gw.canadapost.ca |
{Client « Expédié par »} |
Votre numéro de client* |
{Numéro d'identification de l'envoi} |
Numéro d'identification de l'envoi pertinent* |
*Le système remplacera {Client « Expédié par »} par votre numéro de client et {Numéro d'identification de l'envoi} par le bon numéro d'identification de l'envoi.
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
|---|---|
Accept |
application/vnd.cpc.ncshipment-v4+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Content-Type |
application/vnd.cpc.ncshipment-v4+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
Demande – Éléments
Les données d'entrée XML ne sont pas nécessaires pour le service « Obtenir l'envoi sans convention ».
Détails de la réponse
Réponse – Éléments XML
La réponse du service « Obtenir l'envoi sans convention » est identique à celle du service Créer l'envoi sans convention.
Réponse – Diagramme XML
Le diagramme du service « Obtenir l'envoi sans convention » est identique au diagramme XML du service « Créer l'envoi sans
convention ».
Réponse – Réponses d'erreur possibles
Aucune erreur n'est prévue pour l'utilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service « Obtenir l'envoi sans convention » plus de 90 jours après que l'envoi a été créé.
Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.
Exemples
Exemple de demande XML selon le module REST – Obtenir l'envoi sans convention
Il n'y a pas de XML lié à cette demande REST. Utilisez le lien fourni dans une demande préalable ou consultez les fichiers du projet soapUI pour obtenir des exemples de demande.
Exemple de réponse XML selon le module REST – Obtenir l'envoi sans convention
<non-contract-shipment-info>
<shipment-id>406951321983787352</shipment-id>
<tracking-pin>11111118901234</tracking-pin>
<links>
<link rel="self" href="https://XX/rs/111111111/2222222222/ncshipment/406951321983744444"media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="details" href="https://XX/rs/111111111/2222222222/ncshipment/406951321983744444/details"media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="receipt" href="https://XX/rs/111111111/2222222222/ncshipment/406951321983744444/receipt"media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="label" href="https://XX/rs/ers/artifact/76108cb5192002d5/20238/0"media-type="application/pdf"index="0"></link>
</links>
</non-contract-shipment-info>
