Programme pour développeurs

Prêt à rejoindre le Programme pour développeurs? Inscrivez-vous GRATUITE

Ressources

Tarification

Exemples de codes de tarification : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir le service – Module REST

Résumé

Nom :	Obtenir le service
Raison pour utiliser le service :	Pour trouver des détails sur un service postal donné, notamment les limites de dimensions et de poids ainsi que les options disponibles
Données d'entrée :	Service (pays – facultatif)
Données de sortie :	Description du service, options et restrictions
Demande de service précédente habituelle :	Obtenir les tarifs ou Découvrir les services
Historique des versions :	Notes de diffusion

Obtenir le service – Résumé du service

Détails sur la demande

Structure de la demande pour obtenir le service

Point final

Il faut utiliser le lien associé à une des demandes de service précédentes lorsque rel="service" (voir la section Points finaux fournis)

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	À partir du media-type dans le lien original (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

Chaîne de requête

Il y a un paramètre facultatif pour la chaîne de requête :

Nom de l'élément	Description
country	Ce paramètre précisera les options si elles ont été fournies. Par exemple, certains pays acceptent l'option Signature pour le service Xpresspost^MC – International, tandis que d'autres ne l'acceptent pas. Nota : Nous ne validons pas si le service d'expédition que vous avez précisé est un service valide pour le pays que vous avez indiqué. Par conséquent, même si le service n'est pas offert pour le pays que vous avez indiqué, une liste d'options par défaut sera tout de même produite.

Nom de l'élément

Description

country

Ce paramètre précisera les options si elles ont été fournies. Par exemple, certains pays acceptent l'option Signature pour le service Xpresspost^MC – International, tandis que d'autres ne l'acceptent pas.

Nota : Nous ne validons pas si le service d'expédition que vous avez précisé est un service valide pour le pays que vous avez indiqué. Par conséquent, même si le service n'est pas offert pour le pays que vous avez indiqué, une liste d'options par défaut sera tout de même produite.

Éléments de la demande

Les données d'entrée XML ne sont pas nécessaires pour le service Obtenir le service.

Détails de la réponse

Éléments de réponse

Nom de l'élément	Type	Description
service-code	Simple	Identificateur de service
service-name	Simple	Description du service dans la langue privilégiée
comment	simple	Message indiquant le montant maximal de couverture inclus avec ce service (qui peut être aucune); l’information est retournée uniquement pour quelques services vers les É.-U. et le régime international pour lesquels on ne peut pas acheter une couverture supplémentaire. S'applique seulement à la version 2 du schéma et aux versions ultérieures.
options	Complexe	Liste d'options disponibles ou applicables à ce service
option	Complexe	Option précise
option-code	Simple	Code utilisé pour sélectionner l'option pour le service Obtenir les tarifs ou Créer l'envoi
option-name	Simple	Nom de l'option dans la langue privilégiée
link	Simple	Lien vers le service Obtenir les options (Consultez la section Points finaux fournis)
mandatory	Simple	Vrai \| Faux Indique si cette option est obligatoire pour le service
qualifier-required	Simple	Vrai \| Faux La mention « Vrai » signifie que cette option doit inclure un qualificatif si elle est sélectionnée. C'est le cas pour les options Couverture (COV) et Contre remboursement (COD).
qualifier-max	Simple	Le code numérique correspond à la valeur maximale du qualificatif pour ce service. La valeur maximale d'un qualificatif peut varier selon les services. Cet élément est propre à l'option Couverture (COV).
restrictions	Complexe	Décrit les restrictions relatives aux dimensions et au poids pour les colis expédiés par l'intermédiaire de ce service.
weight-restriction	Complexe	Décrit les restrictions relatives au poids pour les articles expédiés par l'intermédiaire de ce service.
min	Attribut de la restriction relative au poids	Poids minimal en grammes
max	Attribut de la restriction relative au poids	Poids maximal en grammes pouvant être envoyé par l'intermédiaire de ce service
dimensional-restrictions	Complexe	Décrit les restrictions relatives aux dimensions pour les articles expédiés par l'intermédiaire de ce service.
length	Complexe	Précise la gamme de dimensions de la dimension la plus longue pour un envoi en centimètres.
width	Complexe	Précise la gamme de dimensions de la deuxième dimension la plus longue pour un envoi en centimètres.
height	Complexe	Précise la gamme de dimensions de la dimension la plus courte pour un envoi en centimètres.
min	Attribut de la longueur, de la largeur et de la hauteur	Mesure minimale en centimètres allouée pour la dimension
max	Attribut de la longueur, de la largeur et de la hauteur	Mesure maximale en centimètres allouée pour la dimension
length-plus-girth-max	Simple	Valeur maximale calculée : Longueur + (2 x Largeur) + (2 x Hauteur) (en centimètres)
length-height-width-sum-max	Simple	Valeur maximale : Longueur + Largeur + Hauteur (en centimètres)
oversize-limit	Simple	Si l'une des dimensions dépasse cette limite, un droit supplémentaire pour article surdimensionné s'appliquera à l'envoi (en centimètres).
density-factor	Simple	Facteur de densité standard utilisé pour calculer l'équivalent volumétrique du poids réel. Remarque : Postes Canada peut utiliser un autre facteur pour calculer l’équivalent volumétrique, selon votre convention du service de colis.
can-ship-in-mailing-tube	Simple	Vrai \| Faux La mention « Vrai » indique que les colis expédiés par l'intermédiaire de ce service peuvent être expédiés dans un tube d'expédition (l'option CYL peut être utilisée).
can-ship-unpackaged	Simple	Vrai \| Faux La mention « Vrai » indique que les colis expédiés par l'intermédiaire de ce service peuvent être expédiés sans être emballés (l'option UP peut être utilisée).
allowed-as-return-service	Simple	Vrai \| Faux La mention « Vrai » indique que ce service peut être utilisé dans return-spec d'une demande de service Créer l'envoi.

Réponse – Diagramme XML

Voici la structure hiérarchique des éléments XML devant être utilisée pour fournir les détails liés au service. La réponse du service (réponse valide) ou la réponse des messages (réponse d'erreur) s'affichera.

Diagramme de la réponse XML à la demande de service pour obtenir le service

Voir l'image en taille réelle

Réponses d'erreur possibles

Aucune erreur n'est prévue pour l'utilisation de ce service à partir d'un lien fourni. Si ce service est créé, l'erreur suivante pourrait s'afficher.

Code	Description
8534	Un pays de destination valide doit être indiqué.

Consultez la section Codes de statut HTTP pour obtenir des renseignements généraux concernant le traitement des erreurs.

Exemples

Exemple de demande REST


  GET http://cpc.ca/rs/shipping/service/INT.XP?country=JP

    Accept: application/vnd.cpc.ship.rate-v4+xml

Exemple de réponse XML


  HTTP/1.1  200 OK

    Content-Type:application/vnd.cpc.ship.rate-v4+xml

    
  
 <service> <service-code>INT.XP</service-code>

      <service-name>Xpresspost International</service-name>

      <options>
       <option>
         <option-code>COV</option-code>

          <option-name>Coverage</option-name>

          <link rel="option" href="https://XX/rs/ship/option/COV" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

          <mandatory>false</mandatory>

          <qualifier-required>true</qualifier-required>

          <qualifier-max>1000</qualifier-max>

        
        </option>

        <option>
         <option-code>DC</option-code>

          <option-name>Delivery confirmation</option-name>

          <link rel="option" href="https://XX/rs/ship/option/DC" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

          <mandatory>true</mandatory>

          <qualifier-required>false</qualifier-required>

        
        </option>

        <option>
         <option-code>RASE</option-code>

          <option-name>Return at sender's expense</option-name>

          <link rel="option" href="https://XX/rs/ship/option/RASE" media-type="application/vnd.cpc.ship.rate-v4+xml"></link>

          <mandatory>true</mandatory>

          <qualifier-required>false</qualifier-required>

        
        </option>

      
      </options>

      <restrictions>
       <weight-restriction min="0" max="30000"></weight-restriction>

        <dimensional-restrictions>
         <length min="0.1" max="150"></length>

          <width min="0.1" max="150"></width>

          <height min="0.1" max="150"></height>

          <length-plus-girth-max>300</length-plus-girth-max>

          <oversize-limit>100</oversize-limit>

        
        </dimensional-restrictions>

        <density-factor>6000</density-factor>

        <can-ship-in-mailing-tube>true</can-ship-in-mailing-tube>

        <can-ship-unpackaged>false</can-ship-unpackaged>

        <allowed-as-return-service>false</allowed-as-return-service>

      
      </restrictions>

    
    </service>

Ouvrir unesession