Imprimer

Ramassage

Récupérer les demandes de ramassage – Module REST

Résumé

Nom : Récupérer les demandes de ramassage
Raison pour utiliser le service : Pour récupérer les liens vers les demandes de ramassage ouvertes.
Données d'entrée : Les données d'entrée XML ne sont pas nécessaires pour ce service.
Données de sortie : Liste de liens vers les ressources propres à chacune des demandes de ramassage.
Historique des versions :

Notes de mise à jour
Récupérer les demandes de ramassage – Résumé du service

Récupérer les demandes de ramassage – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Récupérer les demandes de ramassage »

Point final

GET https://XX/enab/{customer}/pickuprequest
Remplacez... Par...

XX (Conception)

ct.soa-gw.postescanada.ca

XX (Production)

soa-gw.postescanada.ca

{customer}

Votre numéro de client
En-têtes HTTP

Variable des en-têtes HTTP

Valeur

Accept

application/vnd.cpc.pickuprequest+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur)

Authorization

Basic {Encodage 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 Récupérer les demandes de ramassage.

Détails de la réponse

Réponse – Éléments

Le tableau ci-dessous décrit les champs XML dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Récupérer les demandes de ramassage – Éléments de la réponse
Nom de l'élément Type Description

pickup-requests

Complexe

Élément XML de niveau supérieur de la structure de la réponse.

pickup-request

Complexe

Le niveau supérieur de la structure pour chaque demande de ramassage. Un suivi sera assuré pour toutes les demandes ouvertes/actives et l’historique récent (jusqu’à 20 demandes).

pickup-request-header

Complexe

Structure contenant les renseignements de base sur la demande de ramassage.

request-id

Simple

Numéro d'identification de la demande de ramassage.

request-status

Simple

Statut de la demande. Les valeurs possibles sont les suivantes :

  • New (Nouveau)
  • Pending (en attente)
  • Cancelled (annulée)
  • Active (active)
  • Missed Pickup (ramassage manquée)

 pickup-type

Simple

Type de ramassage demandé: OnDemand (sur demande) .

request-date

Simple

Date à laquelle la demande de ramassage a été créée.

next-pickup-date

Simple

Date pour laquelle une demande de ramassage est demandée.

links

Complexe

Structure contenant les liens vers les renseignements sur la demande de ramassage.

link

Complexe

Ces liens servent à appeler d'autres fonctions relatives à la demande de ramassage. Chaque lien représente un lien vers l'un des services en ligne.
Occurrence (1 à Nfois).
Les liens ci-dessous s'afficheront avec un type de «rel» unique:

  1. rel="self"

Ce lien représente la demande de ramassage en tant que tel. L'attribut «href» peut être utilisé comme point final propre au service «Mettre à jour la demande de ramassage» pour l'envoi en question.

  1. rel = "details"

Ces liens représentent les détails supplémentaires de la demande de ramassage et ils ne sont pas générés dans la réponse du service Récupérer les demandes de ramassage. L'attribut «href» est un point final du service Récupérer les demandes de ramassage.

  1. rel = "hold"

Pour utilisation future

  1. rel = "resume"

Pour utilisation future

  1. rel = "cancel"

Ce lien sert à annuler ou à supprimer une demande de ramassage. L'attribut «href» est un point final du service Annuler une demande de ramassage.
Dans tous les cas susmentionnés, la valeur de l'attribut media-type correspond à la version du fichier XML qui s'affichera et doit être incluse dans l'en-tête HTTP Accept lorsqu'il faut présenter toute autre demande de service désignée par l'attribut «href».

Réponse – Diagramme XML

Récupérer les demandes de ramassage – Structure de la réponse XML
Récupérer les demandes de ramassage – Structure de la réponse XML
Voir l'image en taille réelle

Réponses d'erreur possibles

Le code de retour HTTP 404 (introuvable) s'affiche si aucune demande de ramassage n'a été trouvée.

Code Description

11005

Le numéro de client est invalide. Veuillez corriger ou contacter Postes Canada pour plus de détails.

Voir aussi les Codes de statut HTTP et les Messages d'erreur et stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module REST – Récupérer les demandes de ramassage

GET https://ENV/enab/1234567/pickuprequest
Accept: application/vnd.cpc.pickuprequest+xml
Authorization: Basic s7HD7gwsennesc==

Exemple de réponse XML selon le module REST – Récupérer les demandes de ramassage

<pickup-requests>
<pickup-request-info>
<pickup-request-header>
<request-id>1212121212</request-id>
<request-status>pending</request-status>
<request-date>20140909</request-date>
</pickup-request-header>
<links>
<link rel="self" href="https://ct.soa-gw.canadapost.ca/enab/1234567/pickuprequest/1212121212" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="details" href="https://ct.soa-gw.canadapost.ca/enab/1234567/pickuprequest/1212121212/details" media-type="application/vnd.cpc.pickuprequest+xml"></link>
</links>
</pickup-request-info>
</pickup-requests>

Environnement « Bac à sable » (développement) pour la réponse XML – Récupérer les demandes de ramassage

La réponse est figée (statique) dans l'environnement de développement; par conséquent, vous recevrez toujours la réponse ci-dessous, peu importe les données dans votre demande.

<pickup-requests>
<pickup-request-info>
<pickup-request-header>
<request-id>1212121212</request-id>
<request-status>Picked Up</request-status>
<request-date>20150101</request-date>
</pickup-request-header>
<links>
<link rel="self" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="details" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212/details" media-type="application/vnd.cpc.pickuprequest+xml"></link>
</links>
</pickup-request-info>
<pickup-request-info>
<pickup-request-header>
<request-id>12345678</request-id>
<request-status>active</request-status>
<request-date>20150101</request-date>
<next-pickup-date>20150601</next-pickup-date>
</pickup-request-header>
<links>
<link rel="self" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="details" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212/details" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="hold" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212/hold" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="cancel" href="https://ct.soa-gw.canadapost.ca/enab/ your customer number /pickuprequest/1212121212/cancel" media-type="application/vnd.cpc.pickuprequest+xml"></link>
</links>
</pickup-request-info>
</pickup-requests>