Rotas e relacionados (Itinerary ServiceLocal (Locais das Rotas))

Inclusão de locais das rotas em lote

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

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

<itineraryServiceLocals>

<itineraryServiceLocal>

<serviceLocal>

<id>1036699</id>

</serviceLocal>

<itinerary>

<id>25156</id>

</itinerary>

<treatmentOrder>1</treatmentOrder>

</itineraryServiceLocal>

<itineraryServiceLocal>

<serviceLocal>

<id>895259</id>

</serviceLocal>

<itinerary>

<id>25156</id>

</itinerary>

<treatmentOrder>2</treatmentOrder>

</itineraryServiceLocal>

</itineraryServiceLocals>

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

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

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

Ex:

<result>

<resourceName>itineraryServiceLocals</resourceName>

<size>2</size>

<entries>

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

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

</entries>

</result>

Atenção: Para cada <itineraryServiceLocal> deve ser informado o campo <treatmentOrder> para definir a ordem que o local será incluído na rota e visualizada no mobile.

Busca Por Lista de Locais de Rotas

GET /CenterWeb/api/{$apiKey}/itineraryServiceLocal.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}/itineraryServiceLocal.xml?serviceLocal=895259

ServiceLocal: pesquisar por um determinado local nas rotas

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

itinerary: pesquisar os locais de uma determinada rota

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

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

Busca por um Local da Rota em específico

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

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

<itineraryServiceLocal>

<id>168143</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>

<serviceLocal>

<id>1036699</id>

<description>uMov.me</description>

<active>true</active>

<alternativeIdentifier>uMov.me</alternativeIdentifier>

<corporateName>uMov.me</corporateName>

</serviceLocal>

<treatmentOrder>0</treatmentOrder>

</itineraryServiceLocal>

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

Usando o Id:

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

{$id} = Identificador interno do local da rota

Usando o Identificador Alternativo:

DELETE /CenterWeb/api/{$apiKey}/itineraryServiceLocal/itinerary/{$itineraryAltId}/serviceLocal{$serviceLocalAltId}.xml

{$itineraryAltId} = Identificador alternativo da Rota

{$serviceLocalAltId} = Identificador alternativo do Local