Base de Conhecimento

Inclusão de agentes das rotas em lote

POST /CenterWeb/api/{$apiKey}/batch/itineraryAgents.xml

Este recurso permite fazer a criação e atualização de agentes de rotas em lote, sem que haja a necessidade de fazer inúmeras requisições para a API.

<itineraryAgents>

<itineraryAgent>

<agent>

<id>34</id>

</agent>

<itinerary>

<id>25156</id>

</itinerary>

</itineraryAgent>

<itineraryAgent>

<agent>

<id>35</id>

</agent>

<itinerary>

<id>25156</id>

</itinerary>

</itineraryAgent>

</itineraryAgents>

A seção "<itineraryAgent></itineraryAgent>" representa cada agente de rota a ser inserido, limitando em 100 o número máximo de agentes de rotas por requisição.

Caso algum erro ocorra, toda a operação será abortada e nenhum agente de rota será inserido.

Como retorno a esta chamada o sistema apresenta os o link de acesso a cada agente criado.

<result>

<resourceName>itineraryAgents</resourceName>

<size>2</size>

<entries>

<entry id="1803794" link="/itineraryAgent/1803794.xml" />

<entry id="1803795" link="/itineraryAgent/1803795.xml" />

</entries>

</result>

Busca Por Lista de agentes de Rotas

GET /CenterWeb/api/{$apiKey}/itineraryAgent.xml

Se preferir ainda, pode refinar as pesquisas enviando parâmetros na requisição, para isso é necessário adicionar parâmetros igual realizamos em uma requisição HTTP:

GET /CenterWeb/api/{$apiKey}/itineraryAgent.xml?agent=895259

agent: pesquisar por um determinado agente nas rotas

GET /CenterWeb/api/{$apiKey}/itineraryAgent.xml?itinerary=5421

itinerary: pesquisar os agentes de uma determinada rota

GET /CenterWeb/api/{$apiKey}/itineraryAgent.xml?itinerary.alternativeIdentifier=TesteRota

Filtrar agentes das rotas com base em atributos das entidades vinculadas aos agentes das rotas

Busca por um Agente da Rota em específico

GET /CenterWeb/api/{$apiKey}/itineraryAgent/{$id}.xml

Este recurso serve para puxar dados de um agente de rota específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<itineraryAgent>

<id>18009</id>

<itinerary>

<id>25156</id>

<description>Teste Rota</description>

<origin>0</origin>

<agentRelation>1</agentRelation>

<displayOrder>130</displayOrder>

<alternativeIdentifier>TesteRota</alternativeIdentifier>

<active>true</active>

<validateTasksOnField>0</validateTasksOnField>

<exclusive>false</exclusive>

<itineraryDefault>false</itineraryDefault>

</itinerary>

<agent>

<id>38765</id>

<name>Usuario1</name>

<login>usuario1</login>

<active>true</active>

<alternativeIdentifier>usuario1</alternativeIdentifier>

</agent>

</itineraryAgent>

Remoção de um Agente de Rota em específico

Usando o Id:

DELETE /CenterWeb/api/{$apiKey}/itineraryAgent/{$id}.xml

{$id} = Identificador interno do agente da rota

Usando o Identificador Alternativo:

DELETE /CenterWeb/api/{$apiKey}/itineraryAgent/itinerary/{$itineraryAltId}/agent{$agentAltId}.xml

{$itineraryAltId} = Identificador alternativo da Rota

{$agentAltId} = Identificador alternativo do agente

Rotas e relacionados (Itinerary Agent (Agentes das Rotas))