Expédition sans convention
Obtenir les envois sans convention – Module REST
Résumé
| Nom : | Obtenir les envois sans convention |
|---|---|
| Raison pour utiliser le service : | Cette demande de service permet de chercher des liens vers les envois sans convention créés récemment aux fins de récupération ou de réimpression. |
| Données d'entrée : | Paramètres pour la chaîne de requête : Début et fin |
| Données de sortie : | Liens vers les envois se situant dans la période précisée (date et heure) |
| Prochaine demande de service habituelle : | Obtenir l'envoi sans convention |
| Historique des versions : | Notes de mise à jour |
Détails sur la demande
Demande – Structure pour le service « Obtenir les envois sans convention »
Point final
GET https://XX/rs/{Client « Expédié par »}/ncshipment?from=AAAAMMJJHHMM&to=AAAAMMJJHHMM&trackingPIN={NIP de repérage} |
|
|---|---|
| Remplacez... | Par... |
XX (Conception) |
ct.soa-gw.canadapost.ca |
XX (Production) |
soa-gw.canadapost.ca |
{Client « Expédié par »} |
Votre numéro de client |
Paramètre de la chaîne de requête |
Dates de début et de fin NIP de repérage |
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
Le service Obtenir les détails de l'envoi sans convention ne requiert pas de données d'entrée XML, mais la chaîne de requête définit le type de recherche : utilisation de la plage de dates ou d'un NIP de repérage (pour un envoi précis).
Remarque : Dans l'environnement (de développement) « Bac à sable », le même NIP de repérage est toujours retourné (123456789012); alors, cette requête ne retournera pas des résultats représentatifs dans cet environnement.
Détails de la réponse
Réponse – Éléments
| Obtenir les envois sans convention – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
| non-contract-shipments | Complexe | Élément XML de niveau supérieur de la structure de la réponse. |
| link | Complexe | La structure de niveau supérieur propre aux envois contient de nombreux éléments de liens. Pour obtenir une description des attributs des liens, consultez la section Points finaux fournis. L'attribut « href » peut être utilisé comme point final propre au service « Obtenir l'envoi sans convention » pour l'envoi en question. Consultez la section Obtenir l'envoi sans convention pour obtenir des renseignements sur la façon de présenter une demande pour ce service. |
Réponse – Diagramme XML
Obtenir les envois sans convention – Structure de la réponse XML
Réponse – Réponses d'erreur possibles
Si aucun envoi n'est trouvé, la réponse XML sera « 200 » et il y aura une structure « non-contract-shipments » vide.
Les messages d'erreur propres aux paramètres pour la réponse HTTP « 400 » sont présentés ci-dessous. (Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.)
| Code | Message |
|---|---|
| 9105 | Un paramètre de requête requis n'a pas été fourni dans la demande. |
| 9116 | La date de début ne peut pas être postérieure à la date de fin. |
| 9196 | Only one of from (date) and tracking PIN must be provided. |
Exemples
Exemple de demande XML selon le module REST – Obtenir les envois 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 les envois sans convention
<non-contract-shipments>
<link rel="shipment" href="https://ct.soa-gw.canadapost.ca/rs/0007023211/ncshipment/406951321983787352" media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
</non-contract-shipments>
