Comment le REPOS Fonctionne

D'une manière générale, une demande de REPOS impliquera d'envoyer une demande à un URL spécial (semblable à ce que vous verriez après avoir rempli hors d'une forme en utilisant la méthode d'OBTENIR), recevant alors un document de XML contenant la réponse du serveur. La réponse de XML est alors analysée, et l'information désirée est extraite et agie au moment.

Chaque demande de REPOS a généralement plusieurs éléments communs :

• URL de point final — la pleine adresse pour le manuscrit désiré. Un service de REPOS pourrait avoir seulement un manuscrit simple qui manipule tous les types de demande, ou les différents manuscrits pour la demande différente dactylographie.

• Services de REPOS — d'identification de réalisateur la plupart des exigent une certaine sorte d'identification de réalisateur ou la verouillent pour être envoyée avec chaque demande. Ceci identifie l'origine de la demande et est généralement employé pour le cheminement. Quelques services peuvent employer cette valeur pour limiter le nombre de questions courues pendant une tranche de temps donnée.

• L'action désirée — peu de serveurs ont un point final unique pour toutes les demandes possibles. En tant que tels, on l'exige généralement pour inclure l'action désirée dans la demande.

• Paramètres que — plusieurs paramètres devront être inclus avec la demande de fournir à l'action demandée un certain contexte (par exemple, l'action désirée pourrait être une recherche ; les paramètres pourraient être un type, et les valeurs de mots-clés du livre et de modèle).

Avec ces éléments à l'esprit, vous pouvez créer une demande théorique :

Ici une demande est envoyée au point final http://library.example.com/api.php, avec une clef de réalisateur de 123. L'action désirée est recherche, et le type et les paramètres à mot-clé sont inclus avec des valeurs de livre et de modèle. Donné cette demande, la réponse semblerait quelque chose comme ceci :

< ?xml version="1.0" codant = "UTF-8" ? >
< LibraryAPI xmlns="http://library.example.com/api/spec" >
< demande >
< RequestId>123a456</RequestId >
< paramètres >
< "De Name="devkey "Value="123 D'Argument/>
< valeur de Name="action d'argument" = "" de recherche/>
< valeur de Name="type d'argument" = "" de livre/>

< valeur de Name="keyword d'argument" = "" de modèle/>
</paramètres >
</demande >
< réponse >
< ResultCount>2</ResultCount >
< article >
< Livre Vol. 1</Title De Title>Style >
< Status>Out</Status >
< Holds>3</Holds >
< CopiesOnHand>2</CopiesOnHand >
< Author>Jon Doe</Author >
</article >
< article >
< Livre Vol. 2</Title De Title>Style >
< Status>In</Status >
< Holds>0</Holds >
< CopiesOnHand>1</CopiesOnHand >
< Author>Jon Doe</Author >
</article >
</réponse >
</LibraryAPI >

Vous pouvez voir que la réponse a plusieurs éléments structuraux. D'abord, elle se déclare pour être XML 1.0 et emploie UTF-8 pour le codage. L'élément de LibraryAPI est l'élément de racine de ce document et inclut les namespaces indiqués. En second lieu, la section de demande ; elle est commune pour que les demandes de REPOS incluent toute l'information envoyée avec la demande dans la réponse. Ceci ajoute la clarté, et peut soulager la programmation sur l'extrémité du demandeur. Voici que vous voyez chacun des quatre éléments passés au service.

En conclusion, regardant un peu plus étroit, vous noterez que dans ce cas-ci la réponse a renvoyé un certain metadata au sujet des résultats, montrés dans l'étiquette de ResultCount, avec les articles de résultat eux-mêmes. Pour cette demande vous voyez que chaque livre est encapsulé dans un élément d'article, qui a cinq enfants qui décrivent des attributs spécifiques des livres.