Spbre arquivos XML de saída e modelos para APIs

As APIs retornam dados usando dois tipos de arquivos XML de saída que definem quais elementos e atributos são requeridos por uma API.

Arquivo XML de Saída - Define os limites externos dos dados que uma API pode retornar. Não modifique arquivos XML de saída.
Arquivo XML de Modelo - Define os dados retornados por uma API para o registro especificado no arquivo XML de entrada e restringe a quantidade de dados em um subconjunto do XML de saída. É possível modificar este arquivo para incorporar um subconjunto dos atributos e elementos do XML de saída.

Nota: os arquivos de modelo devem ser codificados no formato UTF-8 .

Modelos de XML de saída

Muitas APIs usam um modelo de saída correspondente. O modelo de saída está no formato XML e é lido por uma API para determinar os elementos e atributos para os quais ele deve retornar. O modelo de saída padrão define os elementos e atributos retornados para qualquer API específica. (Para ver o intervalo inteiro de valores possíveis que uma API pode retornar, consulte seu XML de saída em Javadoc. O modelo padrão pode ser um subconjunto do intervalo inteiro de valores retornados, conforme determinado pelo XML de saída no Javadoc..

Nota: certifique-se de que ao incluir elementos e atributos no modelo de saída, use apenas aqueles documentados no Javadoc. Embora as APIs possam produzir elementos e atributos adicionais, apenas aqueles documentados no Javadoc são suportados.

Por exemplo, o modelo de saída padrão da API getOrderList() retorna as informações no nível do cabeçalho de um pedido e o modelo de saída padrão da API getOrderDetails() retorna informações detalhadas sobre um pedido.

Além do modelo XML de saída padrão, é possível criar modelos de saída customizados para as APIs usarem para suas próprias necessidades de negócios, tal como uma saída diferente para diferentes tipos de documentos.

Tipos de documento

Se você usar uma variedade de tipos de documentos relacionados aos negócios, como pedidos, pedidos planejados, ordens de compra e devoluções, será possível usar modelos customizados que permitem que uma API retorne os valores pertencentes a cada tipo de documento exclusivo.

Por exemplo, você pode usar um modelo com a API getOrderDetails() para retornar informações sobre ordens planejadas e outro modelo para a API getOrderDetails( ) para retornar informações diferentes sobre ordens.

Comportamento de modelo de saída padrão

O conjunto de valores que o modelo de saída padrão retorna abrange uma variedade de cenários de negócios. Com uma gama tão grande de possibilidades, uma API que usa o modelo de saída padrão pode retornar muito mais dados do que você precisa para propósitos comerciais (e demorar muito mais tempo para processar do que você prefere).

Se desejar customizar as informações retornadas por uma API, será possível fazer isso criando e usando um modelo customizado, usando nossas diretrizes e procedimentos.