Expédition avec convention

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir le manifeste – Module SOAP

Résumé

Nom :

Obtenir le numéro d'identification de l'artefact du manifeste

Raison pour utiliser
le service :

Une demande de service obligatoire qui doit être présentée pour créer un manifeste. Vous avez besoin d'une réponse positive de la demande de service « Obtenir le manifeste » pour confirmer qu'un manifeste a été créé avec succès. La réponse comprendra un numéro d'identification de l'artefact qui vous permet de récupérer le manifeste en effectuant une demande de service « Obtenir l'artefact ».

Données d'entrée :

Mailed-by; manifest-id; locale (optionnel)

Données de sortie :

po-number et artifact-id pour l'étiquette du manifeste

Exemple d'erreur :

Pointeur invalide lié à un manifeste

Demande de service précédente habituelle :

Transmettre les envois, Obtenir les manifestes

Prochaine demande de service habituelle :

Obtenir l'artefact

Historique des versions :

Notes de mise à jour

Obtenir le numéro d'identification de l'artefact du manifeste – Résumé du service

Obtenir le numéro d'identification de l'artefact du manifeste – Résumé du service

Détails sur la demande

WSDL : manifest.wsdl
Point final (Conception) : https://ct.soa-gw.canadapost.ca/rs/soap/manifest/v8
Point final (Production) : https://soa-gw.canadapost.ca/rs/soap/manifest/v8
Espace de nommage : http://www.canadapost.ca/ws/soap/manifest/v8
Opération : GetManifestArtifactId

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Obtenir le numéro d'identification de l'artefact du manifeste – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

get-manifest-artifact-id-request

complexe

requis

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

manifest-id

simple

requis

(Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres)

Numéro d'identification représentant le manifeste existant pour lequel les renseignements sont demandés.

Nota : Il faut récupérer le numéro d'identification du manifeste fourni dans le cadre des demandes de service précédentes « Transmettre les envois » et « Obtenir les manifestes ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

mailed-by

simple

requis

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié par ».

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

mobo

simple

optionnel

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ».

S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut.

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

locale

simple

optionnel

Indique votre langue de préférence pour recevoir les messages d'erreur.

EN = Anglais
FR = Français

Si aucune valeur n'est fournie, la langue par défaut est « Anglais ».

Demande – Diagramme XML

Obtenir le numéro d'identification de l'artefact du manifeste – Structure de la demande XML

Obtenir le numéro d'identification de l'artefact du manifeste – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les éléments XML figurant dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le
diagramme XML.

Obtenir le numéro d'identification de l'artefact du manifeste – Éléments de la réponse
Nom de l'élément Type Description

get-manifest-artifact-id-response

Complexe

Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse.

Il affichera les résultats d'une exécution réussie ou la structure d'une erreur.

manifest

Complexe

Structure XML contenant les résultats liés à l'exécution réussie du service en question.

customer-request-id

Simple

Pour utilisation future.

po-number

Simple

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.)

artifact-id

Simple

Numéro d'identification unique pour l'étiquette (artefact) requis dans le cadre de la demande de service « Obtenir l'artefact » pour récupérer l'étiquette.

Réponse – Diagramme XML

Obtenir le numéro d'identification de l'artefact du manifeste – Structure de la réponse XML

Obtenir le numéro d'identification de l'artefact du manifeste – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Les messages d'erreur possibles 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.
1653 La méthode de paiement Porte au Compte n’est pas disponible. Veuillez choisir une autre méthode de paiement.
9153 Le processus de transmission n’est pas encore complété. Veuillez essayer de nouveau.
9155

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 XML selon le module SOAP – Obtenir le numéro d'identification de l'artefact du manifeste

<get-manifest-artifact-id-request>
<mailed-by>1111111</mailed-by>
<manifest-id>347891314723499921</manifest-id>
</get-manifest-artifact-id-request>

Exemple de réponse XML selon le module SOAP – Obtenir le numéro d'identification de l'artefact du manifeste

<Body>
<get-manifest-artifact-id-response>
<manifest>
<po-number>D906367477</po-number>
<artifact-id>444</artifact-id>
</manifest>
</get-manifest-artifact-id-response>
</Body>