Expédition avec convention
Obtenir les manifestes – Module REST
Résumé
| Nom : | Obtenir les manifestes |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les liens vers chacun des manifestes dans une plage de dates données |
| Données d'entrée : | Dates de « début » et de « fin » |
| Données de sortie : | Les données de sortie constituent une liste de liens vers les manifestes créés par le service Transmettre les envois. |
| Exemple d'erreur : | La date de début ne peut pas être postérieure à la date de fin. |
| Demande de service précédente habituelle : | Transmettre les envois |
| Prochaine demande de service habituelle : | Obtenir le manifeste |
| Historique des versions : |
Obtenir les manifestes – Résumé du service
Détails sur la demande
Structure de la demande pour obtenir les manifestes
Point final
GET https://XX/rs/{Client « Expédié par »}/{Client « Expédié au nom de »}/manifest?start=AAAAMMJJ&end=AAAAMMJJ |
|
|---|---|
| Remplacez... | Par... |
XX (développement) |
ct.soa-gw.canadapost.ca |
XX (production) |
soa-gw.canadapost.ca |
{Client « Expédié par »} |
votre numéro de client |
{Client « Expédié au nom de »} |
le numéro de client « Expédié au nom de » ou indiquez de nouveau votre numéro de client |
AAAAMMJJ |
les dates de début et de fin, respectivement |
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 les manifestes.
Dans la chaîne de requête de la demande, il faut inclure les dates de « début » et de « fin » représentant la plage de dates de votre recherche.
La date de « début » est obligatoire.
La date de « fin » est facultative. Si la date de « fin » n'est pas fournie, la date actuelle s'affichera par défaut (p. ex. date de la journée en cours).
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 les manifestes – Aperçu détaillé des éléments de réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
manifests |
Complexe |
Niveau supérieur de la structure |
link |
Complexe |
Fait partie des manifests. Chaque lien est essentiellement un pointeur permettant au client d'accéder aux renseignements d'un manifeste individuel. Le système produira des manifestes séparés en fonction des éléments suivants :
Occurrence (1 à N fois) Chaque élément du lien permet au client de récupérer des renseignements sur l'un des manifestes. Consultez la section Points finaux fournis pour obtenir une description des attributs des liens. L'élément du lien est « Complexe », car il contient de nombreux attributs. L'élément du lien ne comprend pas de sous-éléments. |
Réponse – Diagramme XML
Le diagramme suivant présente une réponse de niveau supérieur.
Obtenir les manifestes – Structure de la réponse XML
Nota : L'attribut « index » présenté dans le diagramme ci-dessus n'est pas utilisé dans le service Obtenir les manifestes.
Réponse – Réponses d'erreur possibles
Si aucun manifeste n'est trouvé, la réponse XML sera « 200 » et il y aura une structure « manifest » vide..
Les messages d'erreur propres aux paramètres pour la réponse HTTP « 400 » sont présentés ci-dessous. (Veuillez consulter la section Codes de statut HTTP pour obtenir de plus amples renseignements.)
| Code | Message |
|---|---|
9105 |
Un paramètre de requête requis n'a pas été fourni dans la demande. |
9116 |
La « startDate » ne peut pas être postérieure à la « endDate ». |
Exemples
Exemple de demande REST – Obtenir les manifestes
GET https://XX/rs/123456789/123456789/manifest?start=20100324&end=20100405
Accept:application/vnd.cpc.manifest-v8+xml
Authorization:Basic s7HD7gwsennesc==
Exemple de réponse XML – Obtenir les manifestes
<manifests>
<link rel="manifest" href="https://XX/rs/11111111/222222222/manifest/33333333" media-type="application/vnd.cpc.manifest-v6+xml"></link>
<link rel="manifest" href="https://XX/rs/11111111/222222222/manifest/33333333" media-type="application/vnd.cpc.manifest-v6+xml"></link>
<link rel="manifest" href="https://XX/rs/11111111/222222222/manifest/33333333" media-type="application/vnd.cpc.manifest-v6+xml"></link>
</manifests>
