Como o DESCANSO Trabalha

Geralmente falando, um pedido do DESCANSO envolverá emitir um pedido a um URL especial (similar a o que você v após o enchimento para fora de um formulário usando o método COMEÇAR), recebendo então um original de XML que contem a resposta do usuário. A resposta de XML é analisada gramaticalmente então, e a informação desejada é extraída e agida upon.

Cada pedido do DESCANSO tem geralmente diversos elementos comuns:

• URL do endpoint — o endereço cheio para o certificado desejado. Um serviço do DESCANSO pôde ter somente um único certificado que segurasse todos os tipos do pedido, ou os certificados diferentes para o pedido diferente datilografam.

• De serviços do DESCANSO — do ID do colaborador a maioria requerem alguma sorte do colaborador ID ou fecham-na à chave para ser emitida com cada pedido. Isto identifica a origem do pedido e é usado geralmente para finalidades seguindo. Alguns serviços podem usar este valor limitar o número das perguntas funcionadas durante um frame de tempo dado.

• A ação desejada — poucos usuários tem um endpoint original para todos os pedidos possíveis. Como esta', requer-se geralmente para incluir a ação desejada no pedido.

• Parâmetros que — diversos parâmetros necessitarão ser incluídos com o pedido fornecer a ação pedida com algum contexto (para o exemplo, a ação desejada pôde ser uma busca; os parâmetros puderam ser um tipo, e os valores dos keywords do livro e do estilo).

Com aqueles elementos na mente, você pode criar um pedido teórico:

Um pedido é emitido aqui ao endpoint http://library.example.com/api.php, com uma chave do colaborador de 123. A ação desejada é busca, e os parâmetros do tipo e de keyword são incluídos com valores do livro e do estilo. Dado esse pedido, a resposta olharia algo como esta:

<?xml version="1.0" que codifica = "UTF-8"? >
< LibraryAPI xmlns="http://library.example.com/api/spec" >
< pedido >
< RequestId>123a456</RequestId >
< parâmetros >
< "De Name="devkey "Value="123 Do Argumento/>
< valor de Name="action do argumento" = "" da busca/>
< valor de Name="type do argumento" = "" do livro/>

< valor de Name="keyword do argumento" = "" do estilo/>
</parâmetros >
</pedido >
< resposta >
< ResultCount>2</ResultCount >
< artigo >
< Livro Vol 1</Title De Title>Style >
< Status>Out</Status >
< Holds>3</Holds >
< CopiesOnHand>2</CopiesOnHand >
< Author>Jon Doe</Author >
</artigo >
< artigo >
< Livro Vol 2</Title De Title>Style >
< Status>In</Status >
< Holds>0</Holds >
< CopiesOnHand>1</CopiesOnHand >
< Author>Jon Doe</Author >
</artigo >
</resposta >
</LibraryAPI >

Você pode ver que a resposta tem diversos elementos estruturais. Primeiramente, declara-se para ser XML 1.0 e usa-se UTF-8 codificando. O elemento de LibraryAPI é o elemento da raiz deste original e inclui os namespaces especificados. Em segundo, a seção do pedido; é comum para que os pedidos do DESCANSO incluam toda a informação emitida com o pedido na resposta. Isto adiciona a claridade, e pode facilitar a programação na extremidade do requestor. Aqui você vê cada um dos quatro elementos passados ao serviço.

Finalmente, olhando um bocado mais próximo, você observará que neste caso a resposta retornou algum metadata sobre os resultados, mostrados no Tag de ResultCount, junto com os artigos eles mesmos do resultado. Para este pedido você vê que cada livro encapsulated dentro de um elemento do artigo, que tenha cinco crianças que descrevem atributos específicos dos livros.