Tarification

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

Obtenir l’option – Module REST

Résumé

Nom :	Obtenir l’option
Raison pour utiliser le service :	Pour récupérer les détails d'une option donnée
Données d'entrée :	Lien ou code d'option du service Obtenir les services lorsque rel=option
Données de sortie :	Description de l'option, préalables et conflits
Demande de service précédente habituelle :	Obtenir le service
Historique des versions :	Notes de mise à jour

Obtenir l’option – Résumé du service

Détails sur la demande

Structure de la demande pour obtenir l’option

Point final

Il faut utiliser le lien associé au service Obtenir les services lorsque rel=option (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

Éléments de la demande

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

Détails de la réponse

Éléments de réponse

Le tableau suivant décrit les champs XML de la réponse.
Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, veuillez consulter le diagramme ci-dessous.

Nom de l'élément	type	Description
option	Complexe	Structure contenant l'option et ses attributs
option-code	Simple	Code d'option dont les attributs sont présentés en détail
option-name	Simple	Nom de l'option dans la langue choisie
option-class	Simple	FEAT \| DI \| NDI FEAT indique que cette option est une caractéristique du service. DI indique qu'il s'agit d'une directive de livraison. NDI indique qu'il s'agit d'une directive à suivre en cas de livraison infructueuse.
prints-on-label	Simple	Vrai \| Faux Indique qu'une preuve de la sélection de cette option est imprimée sur l'étiquette.
qualifier-required	Simple	Vrai \| Faux La mention « Vrai » indique que, lorsque cette option est utilisée pour la demande de tarif ou de service Créer l'envoi, un qualificatif s'avère nécessaire pour l'option.
conflicting-options	Complexe	Liste de codes ne pouvant pas être sélectionnés en même temps pour cette option.
option-code	Simple	Option s'excluant mutuellement avec option précisée dans la demande connexe.
prerequisite-options	Complexe	Liste de codes nécessaires pour appuyer cette option.
option-code	Simple	Option devant également être sélectionnée lorsque l'option précisée dans la demande connexe est sélectionnée.

Diagramme XML de la réponse

Diagramme de la réponse XML positive à la demande de service pour obtenir l’option

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 « 404 – Introuvable » pourrait s'afficher.
Consultez la section Codes de statut HTTP pour obtenir des renseignements généraux sur le traitement des erreurs.

Exemples

Exemple de demande REST

GET https://XX/rs/ship/option/SO
Content-type: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

 <option> <option-code>SO</option-code>

      <option-name>Signature option</option-name>

      <option-class>FEAT</option-class>

      <prints-on-label>true</prints-on-label>

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

      <conflicting-options>
       <option-code>LAD</option-code>

      
      </conflicting-options>

      <prerequisite-options>
       <option-code>DC</option-code>

      
      </prerequisite-options>

    
    </option>

Ouvrir unesession

Ressources