TeamType (Tipo de Equipe)

A API de TeamType é responsável pela manutenção dos tipos de equipe. É nela que vamos conseguir criar um tipo de equipe para posterior associação em equipes.

Descrição de um Tipo de Equipe

OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.

Busca Por Lista de Tipos de Equipe

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

Enviar parâmetros para a API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:

<result>

<resourceName>teamType</resourceName>

<size>2</size>

<entries>

<entry id="132" link="/teamType/132.xml"/>

<entry id="133" link="/teamType/133.xml"/>

</entries>

</result>

A resposta da requisição será uma mensagem contendo o total de registro retornados e uma lista simples, sem detalhes de cada registro retornado, contendo para cada entrada, Id do registro no uMov.me e o link, que pode ser usado para recuperar os dados específicos deste registro.

Busca de um tipo de equipe específico

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

Esta operação serve para puxar informações de um tipo de equipe do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<teamType>

<id>132</id>

<description>Vendedores</description>

<alternativeIdentifier>Venda</alternativeIdentifier>

<active>true</active>

</teamType>

Inclusão de um Tipo de Equipe

POST /CenterWeb/api/{$apiKey}/teamType.xml

Esta operação serve para incluir um tipo de equipe no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo registro no ambiente em questão. Confira a descrição de um Tipo de Equipe para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<teamType>

<description>Vendedores</description>

<alternativeIdentifier>Venda</alternativeIdentifier>

</teamType>

Atualização de um Tipo de Equipe

POST /CenterWeb/api/{$apiKey}/teamType/{$id}.xml

Esta operação permite atualizar informações de um tipo de equipe enviando apenas os dados desejados:

<teamType>

<description>Entregadores</description>

<alternativeIdentifier>Entregadores</alternativeIdentifier>

</teamType>