Le service ask/itemUrl vous permet de récupérer l'URL du point dont l'identifiant se trouve dans la requête. Cette URL correspond au service ‹identifiant_point›/xml permettant de consulter les données détaillées d'un point.
Type de requête
Requête HTTP GET
Données en entrée
Les paramètres de la requête sont les suivants.
- itemId (obligatoire) · L'identifiant du point pour lequel vous souhaitez récupérer l'URL.
- xml (optionnel, valeur par défaut: 0) · Peut valoir 1 ou 0. L'URL complète du service permettant de récupérer un point se termine par /xml. Si vous spécifiez xml=0 (ou que vous omettez le paramètre xml), l'URL retournée par le présent service ne contiendra pas le suffixe /xml. Par conséquent, vous devrez l'ajouter vous-même pour appeler le service ‹identifiant_point›/xml. Si xml est 1, le suffixe sera présent.
- public (optionnel, valeur par défaut: 1) · Peut valoir 1 ou 0. Si la valeur vaut 1, l'URL retournée sera l'URL publique du site, c'est-à-dire celle connue des utilisateurs finaux. En effet, il se peut que le site HubSessions que vous sollicitez puisse être joignable à plusieurs URLs différentes: l'URL publique ou une URL interne par exemple.
Exemple de requête
<siteUrl>/ask/itemUrl?itemId=12345&xml=1
Données de retour
Si le point est trouvé, le site retourne un code de retour HTTP 303 (Redirect), avec l'URL du point, permettant à l'appelant de faire une nouvelle requête GET sur base de cette URL.
Si le point n'est pas trouvé, le site retourne néanmoins un code de retour HTTP 303 mais avec une URL bidon, qui produira donc une erreur 404 si vous la suivez.
Consultez le service ‹identifiant_point›/xml si vous souhaitez connaître le format XML de retour de la requête GET finale.
Présence de sites d'archives
Si le site HubSessions que vous sollicitez est lié à un ou plusieurs sites d'archives, si le point recherché se situe sur un de ses sites au lieu d'être sur le site appelé initialement, ce dernier répondra correctement, en retournant l'URL du point sur le site d'archives.