TeamWherx

O TeamWherx(TW) é uma plataforma de gerenciamento de serviços all-in-one que ajuda você a gerenciar com mais eficiência suas equipes remotas de funcionários e operações comerciais gerais longe do escritório. Como uma solução baseada em nuvem, a TW habilita a coleta de dados remota e a exibe por meio de seu painel de aplicativo Web, fornecendo aos gerentes a visão adicional de que precisam para criar estratégias mais inteligentes para aumentar a eficiência, a produtividade e os custos reduzidos enquanto coordenam suas forças de trabalho móveis.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte do Actoft
URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

Metadados do conector
Publicador	Actoft
Site	https://actsoft.com
Política de privacidade	https://www.actsoft.com/privacy
Categorias	Produtividade

Descrição do conector:

O TeamWherx permite que você crie e capture informações de formulário digital, informações de manutenção de tempo do funcionário e gerencie ordens de trabalho com um sistema de expedição.

Descrição detalhada

O conector TeamWherx permite que os usuários se conectem e troquem informações entre várias plataformas. Você pode animar seus dados para criar fluxos de processo, impulsionar seus outros aplicativos internos e informar análises avançadas. Automatize e simplifique seus processos diários, semanais ou mensais com acesso a up-todados acionáveis do momento.

Pré-requisitos de ##

Para usar esse conector, você precisará do seguinte:

Conta do TeamWherx
Chave de API TeamWherx
Plano do Microsoft Power Apps ou do Power Automate

## Como obter credenciais

Portal do Desenvolvedor de API

Para acessar o conector, primeiro você deve configurar um nome de usuário e uma senha para o portal do Desenvolvedor de API e assinar a API do Cliente:

De dentro do aplicativo, vá para a Instalação daAPIde Configurações Administrativas>>.
Escolha Criar Credenciais.
Insira seu nome e sobrenome nos campos apropriados.
Insira seu endereço de email no campo Endereço de email.
Escolha Salvar & convite por email. Em seguida, verifique seu email para obter instruções sobre como criar uma senha.
Uma vez dentro do email de convite, clique em EscolherSenha, que abrirá uma caixa de diálogo que permitirá que você crie uma senha.
Escolha Salvar senha.
Para prosseguir para o portal do desenvolvedor, de dentro do aplicativo, acesseConfigurações Administrativas>>Acesseo portal do desenvolvedor.
No portal do Desenvolvedor, escolha Produtos e selecione APIdo Cliente.
Escolha Assinar.

Chave de API

Agora que você é um usuário de API registrado, uma sequência alfanumérica, chamada de chave, foi gerada para você. Você precisará dessa chave para trabalhar com seus dados na API.

Para localizar sua chave de API:

Escolha Produtos no menu Portal do Desenvolvedor. Os produtos de API disponíveis em sua licença serão exibidos.
Selecione a versão da API do Cliente , em "Você tem assinaturas X para este produto".
Escolha Mostrar ao lado da chave Primária para sua assinatura.
Selecione o conteúdo do campo, clique com o botão direito do mouse e escolha Copiar. A chave agora está salva na área de transferência e pronta para colar.

## Introdução ao conector

Vá para Meus fluxos>Novo fluxo e selecione Fluxo de nuvem automatizado.
Escolha disparar manualmente um fluxo na caixa de diálogo Criar um fluxo de nuvem automatizado.
Nomeie seu fluxo ou permita que o sistema gere um automaticamente.
Pesquise e escolha um gatilho para o fluxo.
Escolha Criar.
No campo de pesquisa, pesquise e escolha o conector TeamWherx.
Localize a ação que você deseja executar com o conector.

O sistema solicitará que você faça logon em todos os aplicativos necessários para executar a ação escolhida, ignorando qualquer um em que você já esteja conectado.

Insira um nome para o novo conector no campo Conector.
Em seguida, insira sua chave de API.
Escolha Criar. A primeira etapa no fluxo do processo é exibida como a primeira "caixa" em um fluxograma.
Escolha Novaetapa para continuar adicionando mais ações e etapas ao fluxo de processo do conector.
Escolha Salvar.

**Usando o conector – Exemplo de pesquisa de status da ordem
** As instruções abaixo mostram como criar um fluxo de processo para inserir linhas em uma planilha e inserir dados de identificação do funcionário que atualizou o pedido quando um status de pedido é atualizado.

Vá para Conectores.
Pesquise e escolha o conector [TeamWherx].
Escolha a pesquisa de status de ordem na listagem de ações.
Insira um nome para sua nova conexão no campo Nome da conexão .
Em seguida, insira sua chave de API.
Escolha Criar. A primeira etapa no fluxo do processo é exibida como a primeira "caixa" em um fluxograma.

Cada caixa de diálogo de ação nas etapas do fluxo de conexão terá campos de propriedade que você pode personalizar para controlar a ação executada.

Continuando com o exemplo, escolha se deseja que os valores de campo do Forms sejam exibidos (parâmetro excludeFormData).
Escolha a versão da API X para a conexão.
Escolha a próxima etapa para definir a ação que você deseja que ocorra quando um status de pedido for alterado.
Na caixa de diálogo Escolher uma operação , use o campo de pesquisa para localizar o aplicativo e, em seguida, a ação desejada. Por exemplo, se você quisesse inserir uma linha em uma planilha do Google sempre que um status de pedido for alterado, você escolheria o GoogleSheets e inseriria a linha para a ação.
Na caixa de diálogo Inserirlinha a seguir, clique no campo Arquivo e escolha o arquivo que conterá seus resultados.
No campo Planilha , escolha o tipo de planilha de dados . Os campos exibidos dinamicamente são as colunas de dados na planilha.
Clique no campo para cada coluna e escolha uma propriedade na listagem de propriedades de pesquisa de status de ordem . Ou você pode usar o campo de pesquisa para encontrar uma propriedade específica.
Você pode inserir mais de uma propriedade em cada campo de coluna; na coluna Evento, escolha StatusLabel, insira um traço e escolha StatusStartDate. Isso significa que, para cada atualização de status do pedido, o Rótulo de Status e a Data de Início do Status serão gravados na coluna Evento na nova linha.
Selecione Novaetapa. Como uma observação de lado, você sempre pode focalizar e clicar no conector de seta para inserir uma nova etapa
Na caixa de diálogo Escolher uma operação, selecione o conector TeamWherx novamente e, em seguida, crie um cliente para a ação.

Novamente, cada campo exibido na caixa de diálogo representará uma coluna na planilha Planilhas do Google. Clique em cada campo para ativar a listagem de propriedades de pesquisa de status de ordem e selecione as propriedades desejadas.

Para este exemplo, escolha EmployeeNumber para o campo Nome , para identificar o funcionário que atualizou o status do pedido.
Escolha GroupName e insira-o também no campo Nome .
Escolha Salvar.

Agora, você criou um fluxo de processo que atualizará sua planilha com o número do funcionário e seu grupo associado sempre que um status de pedido for atualizado.

## Problemas e limitações conhecidos

Os uploads binários de arquivo de áudio (POST) para todos os pontos de extremidade são limitados apenas a MP4.
As datas para todos os pontos de extremidade que exigem informações de data e hora devem ser especificadas de acordo com as diretrizes de RFC3339, como no exemplo a seguir: 2021-09-22T02:36:56.52Z. Não é necessário especificar os segundos exatos no carimbo de data/hora; 00 é aceitável.

## Erros e soluções comuns

Exemplos de erros comuns que podem ocorrer, códigos de resposta e correções podem ser encontrados nos Portal dos Desenvolvedores de API:

Bis- https://developer.wfmplatform.com/

Perguntas frequentes sobre ##

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	secureString	A chave de API para esta api	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Assinar o web hook de dados GPS	Adiciona um novo gancho da Web de dados de rastreamento de GPS (posições gps). Os ganchos da Web permitem que você receba posições gps que ocorrem em uma URL especificada.
Assinar o web hook de eventos	Adiciona uma nova assinatura de web hook de eventos. Os ganchos da Web permitem que você receba notificações automáticas sobre eventos da empresa que ocorrem em uma URL especificada.
Ativar um usuário	Ativa um usuário existente por sua ID.
Ativar um veículo	Ativar um veículo por ID.
Atualizar o status do pedido	Altera um status de pedido existente.
Atualizar parte de um usuário	Atualiza parte das propriedades do usuário.
Atualizar um cliente	Atualiza um cliente existente.
Atualizar um pedido	Atualiza um pedido existente.
Atualizar um usuário	Atualiza um usuário existente.
Atualizar um veículo	Atualize um veículo por ID.
Atualizar uma cerca geográfica existente	Atualiza uma cerca geográfica existente por sua ID.
Atualização parcial de um veículo	Atualizar parcialmente um veículo por ID.
Cancelar assinatura do web hook de dados GPS	Exclui uma assinatura do web hook de dados GPS por sua ID.
Cancelar assinatura do web hook de eventos	Exclui uma assinatura de web hook de eventos por sua ID.
Carregar arquivo binário	Use essa opção para carregar imagens de formulário e arquivos de áudio. O tamanho binário é limitado a 10 MB. Os tipos de arquivo com suporte são: JPEG, PNG e MP4.
Carregar arquivo de anexo	Use essa opção para carregar anexos de arquivo de formulário. O tamanho binário é limitado a 25 MB. Solicitação de dados multipart/form esperada com um único arquivo.
Criar ou atualizar registro de lista personalizado	Cria ou atualiza o registro de dados da lista personalizada. O valor da coluna exclusiva pode ser omitido, mas, se presente, ele deve corresponder ao valor da ID Exclusiva no parâmetro de consulta.
Criar ou atualizar uma definição de evento personalizado	Cria ou atualiza uma definição de evento personalizada.
Criar um cliente	Cria um novo cliente.
Criar um formulário	Adiciona um novo formulário.
Criar um usuário	Cria um novo usuário.
Criar um veículo	Cria um veículo.
Criar uma cerca geográfica	Cria uma nova cerca geográfica.
Crie um pedido	Adiciona uma nova ordem.
Desativar um usuário	Desativa um usuário existente por sua ID.
Desativar um veículo	Desativar um veículo por ID.
Enviar evento	Envia o evento.
Excluir registro de lista personalizado	Exclui o registro existente na lista personalizada por sua id e customListId. id – é um valor exclusivo do registro de lista personalizado. Erros: 404 – customListId ou id não encontrada.
Excluir um cliente	Exclui um cliente existente por sua ID.
Excluir um veículo	Exclua um veículo por ID.
Excluir uma cerca geográfica	Exclui uma cerca geográfica existente por sua ID.
Excluir uma definição de evento personalizado	Exclui uma definição de evento personalizada.
Obter dados de lista personalizados por CustomListID	Recupera todos os registros de dados em uma única lista personalizada usando o CustomListID. Os resultados são classificados por coluna e há suporte para paginação. Erros: 404 – não há uma lista personalizada para customListId fornecida.
Obter definições de lista personalizada	Recupera uma listagem de definição de Lista Personalizada. A listagem de definição contém CustomListID, Name e Version para todas as listas personalizadas existentes.
Obter entradas de dados GPS	Recupera entradas de dados GPS para um intervalo de datas especificado. Também retorna um token de continuação e um link para obter a próxima parte de dados. Você pode especificar o número de páginas retornadas e o número de elementos por página. As posições para usuários/veículos excluídos não são retornadas. No entanto, se o usuário/veículo existir quando os dados foram solicitados e posteriormente removidos, os dados do usuário/veículo solicitados por um token de continuação serão retornados. Os resultados são classificados automaticamente por UtcTime e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter listagem de campos de lista personalizados por CustomListID	Recupera uma lista de campos para uma única lista personalizada, usando o CustomListID.
Obter um cliente	Recupera um objeto cliente por sua ID.
Obter um formulário	Recupera um formulário por sua ID.
Obter um pedido	Obtém uma ordem existente por sua ID.
Obter um usuário	Obtém um usuário por sua ID.
Obter um veículo por ID	Recupera um único veículo por ID.
Obter um único registro da lista personalizada	Recupera o registro de dados de lista personalizado único encontrado por CustomListId e o valor exclusivo da coluna. Erros: 404 – não há nenhum registro de lista personalizado para customListId fornecido e valor de coluna exclusivo
Obter uma cerca geográfica	Recupera uma cerca geográfica por sua ID.
Obter uma definição de evento personalizada por ID	Recupera uma única definição de evento personalizado por ID.
Obter uma entrada de manutenção de tempo	Recupera uma entrada por sua ID.
Obter uma lista de assinaturas	Recupera uma lista de assinaturas de web hook. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubscriptionId e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de assinaturas de web hook de eventos	Recupera uma lista de assinaturas de web hook de eventos. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubscriptionId e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de cercas geográficas	Recupera uma lista de cercas geográficas. Você pode especificar o número de páginas retornadas e o número de elementos por página, bem como se as coordenadas de cerca geográfica são métricas. Os resultados são classificados automaticamente por Nome e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de clientes	Recupera uma lista de clientes. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por Nome e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de definições de eventos personalizados	Recupera uma lista de definições de evento personalizadas.
Obter uma lista de entradas de manutenção de tempo	Recupera uma lista de entradas de manutenção de tempo com base no intervalo de datas. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente pelo ClockInTime e, em seguida, por TimekeepingStatusId e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de eventos	Recupera uma lista de eventos para um período de tempo específico. Você pode especificar o número de páginas retornadas e o número de elementos por página. Filtrar por tipo de evento para obter eventos específicos. Os eventos do veículo poderão ser retornados para um funcionário se o funcionário estiver associado ao veículo.
Obter uma lista de formulários	Recupera uma lista de formulários usando qualquer um dos filtros dos parâmetros de solicitação mostrados abaixo. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubmittedTime e em ordem decrescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de pedidos	Recupera uma lista de pedidos usando os filtros dos parâmetros de solicitação mostrados abaixo. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por Client.Name e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de usuários	Recupera uma lista de usuários. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por UserId e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter uma lista de veículos	Recupera uma lista de veículos.
Obter uma lista de viagens	Recupera uma lista de viagens para um período de tempo específico. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por StartUtcTIme e em ordem crescente. Os parâmetros de classificação não são configuráveis.
Obter versão secundária	Retorna a versão secundária atual da API.
Redefine o status da assinatura	Altera o status da assinatura para o status = 1 ("Em execução").
Redefine o status da assinatura do web hook de eventos	Altera o status da assinatura para o status = 1 ("Em execução").
Retorno de chamada de gancho da Web com feed de eventos	Este método de exemplo é usado por eventos/assinatura para postar o feed de dados de eventos usando a URL fornecida pelo cliente.
Retorno de chamada de webhook com feed de dados GPS	Este método de exemplo é usado por gpsdata/subscribe para o feed de dados pós-back usando a URL fornecida pelo cliente.

Assinar o web hook de dados GPS

ID da operação:: TrackingController_SubscribeToGpsDataFeed

Adiciona um novo gancho da Web de dados de rastreamento de GPS (posições gps). Os ganchos da Web permitem que você receba posições gps que ocorrem em uma URL especificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
URL	Url		string	Url que contém o endereço do WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de segurança associado a este WebHookSubscriptionParamsApiModel.

Retornos

Corpo: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Assinar o web hook de eventos

ID da operação:: EventController_SubscribeToEventDataFeed

Adiciona uma nova assinatura de web hook de eventos. Os ganchos da Web permitem que você receba notificações automáticas sobre eventos da empresa que ocorrem em uma URL especificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
URL	Url		string	Url que contém o endereço do WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de segurança associado a este WebHookSubscriptionParamsApiModel.

Retornos

Corpo: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Ativar um usuário

ID da operação:: UserController_Activate

Ativa um usuário existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Ativar um veículo

ID da operação:: VehicleController_Activate

Ativar um veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

response: integer

Atualizar o status do pedido

ID da operação:: OrderController_ChangeStatus

Altera um status de pedido existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
Número do Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo do StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Pontualmente, este Status NewOrderStatusApiModel foi iniciado.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualizar parte de um usuário

ID da operação:: UserController_PartialUpdate

Atualiza parte das propriedades do usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualizar um cliente

ID da operação:: ClientController_Update

Atualiza um cliente existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
ExternalId	ExternalId		string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
FieldIndex	FieldIndex		integer	Índice de campo.
Value	Value			Valor do campo.
Nome	Name		string	Nome do cliente.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	PhoneNumber do ContactApiModel.
Email	Email		string	Email do ContactApiModel.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualizar um pedido

ID da operação:: OrderController_Update

Atualiza um pedido existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
ExternalOrderId	ExternalOrderId		string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
IsClosed	IsClosed		boolean	Status mostrando se o UpdateOrderApiModel fechou.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	PhoneNumber do ContactApiModel.
Email	Email		string	Email do ContactApiModel.
Data de Conclusão	DueDate		date-time	Pontualmente, este BaseUpdateOrderApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime		date-time	Pontualmente, esse BaseUpdateOrderApiModel deve ser iniciado (introduzido na v1.3).
EndTime	EndTime		date-time	Pontualmente, esse BaseUpdateOrderApiModel deve terminar (introduzido na v1.3).
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Número do Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo do StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Pontualmente, este Status NewOrderStatusApiModel foi iniciado.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
FieldIndex	FieldIndex		integer	Índice de campo.
Value	Value			Valor do campo.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualizar um usuário

ID da operação:: UserController_Update

Atualiza um usuário existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
UserName	UserName		string	UserName do Usuário.
Senha	Password		password	Senha do usuário.
GroupName	GroupName		string	Nome do grupo do usuário.
Primeiro Nome	FirstName		string	Nome do usuário.
LastName	LastName		string	Sobrenome do Usuário.
Número do Funcionário	EmployeeNumber		string	Número do funcionário do Usuário.
Email	Email		string	Endereço de email do Usuário.
Telefone	Phone		string	Número de telefone do Usuário.
RoleId	RoleId		integer	RoleId do Usuário – (Administrador: 1, Usuário: 3, Usuário do Power: 5).
IsActive	IsActive		boolean	Status ativo do Usuário.
EPTTEnabled	EPTTEnabled		boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booliano.
EPTTNumber	EPTTNumber		string	Número de telefone para o recurso Push-to-Talk avançado para Usuário: cadeia de caracteres.
EPTTWebMDN	EPTTWebMDN		string	Número de telefone usado para autenticar o usuário no sistema EPTT do Kodiak – Fornecido pelo Kodiak.
EPTTToken	EPTTToken		string	Token de API usado para autenticar o usuário no sistema EPTT kodiak – fornecido pelo Kodiak.
GPSEnabled	GPSEnabled		boolean	Status do recurso GPS para o usuário.
MobileOnly	MobileOnly		boolean	Status do acesso ao aplicativo Web da área de trabalho para CAB – (Sem Acesso ao WebApp: True, Acesso Completo ao Aplicativo: False).
LicenseType	LicenseType		integer	Tipo de Licença atribuída ao usuário: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualizar um veículo

ID da operação:: VehicleController_UpdateVehicle

Atualize um veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
Número	Number		string
Nome	Name		string
Tipo	Type		string
Etiqueta	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Fazer	Make		string
Ano	Year		integer
Modelo	Model		string
Cor	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Tipo de Dispositivo	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

response: integer

Atualizar uma cerca geográfica existente

ID da operação:: GeofenceController_UpdateGeofence

Atualiza uma cerca geográfica existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	integer	ID de cerca geográfica.
GroupNames	GroupNames		array of string	GroupPaths do GeofenceUpdateApiModel.
Latitude	Latitude		double
Longitude	Longitude		double
Nome	Name		string	Nome do GeofenceApiModelBase.
Tipo	Type		string	Tipo de GeofenceApiModel.
Shape	Shape		integer	Forma: 0 para círculo e 1 para polígono.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Raio	Radius		double	Raio do GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress do GeofenceApiModel.
useMetric	useMetric		boolean	Use o sistema de métricas ou não.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Atualização parcial de um veículo

ID da operação:: VehicleController_PartialUpdateVehicle

Atualizar parcialmente um veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Cancelar assinatura do web hook de dados GPS

ID da operação:: TrackingController_RemoveGpsDataFeedSubscription

Exclui uma assinatura do web hook de dados GPS por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
subscriptionId	subscriptionId	True	string	ID da assinatura a ser excluída.

Cancelar assinatura do web hook de eventos

ID da operação:: EventController_RemoveEventDataFeedSubscription

Exclui uma assinatura de web hook de eventos por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
subscriptionId	subscriptionId	True	string	ID da assinatura a ser excluída.

Carregar arquivo binário

ID da operação:: BinaryController_UploadBinary

Use essa opção para carregar imagens de formulário e arquivos de áudio. O tamanho binário é limitado a 10 MB. Os tipos de arquivo com suporte são: JPEG, PNG e MP4.

Retornos

Corpo: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Carregar arquivo de anexo

ID da operação:: BinaryController_UploadAttachment

Use essa opção para carregar anexos de arquivo de formulário. O tamanho binário é limitado a 25 MB. Solicitação de dados multipart/form esperada com um único arquivo.

Retornos

Corpo: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Criar ou atualizar registro de lista personalizado

ID da operação:: CustomListController_PutRecord

Cria ou atualiza o registro de dados da lista personalizada. O valor da coluna exclusiva pode ser omitido, mas, se presente, ele deve corresponder ao valor da ID Exclusiva no parâmetro de consulta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor exclusivo.
ColumnIndex	ColumnIndex		integer	Índice de coluna de lista personalizado.
Legenda	Caption		string	Legenda de coluna de lista personalizada.
Value	Value			Valor da coluna de lista personalizada.

Criar ou atualizar uma definição de evento personalizado

ID da operação:: EventController_Put

Cria ou atualiza uma definição de evento personalizada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	ID de definição de evento.
Nome	Name		string
ReverseGeocode	ReverseGeocode		boolean
Nome	Name		string
Tipo	Type		integer
Legenda	Caption		string
Obrigatório	Required		boolean

Criar um cliente

ID da operação:: ClientController_Create

Cria um novo cliente.

Parâmetros

Nome	Chave	Tipo	Description
ExternalId	ExternalId	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
FieldIndex	FieldIndex	integer	Índice de campo.
Value	Value		Valor do campo.
Nome	Name	string	Nome do cliente.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 deste LocationApiModel.
City	City	string	Cidade do LocationApiModel.
Nome da Região	RegionName	string	Nome da região do LocationApiModel.
Código Postal	PostalCode	string	Cep do LocationApiModel.
Código do País	CountryCode	string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregião do LocationApiModel.
RegionCode	RegionCode	string	Código de região do LocationApiModel.
Nome	Name	string	Nome do ContactApiModel.
Número de telefone	PhoneNumber	string	PhoneNumber do ContactApiModel.
Email	Email	string	Email do ContactApiModel.
geocódigo	geocode	boolean	O endereço deve ser geocodificado ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Criar um formulário

ID da operação:: FormController_PostFormAsync

Adiciona um novo formulário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ApiModuleId	ApiModuleId		string	ID do ApiModule associado a este CreateStandaloneFormApiModel.
Revisto	Reviewed		boolean	Status da revisão deste CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId do Usuário.
Número do Funcionário	EmployeeNumber		string	Número do funcionário do Usuário.
SubmittedTime	SubmittedTime	True	date-time	Ponto no tempo em que o CreateStandaloneFormApiModel foi enviado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID do campo de API.
Value	Value	True		Valor do FormFieldDataApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Sign" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	Hora em que os dados binários foram capturados. Formato – data e hora (como data e hora em RFC3339), incluindo deslocamento.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID do campo de API.
Value	Value	True		Valor do FormFieldDataApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Sign" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	Hora em que os dados binários foram capturados. Formato – data e hora (como data e hora em RFC3339), incluindo deslocamento.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Criar um usuário

ID da operação:: UserController_Create

Cria um novo usuário.

Parâmetros

Nome	Chave	Tipo	Description
UserName	UserName	string	UserName do Usuário.
Senha	Password	password	Senha do usuário.
GroupName	GroupName	string	Nome do grupo do usuário.
Primeiro Nome	FirstName	string	Nome do usuário.
LastName	LastName	string	Sobrenome do Usuário.
Número do Funcionário	EmployeeNumber	string	Número do funcionário do Usuário.
Email	Email	string	Endereço de email do Usuário.
Telefone	Phone	string	Número de telefone do Usuário.
RoleId	RoleId	integer	RoleId do Usuário – (Administrador: 1, Usuário: 3, Usuário do Power: 5).
IsActive	IsActive	boolean	Status ativo do Usuário.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booliano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Push-to-Talk avançado para Usuário: cadeia de caracteres.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema EPTT do Kodiak – Fornecido pelo Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar o usuário no sistema EPTT kodiak – fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
MobileOnly	MobileOnly	boolean	Status do acesso ao aplicativo Web da área de trabalho para CAB – (Sem Acesso ao WebApp: True, Acesso Completo ao Aplicativo: False).
LicenseType	LicenseType	integer	Tipo de Licença atribuída ao usuário: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Criar um veículo

ID da operação:: VehicleController_CreateVehicle

Cria um veículo.

Parâmetros

Nome	Chave	Tipo
Número	Number	string
Nome	Name	string
Tipo	Type	string
Etiqueta	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Fazer	Make	string
Ano	Year	integer
Modelo	Model	string
Cor	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Tipo de Dispositivo	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Criar uma cerca geográfica

ID da operação:: GeofenceController_CreateGeofence

Cria uma nova cerca geográfica.

Parâmetros

Nome	Chave	Tipo	Description
GroupNames	GroupNames	array of string	GroupPaths do GeofenceCreateApiModel.
Latitude	Latitude	double
Longitude	Longitude	double
Nome	Name	string	Nome do GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo e 1 para polígono.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 deste LocationApiModel.
City	City	string	Cidade do LocationApiModel.
Nome da Região	RegionName	string	Nome da região do LocationApiModel.
Código Postal	PostalCode	string	Cep do LocationApiModel.
Código do País	CountryCode	string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregião do LocationApiModel.
RegionCode	RegionCode	string	Código de região do LocationApiModel.
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.
useMetric	useMetric	boolean	Use o sistema de métricas ou não.
geocódigo	geocode	boolean	O endereço deve ser geocodificado ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Crie um pedido

ID da operação:: OrderController_Create

Adiciona uma nova ordem.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
DataeHoraDaCriação	CreatedDateTime		date-time	Pontualmente, esse CreateUpdateOrderApiModel foi criado.
ExternalClientId	ExternalClientId	True	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
ServiceType	ServiceType	True	string	Tipo de serviço associado a este CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	PhoneNumber do ContactApiModel.
Email	Email		string	Email do ContactApiModel.
Data de Conclusão	DueDate		date-time	Pontualmente, este BaseUpdateOrderApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime		date-time	Pontualmente, esse BaseUpdateOrderApiModel deve ser iniciado (introduzido na v1.3).
EndTime	EndTime		date-time	Pontualmente, esse BaseUpdateOrderApiModel deve terminar (introduzido na v1.3).
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Número do Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo do StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Pontualmente, este Status NewOrderStatusApiModel foi iniciado.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 deste LocationApiModel.
City	City		string	Cidade do LocationApiModel.
Nome da Região	RegionName		string	Nome da região do LocationApiModel.
Código Postal	PostalCode		string	Cep do LocationApiModel.
Código do País	CountryCode		string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregião do LocationApiModel.
RegionCode	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Value	Value			Valor do UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Câmera" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de uma imagem carregada (consulte carregar a API binária) "Observação": cadeia de caracteres // Observação para a imagem referenciada } Formato de valor de campo "Signature" (referência binária): { "BinaryId": cadeia de caracteres // ID binária de uma imagem carregada (consulte carregar a API binária) } Formato de valor de campo "Áudio" (referência binária): { "BinaryId": cadeia de caracteres, // ID binária de um áudio carregado (consulte carregar a API binária) "DurationSeconds": número // Duração do áudio em segundos }
CapturedTime	CapturedTime		date-time	O valor pontual foi capturado.
FieldIndex	FieldIndex		integer	Índice de campo.
Value	Value			Valor do campo.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.

Retornos

Corpo: CustomerAPI.Models.ReturnIdApiModel

Desativar um usuário

ID da operação:: UserController_Deactivate

Desativa um usuário existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Desativar um veículo

ID da operação:: VehicleController_Deactivate

Desativar um veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

response: integer

Enviar evento

ID da operação:: EventController_Post

Envia o evento.

Parâmetros

Nome	Chave	Tipo	Description
EventDefinitionId	EventDefinitionId	string	ID de definição de evento.
Número do Funcionário	EmployeeNumber	string	Número do funcionário.
Número de Veículos	VehicleNumber	string	Número do veículo.
DeviceSerialNumber	DeviceSerialNumber	string	Número de série gpsDeviceDto.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 deste LocationApiModel.
City	City	string	Cidade do LocationApiModel.
Nome da Região	RegionName	string	Nome da região do LocationApiModel.
Código Postal	PostalCode	string	Cep do LocationApiModel.
Código do País	CountryCode	string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregião do LocationApiModel.
RegionCode	RegionCode	string	Código de região do LocationApiModel.
Hora	Time	date-time
Parâmetros	Parameters	object	Parâmetros de evento.

Excluir registro de lista personalizado

ID da operação:: CustomListController_DeleteRecord

Exclui o registro existente na lista personalizada por sua id e customListId.

id – é um valor exclusivo do registro de lista personalizado.

Erros:

404 – customListId ou id não encontrada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor exclusivo.

Excluir um cliente

ID da operação:: ClientController_Delete

Exclui um cliente existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	ID do cliente.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Excluir um veículo

ID da operação:: VehicleController_Delete

Exclua um veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Excluir uma cerca geográfica

ID da operação:: GeofenceController_DeleteGeofence

Exclui uma cerca geográfica existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	integer	ID de cerca geográfica.

Excluir uma definição de evento personalizado

ID da operação:: EventController_Delete

Exclui uma definição de evento personalizada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	ID de definição de evento.

Obter dados de lista personalizados por CustomListID

ID da operação:: CustomListController_GetCustomList

Recupera todos os registros de dados em uma única lista personalizada usando o CustomListID.

Os resultados são classificados por coluna e há suporte para paginação.

Erros:

404 – não há uma lista personalizada para customListId fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
pageNumber	pageNumber		integer	Inicie o número da página.
pageSize	pageSize		integer	Tamanho da página.

Retornos

Contêiner para matriz de dados de coluna de lista personalizada.

Corpo: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obter definições de lista personalizada

ID da operação:: CustomListController_Get

Recupera uma listagem de definição de Lista Personalizada. A listagem de definição contém CustomListID, Name e Version para todas as listas personalizadas existentes.

Retornos

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Obter entradas de dados GPS

ID da operação:: TrackingController_GetGpsData

Recupera entradas de dados GPS para um intervalo de datas especificado. Também retorna um token de continuação e um link para obter a próxima parte de dados. Você pode especificar o número de páginas retornadas e o número de elementos por página.

As posições para usuários/veículos excluídos não são retornadas. No entanto, se o usuário/veículo existir quando os dados foram solicitados e posteriormente removidos, os dados do usuário/veículo solicitados por um token de continuação serão retornados.

Os resultados são classificados automaticamente por UtcTime e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Tipo	Description
fromDate	fromDate	date-time	Início do intervalo de datas. Recomendação: use grandes intervalos de datas (>=4 horas) em vez de intervalos de datas pequenos.
toDate	toDate	date-time	Término do intervalo de datas. Recomendação: use grandes intervalos de datas (>=4 horas) em vez de intervalos de datas pequenos.
númeroDoFuncionário	employeeNumber	string	Número do funcionário.
Vin	vin	string	Número vin do veículo.
useMetric	useMetric	boolean	Use o sistema de métricas ou não.
símbolo	token	string	Token de continuação retornado pela chamada inicial e deve ser usado na chamada sucessiva.

Retornos

Corpo: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Obter listagem de campos de lista personalizados por CustomListID

ID da operação:: CustomListController_GetById

Recupera uma lista de campos para uma única lista personalizada, usando o CustomListID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.

Retornos

Modelo de lista personalizado.

Corpo: CustomerAPI.Models.CustomLists.CustomListApiModel

Obter um cliente

ID da operação:: ClientController_Get

Recupera um objeto cliente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	ID do cliente.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.Client.ReadClientApiModel

Obter um formulário

ID da operação:: FormController_GetFormAsync

Recupera um formulário por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	integer	ID do formulário.

Retornos

Corpo: CustomerAPI.Models.Forms.StandaloneFormApiModel

Obter um pedido

ID da operação:: OrderController_GetOrder

Obtém uma ordem existente por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
include-status-history	include-status-history		string	Se for true, a resposta conterá todos os dados de formulário e histórico de status para essa ordem.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.Order.OrderApiModel

Obter um usuário

ID da operação:: UserController_Get

Obtém um usuário por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Corpo: CustomerAPI.Models.User.ReadUserApiModel

Obter um veículo por ID

ID da operação:: VehicleController_GetVehicle

Recupera um único veículo por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	A ID externa ou interna depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use a ID externa ou não.

Retornos

Modelo de dados do veículo.

Corpo: CustomerAPI.Models.Vehicles.VehicleReadApi

Obter um único registro da lista personalizada

ID da operação:: CustomListController_GetSingleRecord

Recupera o registro de dados de lista personalizado único encontrado por CustomListId e o valor exclusivo da coluna.

Erros:

404 – não há nenhum registro de lista personalizado para customListId fornecido e valor de coluna exclusivo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor exclusivo.

Retornos

Contêiner para matriz de dados de coluna de lista personalizada.

Corpo: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obter uma cerca geográfica

ID da operação:: GeofenceController_GetGeofence

Recupera uma cerca geográfica por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	integer	ID de cerca geográfica.
useMetric	useMetric		boolean	Use o sistema de métricas ou não.

Retornos

Corpo: CustomerAPI.Models.Geofence.GeofenceApiModel

Obter uma definição de evento personalizada por ID

ID da operação:: EventController_Get

Recupera uma única definição de evento personalizado por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	ID de definição de evento.

Retornos

Modelo de definição de evento personalizado.

Corpo: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obter uma entrada de manutenção de tempo

ID da operação:: TimekeepingController_GetTimekeepingEntryAsync

Recupera uma entrada por sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
id	id	True	string	Id do registro.

Retornos

Corpo: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obter uma lista de assinaturas

ID da operação:: TrackingController_GetSubscriptions

Recupera uma lista de assinaturas de web hook. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubscriptionId e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Retornos

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obter uma lista de assinaturas de web hook de eventos

ID da operação:: EventController_GetSubscriptions

Recupera uma lista de assinaturas de web hook de eventos. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubscriptionId e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Retornos

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obter uma lista de cercas geográficas

ID da operação:: GeofenceController_GetGeofences

Recupera uma lista de cercas geográficas. Você pode especificar o número de páginas retornadas e o número de elementos por página, bem como se as coordenadas de cerca geográfica são métricas. Os resultados são classificados automaticamente por Nome e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Tipo	Description
pageNumber	pageNumber	integer	Inicie o número da página. O padrão é 1.
pageSize	pageSize	integer	Tamanho da página. O padrão é 500.
useMetric	useMetric	boolean	Use o sistema de métricas ou não.

Retornos

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Obter uma lista de clientes

ID da operação:: ClientController_GetClients

Recupera uma lista de clientes. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por Nome e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
pageNumber	pageNumber		integer	Inicie o número da página.
pageSize	pageSize		integer	Tamanho da página.

Retornos

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Obter uma lista de definições de eventos personalizados

ID da operação:: EventController_GetList

Recupera uma lista de definições de evento personalizadas.

Retornos

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obter uma lista de entradas de manutenção de tempo

ID da operação:: TimekeepingController_GetTimekeepingDataList

Recupera uma lista de entradas de manutenção de tempo com base no intervalo de datas. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente pelo ClockInTime e, em seguida, por TimekeepingStatusId e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fromDate	fromDate	True	date-time	Data de início.
toDate	toDate	True	date-time	Data de término.
númeroDoFuncionário	employeeNumber		string	Número do funcionário.
aprovado	approved		boolean	Filtrar somente para entrada aprovada.
closedOnly	closedOnly		boolean	Filtrar somente para entrada fechada.
excludeFormData	excludeFormData		boolean	Filtrar para excluir dados de formulário.
pageNumber	pageNumber		integer	Inicie o número da página (padrão 1).
pageSize	pageSize		integer	Tamanho da página (padrão 1000).

Retornos

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obter uma lista de eventos

ID da operação:: EventController_GetEvents

Recupera uma lista de eventos para um período de tempo específico. Você pode especificar o número de páginas retornadas e o número de elementos por página.

Filtrar por tipo de evento para obter eventos específicos. Os eventos do veículo poderão ser retornados para um funcionário se o funcionário estiver associado ao veículo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fromDate	fromDate	True	date-time	Início do intervalo de datas.
toDate	toDate	True	date-time	Término do intervalo de datas.
númeroDoFuncionário	employeeNumber		string	Número do funcionário.
vehicleNumber	vehicleNumber		string	Número do veículo.
pageNumber	pageNumber		integer	Inicie o número da página.
pageSize	pageSize		integer	Tamanho da página.
eventType	eventType		integer	Filtrar por tipo de evento. o número do funcionário é especificado: UserEvents(0) – somente eventos de usuário. VehicleEvents(1) – somente eventos de veículo, incluindo eventos de sensor. ExternalEvents(2) – somente eventos externos. o número do veículo é especificado: UserEvents(0) – N/A. VehicleEvents(1) – somente eventos de veículo, incluindo eventos de sensor. ExternalEvents(2) – somente eventos externos. Nem o número do funcionário nem o número do veículo são especificados: UserEvents(0) – somente eventos de usuário. VehicleEvents(1) – somente eventos de veículo, incluindo eventos de sensor. ExternalEvents(2) – somente eventos externos.

Retornos

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Obter uma lista de formulários

ID da operação:: FormController_GetFormsAsync

Recupera uma lista de formulários usando qualquer um dos filtros dos parâmetros de solicitação mostrados abaixo. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por SubmittedTime e em ordem decrescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
submittedStartDate	submittedStartDate	True	date-time	Data de início do formulário enviado.
submittedEndDate	submittedEndDate	True	date-time	Data de término do formulário enviado.
apiModuleId	apiModuleId		string	ID do módulo de formulário.
númeroDoFuncionário	employeeNumber		string	Número do funcionário.
revisado	reviewed		boolean	Recupera apenas formulários revisados ou não. O padrão é nulo para todos.
pageNumber	pageNumber		integer	Número da página inicial. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. O padrão é 1000.

Retornos

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Obter uma lista de pedidos

ID da operação:: OrderController_GetOrders

Recupera uma lista de pedidos usando os filtros dos parâmetros de solicitação mostrados abaixo. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por Client.Name e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
dueDateFrom	dueDateFrom	True	date-time	Filtrar por data de início da data de conclusão.
dueDateTo	dueDateTo	True	date-time	Filtrar por data de término da data de conclusão.
númeroDoFuncionário	employeeNumber		string	Filtrar por número de funcionário.
pageNumber	pageNumber		integer	Inicie o número da página (padrão 1).
pageSize	pageSize		integer	Tamanho da página (padrão 500).

Retornos

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Obter uma lista de usuários

ID da operação:: UserController_GetUsers

Recupera uma lista de usuários. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por UserId e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
pageNumber	pageNumber		integer	Inicie o número da página. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. O padrão é 500.

Retornos

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Obter uma lista de veículos

ID da operação:: VehicleController_GetVehicles

Recupera uma lista de veículos.

Parâmetros

Nome	Chave	Tipo	Description
pageNumber	pageNumber	integer	Número da página.
pageSize	pageSize	integer	Número máximo de itens em uma página. Padrão = 1000. Valor máximo = 2000.
activeOnly	activeOnly	boolean	se verdadeiro – retorna apenas veículos ativos. Valor padrão = false.

Retornos

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Obter uma lista de viagens

ID da operação:: TrackingController_GetTrips

Recupera uma lista de viagens para um período de tempo específico. Você pode especificar o número de páginas retornadas e o número de elementos por página. Os resultados são classificados automaticamente por StartUtcTIme e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
fromDate	fromDate	True	date-time	Início do intervalo de datas. Recomendação: use grandes intervalos de datas (>=4 horas) em vez de intervalos de datas pequenos.
toDate	toDate	True	date-time	Término do intervalo de datas. Recomendação: use grandes intervalos de datas (>=4 horas) em vez de intervalos de datas pequenos.
númeroDoFuncionário	employeeNumber		string	Número do funcionário.
Vin	vin		string	Número vin do veículo.
pageNumber	pageNumber		integer	Inicie o número da página. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. O padrão é 1000.
useMetric	useMetric		boolean	Use o sistema de métricas ou não.

Retornos

response: array of CustomerAPI.Models.Tracking.TripApiModel

Obter versão secundária

ID da operação:: VersionController_Get

Retorna a versão secundária atual da API.

Redefine o status da assinatura

ID da operação:: TrackingController_ResetSubscriptionHealthStatus

Altera o status da assinatura para o status = 1 ("Em execução").

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
subscriptionId	subscriptionId	True	integer	ID da assinatura.

Redefine o status da assinatura do web hook de eventos

ID da operação:: EventController_ResetSubscriptionHealthStatus

Altera o status da assinatura para o status = 1 ("Em execução").

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
subscriptionId	subscriptionId	True	integer	ID da assinatura.

Retorno de chamada de gancho da Web com feed de eventos

ID da operação:: EventController_subscribe_callback

Este método de exemplo é usado por eventos/assinatura para postar o feed de dados de eventos usando a URL fornecida pelo cliente.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Url que contém o endereço do WebHookSubscriptionParamsApiModel.
Tipo de Evento	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	Formato ISO com Local e Offset.
DeviceId	DeviceId	string	ID gpsDeviceDto associada à assinatura.
Tipo de Dispositivo	DeviceType	integer	Tipo gpsDeviceDto: Aparelho (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Identificação de usuário.
VehicleId	VehicleId	integer	ID do veículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Se um usuário vinculado ao veículo.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Parâmetros de evento.

Retornos

response: object

Retorno de chamada de webhook com feed de dados GPS

ID da operação:: TrackingController_subscribe_callback

Este método de exemplo é usado por gpsdata/subscribe para o feed de dados pós-back usando a URL fornecida pelo cliente.

Parâmetros

Nome	Chave	Tipo	Description
ID	Id	string	Url que contém o endereço do WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	ID gpsDeviceDto associada à assinatura.
Tipo de Dispositivo	DeviceType	integer	Tipo gpsDeviceDto: Fone(0), CalAmp(1), Geotab (2), Xirgo (3).
Timestamp	Timestamp	date-time	Formato ISO com Local e Offset.
CompanyId	CompanyId	integer	ID da empresa.
UserId	UserId	integer	Identificação de usuário.
VehicleId	VehicleId	integer	ID do veículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Se um usuário vinculado ao veículo.
LocationProvider	LocationProvider	string	Nome do provedor de localização.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
AccuracyFt	AccuracyFt	double	Precisão da posição (Pés).
AltitudeFt	AltitudeFt	double	Altitude (Pés).
Título	Heading	integer	Direção da bússola em graus.
SpeedMph	SpeedMph	double	Velocidade de movimento (Mph).
BatteryStatus	BatteryStatus	integer	Status da bateria: não carregando(0), Carregando(1).
BatteryLevel	BatteryLevel	integer	Nível de bateria em porcentagem.
ActivityState	ActivityState	integer	Estado da atividade: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	É o dispositivo conectado à rede no momento.
Rssi	Rssi	integer	Indicador de força de sinal recebido.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Miles).
VOdoMl	VOdoMl	double	Veículo Odometer (Miles).

Retornos

response: object

Gatilhos

Pesquisa de manutenção de tempo	O ponto de extremidade de sondagem da API de Manutenção de Tempo permite que seu aplicativo sondar e processar continuamente as entradas de manutenção de tempo enviadas recentemente. Integração: Esse ponto de extremidade foi projetado para funcionar fora da caixa com o Microsoft Flow como uma integração de gatilho de sondagem. Como alternativa, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Uso: Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas: Código de resposta HTTP 200 – Registros de manutenção de tempo enviados recentemente; O corpo da resposta exibirá os dados de entrada de manutenção de tempo. Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Local – A URL da próxima solicitação. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300. Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os necessários para garantir que as entradas de manutenção de tempo não estejam ausentes da solicitação. Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por TimekeepingStatusId e, em seguida, em ordem crescente. Os parâmetros de classificação não são configuráveis. Definição de ModifiedUtc: marca de hora interna = hora da última alteração de status de manutenção de tempo.
Pesquisa de pedidos	O ponto de extremidade de sondagem da API pedidos permite que seu aplicativo sondar e processar continuamente as alterações recentes nos pedidos. Integração: Esse ponto de extremidade foi projetado para funcionar fora da caixa com o Microsoft Flow como uma integração de gatilho de sondagem. Como alternativa, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Uso: Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas: Código de resposta HTTP 200 – Há pedidos alterados recentemente; O corpo da resposta exibirá os dados do pedido. Código de resposta HTTP 202 – Não existem pedidos alterados recentemente; o corpo da resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Local – A URL da próxima solicitação. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300. Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os parâmetros necessários para garantir que as alterações de ordem não estejam ausentes na solicitação. Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por OrderId, em ordem crescente. Os parâmetros de classificação não são configuráveis. Definição de ModifiedUtc: marca de hora interna = hora da última alteração de dados do pedido.
Pesquisa de status do pedido	O ponto de extremidade de sondagem da API statuses de ordem permite que seu aplicativo sondar e processar continuamente as alterações recentes nos pedidos. Integração: Esse ponto de extremidade foi projetado para funcionar fora da caixa com o Microsoft Flow como uma integração de gatilho de sondagem. Como alternativa, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Uso: Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas: Código de resposta HTTP 200 – Registros de status do pedido alterados recentemente; corpo da resposta exibirá dados de status do pedido Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Local – A URL da próxima solicitação. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300. Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os necessários para garantir que os status do pedido não estejam ausentes da solicitação. Os resultados são classificados por ModifiedUtc e, em seguida, por StatusId, em ordem crescente. Os parâmetros de classificação não são configuráveis. Definição de ModifiedUtc: marca de hora interna = hora da alteração de dados de status do pedido mais recente.
Sondagem de dados de formulário	O ponto de extremidade de sondagem da API dos Formulários permite que seu aplicativo sondar e processar continuamente formulários autônomos enviados recentemente. Integração: Esse ponto de extremidade foi projetado para funcionar fora da caixa com o Microsoft Flow como uma integração de gatilho de sondagem. Como alternativa, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Uso: Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas: Código de resposta HTTP 200 – Existem registros de formulário enviados recentemente; o corpo da resposta exibirá os dados do formulário. Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Local – A URL da próxima solicitação. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300. Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os parâmetros necessários para garantir que os formulários não estejam ausentes da solicitação. Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por FormHeaderId, em ordem crescente. Os parâmetros de classificação não são configuráveis. Definição de ModifiedUtc: marca de hora interna = hora da alteração de dados do formulário mais recente.

Pesquisa de manutenção de tempo

ID da operação:: TimekeepingController_Poll

O ponto de extremidade de sondagem da API de Manutenção de Tempo permite que seu aplicativo sondar e processar continuamente as entradas de manutenção de tempo enviadas recentemente.

Integração:

Esse ponto de extremidade foi projetado para funcionar fora da caixa com o Microsoft Flow como uma integração de gatilho de sondagem. Como alternativa, você pode desenvolver sua própria integração personalizada usando qualquer idioma.

Uso:

Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas:

Código de resposta HTTP 200 – Registros de manutenção de tempo enviados recentemente; O corpo da resposta exibirá os dados de entrada de manutenção de tempo.
Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio.

Em ambos os casos, há dois (2) cabeçalhos importantes na resposta:

Local – A URL da próxima solicitação.
Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300.

Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os necessários para garantir que as entradas de manutenção de tempo não estejam ausentes da solicitação.

Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por TimekeepingStatusId e, em seguida, em ordem crescente. Os parâmetros de classificação não são configuráveis.

Definição de ModifiedUtc: marca de hora interna = hora da última alteração de status de manutenção de tempo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
excludeFormData	excludeFormData		boolean	Se for true, ClockInFormData e ClockOutFormData sempre serão nulos.

Retornos

Corpo: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Pesquisa de pedidos

ID da operação:: OrderController_Poll

O ponto de extremidade de sondagem da API pedidos permite que seu aplicativo sondar e processar continuamente as alterações recentes nos pedidos.

Integração:

Uso:

Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas:

Código de resposta HTTP 200 – Há pedidos alterados recentemente; O corpo da resposta exibirá os dados do pedido.
Código de resposta HTTP 202 – Não existem pedidos alterados recentemente; o corpo da resposta estará vazio.

Em ambos os casos, há dois (2) cabeçalhos importantes na resposta:

Local – A URL da próxima solicitação.
Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300.

Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os parâmetros necessários para garantir que as alterações de ordem não estejam ausentes na solicitação.

Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por OrderId, em ordem crescente. Os parâmetros de classificação não são configuráveis.

Definição de ModifiedUtc: marca de hora interna = hora da última alteração de dados do pedido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
excludeFormData	excludeFormData		boolean	Se for true, OrderFormFields sempre será uma matriz vazia.
excludeCustomFieldData	excludeCustomFieldData		boolean	Se for true, CustomFields não será retornado.

Retornos

Corpo: CustomerAPI.Models.Order.OrderHeaderApiModel

Pesquisa de status do pedido

ID da operação:: OrderController_StatusPoll

O ponto de extremidade de sondagem da API statuses de ordem permite que seu aplicativo sondar e processar continuamente as alterações recentes nos pedidos.

Integração:

Uso:

Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas:

Código de resposta HTTP 200 – Registros de status do pedido alterados recentemente; corpo da resposta exibirá dados de status do pedido
Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio.

Em ambos os casos, há dois (2) cabeçalhos importantes na resposta:

Local – A URL da próxima solicitação.
Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300.

Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os necessários para garantir que os status do pedido não estejam ausentes da solicitação.

Os resultados são classificados por ModifiedUtc e, em seguida, por StatusId, em ordem crescente. Os parâmetros de classificação não são configuráveis.

Definição de ModifiedUtc: marca de hora interna = hora da alteração de dados de status do pedido mais recente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
excludeFormData	excludeFormData		boolean	Se for true, FieldValues sempre será uma matriz vazia.

Retornos

Corpo: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Sondagem de dados de formulário

ID da operação:: FormController_Poll

O ponto de extremidade de sondagem da API dos Formulários permite que seu aplicativo sondar e processar continuamente formulários autônomos enviados recentemente.

Integração:

Uso:

Em um cenário típico, a primeira solicitação para esse ponto de extremidade não deve fornecer parâmetros. Há duas (2) possíveis respostas bem-sucedidas:

Código de resposta HTTP 200 – Existem registros de formulário enviados recentemente; o corpo da resposta exibirá os dados do formulário.
Código de resposta HTTP 202 – Não existem registros enviados recentemente; o corpo da resposta estará vazio.

Em ambos os casos, há dois (2) cabeçalhos importantes na resposta:

Local – A URL da próxima solicitação.
Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados a serem recuperados, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados a serem recuperados, o valor do cabeçalho Retry-After será 300.

Observação: esses são apenas valores recomendados – seu aplicativo pode optar por sondar em uma frequência diferente, dependendo de seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Local da resposta mais recente. Não adicione mais parâmetros à URL, pois ela já contém os parâmetros necessários para garantir que os formulários não estejam ausentes da solicitação.

Os resultados são classificados automaticamente por ModifiedUtc e, em seguida, por FormHeaderId, em ordem crescente. Os parâmetros de classificação não são configuráveis.

Definição de ModifiedUtc: marca de hora interna = hora da alteração de dados do formulário mais recente.

Retornos

Corpo: CustomerAPI.Models.Forms.StandaloneFormApiModel

Definições

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Nome	Caminho	Tipo	Description
ID	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Nome	Caminho	Tipo	Description
ID	Id	integer	ID do cliente.
ExternalId	ExternalId	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
CreatedUtc	CreatedUtc	date-time	O ponto original no tempo em que o Cliente foi criado.
ModifiedUtc	ModifiedUtc	date-time	O último ponto no tempo em que o Cliente foi atualizado.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Nome	Name	string	Nome do cliente.
Endereço	Address	CustomerAPI.Models.LocationApiModel
Contato	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Nome	Caminho	Tipo	Description
FieldIndex	FieldIndex	integer	Índice de campo.
Legenda	Caption	string	Legenda do campo.
Tipo de dados	DataType	integer	Tipo de dados de campo.
DateTimeFormat	DateTimeFormat	integer	Formato DateTime.
Value	Value		Valor do campo.

CustomerAPI.Models.LocationApiModel

Nome	Caminho	Tipo	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 deste LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 deste LocationApiModel.
City	City	string	Cidade do LocationApiModel.
Nome da Região	RegionName	string	Nome da região do LocationApiModel.
Código Postal	PostalCode	string	Cep do LocationApiModel.
Código do País	CountryCode	string	Código ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegião do LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregião do LocationApiModel.
RegionCode	RegionCode	string	Código de região do LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Nome	Caminho	Tipo	Description
Nome	Name	string	Nome do ContactApiModel.
Número de telefone	PhoneNumber	string	PhoneNumber do ContactApiModel.
Email	Email	string	Email do ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Nome	Caminho	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Nome	Caminho	Tipo	Description
ID	Id	integer	ID do objeto.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Define o modelo de API de Item da Lista de Definição de Lista Personalizada.

Nome	Caminho	Tipo	Description
CustomListId	CustomListId	integer	ID da lista personalizada.
Nome	Name	string	Nome da Lista Personalizada.
Versão	Version	string	Versão da lista personalizada.

CustomerAPI.Models.CustomLists.CustomListApiModel

Modelo de lista personalizado.

Nome	Caminho	Tipo	Description
CustomListId	CustomListId	integer	ID da lista personalizada.
Nome	Name	string	Nome da Lista Personalizada.
Versão	Version	string	Versão da lista personalizada.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Define o modelo de API de definição de Lista Personalizada.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Define o modelo de API de definição de Lista Personalizada.

Nome	Caminho	Tipo	Description
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Colunas de lista personalizadas.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Índice de coluna exclusivo.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Define o modelo de API da Coluna de Definição de Lista Personalizada.

Nome	Caminho	Tipo	Description
Index	Index	integer	Índice de Coluna.
Tipo de dados	DataType	integer	DataType da Coluna (Texto: 0, Numérico: 1, Data: 2, Hora: 3, DateTime: 4, Email: 5).
Nome	Name	string	Nome da coluna.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Contêiner para matriz de dados de coluna de lista personalizada.

Nome	Caminho	Tipo	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Matriz de colunas com dados.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Esse modelo define o valor da coluna de lista personalizada.

Nome	Caminho	Tipo	Description
ColumnIndex	ColumnIndex	integer	Índice de coluna de lista personalizado.
Legenda	Caption	string	Legenda de coluna de lista personalizada.
Value	Value		Valor da coluna de lista personalizada.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Modelo de definição de evento personalizado.

Nome	Caminho	Tipo
ID	Id	string
Nome	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parâmetros	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Nome	Caminho	Tipo
Nome	Name	string
Tipo	Type	integer
Legenda	Caption	string
Obrigatório	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Nome	Caminho	Tipo	Description
EventId	EventId	integer	ID do evento.
Tipo de Evento	EventType	integer
EventCode	EventCode	string	Código do evento.
EventTime	EventTime	date-time	Formato ISO com Local e Offset.
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
Veículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Se habilitado, o veículo do evento atribuiu o usuário.
Localização	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	ID de definição de evento externo.
EventParams	EventParams	object	Parâmetros de evento.

CustomerAPI.Models.UserReferenceApiModel

Nome	Caminho	Tipo	Description
UserId	UserId	integer	UserId do Usuário.
Primeiro Nome	FirstName	string	Nome do usuário.
LastName	LastName	string	Sobrenome do Usuário.
Número do Funcionário	EmployeeNumber	string	Número do funcionário do Usuário.
GroupName	GroupName	string	Nome do grupo atribuído ao Usuário.

CustomerAPI.Models.ReadVehicleApiModel

Nome	Caminho	Tipo	Description
VehicleId	VehicleId	integer	ID do BaseVehicleApiModel.
Nome	Name	string	Nome do BaseVehicleApiModel.
VIN	VIN	string	Número de identificação do veículo do BaseVehicleApiModel.
Nome do Dispositivo	DeviceName	string	Nome de GpsDeviceDto associado ao BaseVehicleApiModel.
Número de Série	SerialNumber	string	SerialNumber do BaseVehicleApiModel.
GroupName	GroupName	string	GroupName do BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Nome	Caminho	Tipo	Description
GeofenceId	GeofenceId	integer	ID da cerca geográfica.
Nome	Name	string	Nome da cerca geográfica.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Nome	Caminho	Tipo	Description
Id de Assinatura	SubscriptionId	string	ID do WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Nome	Caminho	Tipo	Description
Id de Assinatura	SubscriptionId	string
URL	Url	string
Situação	Status	integer	Status da assinatura – (Em execução: 1, Parado: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Nome	Caminho	Tipo	Description
ID	Id	integer	Id associada a este StandaloneFormApiModel – (comentário herdado: FormHeaderId).
FormId	FormId	integer	ID do Formulário referenciado por este StandaloneFormApiModel.
FormName	FormName	string	Nome do formulário referenciado por este StandaloneFormApiModel.
EntryNumber	EntryNumber	string	Número de entrada de dados do formulário.
Revisto	Reviewed	boolean	Status da revisão deste StandaloneFormApiModel.
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	Ponto no tempo em que o StandaloneFormApiModel foi enviado.
StartTime	StartTime	date-time	Ponto no tempo em que o StandaloneFormApiModel foi iniciado.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Lista dos campos associados a este StandaloneFormApiModel.
ApiModuleId	ApiModuleId	string	ID do ApiModule associado a este StandaloneFormApiModel.
SharedUrl	SharedUrl	string	Url compartilhada deste StandaloneFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Hora da revisão do formulário

CustomerAPI.Models.Forms.FormFieldDataApiModel

Nome	Caminho	Tipo	Description
Repetíveis	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
ID	Id	string	ID do FormFieldDataApiModel.
Value	Value		Valor do FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue do FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	O valor pontual foi capturado do FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Legenda	Caption	string	Conteúdo de legenda do FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID do ApiField do FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Nome	Caminho	Tipo	Description
ID	Id	string	ID do FormFieldDataApiModel.
Value	Value		Valor do FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue do FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	O valor pontual foi capturado do FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Legenda	Caption	string	Conteúdo de legenda do FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID do ApiField do FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Nome	Caminho	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId do GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc do GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc do GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths do GeofenceApiModel.
Nome	Name	string	Nome do GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo e 1 para polígono.
Endereço	Address	CustomerAPI.Models.LocationApiModel
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.

Actoft.Core.Geo.LatLon

Nome	Caminho	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Nome	Caminho	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId do GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc do GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc do GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths do GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Pontos de polígono. Deve ser preenchido quando a forma for igual a 1.
Nome	Name	string	Nome do GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo e 1 para polígono.
Endereço	Address	CustomerAPI.Models.LocationApiModel
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Nome	Caminho	Tipo	Description
Identificação do Pedido	OrderId	integer	ID do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
Data de Conclusão	DueDate	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Pontualmente, este OrderBaseApiModel deve ser iniciado (introduzido na v1.3).
EndTime	EndTime	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (introduzido na v1.3).
ServiceType	ServiceType	string	ServiceType associado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Ponto no tempo em que este OrderBaseApiModel foi criado.
Número do pedido	OrderNumber	string	Número de Pedido associado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Status mostrando se o OrderBaseApiModel está fechado.
Situação	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
ClientId	ClientId	integer	ID de uso interno para o cliente – Propriedade de extensão de API.
Cliente	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Nome	Caminho	Tipo	Description
StatusIndex	StatusIndex	integer	Índice do OrderStatusApiModel.
TipoDeStatus	StatusType	integer	Status do pedido: 0 para novo pedido, 1 para expedido, 2 para em andamento, 3 para conclusão e 4 para cancelado.
StatusLabel	StatusLabel	string	Rotule o conteúdo do OrderStatusApiModel.
StatusId	StatusId	integer	ID do OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Ponto no tempo de início do OrderStatusApiModel.
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Nome	Caminho	Tipo	Description
GroupNames	GroupNames	array of string	Nomes hierárquicos do grupo de clientes.
Nome	Name	string	Nome do cliente.
Endereço	Address	CustomerAPI.Models.LocationApiModel
Contato	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Nome	Caminho	Tipo	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Lista dos OrderStatusListItems associados a este OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Identificação do Pedido	OrderId	integer	ID do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
Data de Conclusão	DueDate	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Pontualmente, este OrderBaseApiModel deve ser iniciado (introduzido na v1.3).
EndTime	EndTime	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (introduzido na v1.3).
ServiceType	ServiceType	string	ServiceType associado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Ponto no tempo em que este OrderBaseApiModel foi criado.
Número do pedido	OrderNumber	string	Número de Pedido associado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Status mostrando se o OrderBaseApiModel está fechado.
Situação	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
ClientId	ClientId	integer	ID de uso interno para o cliente – Propriedade de extensão de API.
Cliente	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Nome	Caminho	Tipo	Description
StatusStartDateTime	StatusStartDateTime	date-time	Pontualmente, este Status OrderStatusHistoryListItemApiModel foi iniciado.
StatusEndDateTime	StatusEndDateTime	date-time	Ponto no tempo em que este Status OrderStatusHistoryListItemApiModel foi encerrado.
StatusId	StatusId	integer	Id associada a este OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Índice associado a este OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Rotule o conteúdo associado a este OrderStatusHistoryListItemApiModel.
TipoDeStatus	StatusType	integer	Status do pedido: 0 para novo pedido, 1 para expedido, 2 para em andamento, 3 para conclusão e 4 para cancelado.
ExternalOrderId	ExternalOrderId	string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
Identificação do Pedido	OrderId	integer	OrderId associado a este OrderStatusHistoryListItemApiModel.
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	ID do ApiService associado a este OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Nome	Caminho	Tipo	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Identificação do Pedido	OrderId	integer	ID do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de Uso Externo para o Cliente – Propriedade de Extensão de API.
Data de Conclusão	DueDate	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Pontualmente, este OrderBaseApiModel deve ser iniciado (introduzido na v1.3).
EndTime	EndTime	date-time	Pontualmente, este OrderBaseApiModel deve ser concluído (introduzido na v1.3).
ServiceType	ServiceType	string	ServiceType associado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Ponto no tempo em que este OrderBaseApiModel foi criado.
Número do pedido	OrderNumber	string	Número de Pedido associado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Status mostrando se o OrderBaseApiModel está fechado.
Situação	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID de Uso Externo para o Cliente – Propriedade de Extensão de API.
ClientId	ClientId	integer	ID de uso interno para o cliente – Propriedade de extensão de API.
Cliente	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Nome	Caminho	Tipo	Description
ID	Id	integer	ID da entrada Timekeeping (comentário herdado: RootSubmittedStatusId).
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Ponto no tempo em que o usuário atingiu o relógio no sistema.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Ponto no tempo em que o usuário saiu do sistema.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Número total de horas para esta entrada de Timekeeping.
TotalBreakHours	TotalBreakHours	double	Número total de horas de interrupção (não funcionando) para esta entrada de Timekeeping.
NetHours	NetHours	double	Número total de horas cobradas para esta entrada de Manutenção de Tempo.
Aprovada	Approved	boolean	Status da aprovação do Supervisor para esta entrada de Manutenção de Tempo.
Quebra	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	ID do Módulo da Empresa usado para enviar essa entrada de Timekeeping.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Nome	Caminho	Tipo	Description
ID	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Hora de início.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Hora de término.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Duração em horas. Pode ser nulo se EndTime for nulo.
TipoDeStatus	StatusType	integer	Tipo de status: 1 para pausa e 2 para o almoço.
StartLabel	StartLabel	string	Iniciar rótulo.
EndLabel	EndLabel	string	Rótulo final.
Legenda	Caption	string	Legenda.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Nome	Caminho	Tipo
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Nome	Caminho	Tipo
_Principal	_Major	integer
_Menor	_Minor	integer
_Construir	_Build	integer
_Revisão	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Nome	Caminho	Tipo	Description
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
Veículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Pontualmente, este Status TripApiModel foi iniciado.
EndTime	EndTime	date-time	Ponto no tempo em que este Status TripApiModel foi encerrado.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	Quantidade de tempo de parada em horas associadas a este TripApiModel.
TotalIdleTime	TotalIdleTime	double	Quantidade de tempo ocioso em horas associadas a este TripApiModel.
TotalDuration	TotalDuration	double	Tempo total em horas associadas a este TripApiModel.
Distância	Distance	double	Distância percorrida em unidades localizadas associadas a este TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Nome	Caminho	Tipo	Description
Registros	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
Token de Continuação	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Nome	Caminho	Tipo	Description
Utilizador	User	CustomerAPI.Models.UserReferenceApiModel
Veículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag associado a este GpsDataRecordApiModel.
Localização	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Cerca geográfica	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Velocidade	Speed	double	Velocidade de movimento associada a este GpsDataRecordApiModel.
Título	Heading	double	Direção da bússola em graus associados a este GpsDataRecordApiModel.
Situação	Status	integer	ApiMovementStatus associado ao OrderBaseApiModel – (Parado: 1, Ocioso: 2, Movendo: 3, NotTracking: 4) : OrderStatusApiModel.
StatusTime	StatusTime	string	Ponto no tempo em que este Status GpsDataRecordApiModel foi definido.
Distância	Distance	double	Distância percorrida em unidades localizadas associadas a este TripApiModel.
IgnitionOn	IgnitionOn	boolean	Status da ignição do veículo associada a este GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Provedor de Localização de API associado a este GpsDataRecordApiModel – (GPS: 1, Rede: 2).

CustomerAPI.Models.User.ReadUserApiModel

Nome	Caminho	Tipo	Description
UserName	UserName	string	UserName do Usuário.
UserId	UserId	integer	Valor de ID do Usuário.
GroupName	GroupName	string	Nome do grupo do usuário.
Primeiro Nome	FirstName	string	Nome do usuário.
LastName	LastName	string	Sobrenome do Usuário.
Número do Funcionário	EmployeeNumber	string	Número do funcionário do Usuário.
Email	Email	string	Endereço de email do Usuário.
Telefone	Phone	string	Número de telefone do Usuário.
RoleId	RoleId	integer	RoleId do Usuário – (Administrador: 1, Usuário: 3, Usuário do Power: 5).
IsActive	IsActive	boolean	Status ativo do Usuário.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booliano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Push-to-Talk avançado para Usuário: cadeia de caracteres.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema EPTT do Kodiak – Fornecido pelo Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar o usuário no sistema EPTT kodiak – fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
MobileOnly	MobileOnly	boolean	Status do acesso ao aplicativo Web da área de trabalho para CAB – (Sem Acesso ao WebApp: True, Acesso Completo ao Aplicativo: False).
LicenseType	LicenseType	integer	Tipo de Licença atribuída ao usuário: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

CustomerAPI.Models.User.ReadUserListItemApiModel

Nome	Caminho	Tipo	Description
UserId	UserId	integer	Valor de ID do Usuário.
Primeiro Nome	FirstName	string	Nome do usuário.
LastName	LastName	string	Sobrenome do Usuário.
Número do Funcionário	EmployeeNumber	string	Número do funcionário do Usuário.
Email	Email	string	Endereço de email do Usuário.
Telefone	Phone	string	Número de telefone do Usuário.
RoleId	RoleId	integer	RoleId do Usuário – (Administrador: 1, Usuário: 3, Usuário do Power: 5).
IsActive	IsActive	boolean	Status ativo do Usuário.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booliano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Push-to-Talk avançado para Usuário: cadeia de caracteres.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema EPTT do Kodiak – Fornecido pelo Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar o usuário no sistema EPTT kodiak – fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
MobileOnly	MobileOnly	boolean	Status do acesso ao aplicativo Web da área de trabalho para CAB – (Sem Acesso ao WebApp: True, Acesso Completo ao Aplicativo: False).
LicenseType	LicenseType	integer	Tipo de Licença atribuída ao usuário: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

CustomerAPI.Models.Vehicles.VehicleReadApi

Modelo de dados do veículo.

Nome	Caminho	Tipo
InternalId	InternalId	integer
Número	Number	string
Nome	Name	string
Tipo	Type	string
Etiqueta	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Fazer	Make	string
Ano	Year	integer
Modelo	Model	string
Cor	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Tipo de Dispositivo	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

inteiro

Esse é o tipo de dados básico 'integer'.

objeto

Esse é o tipo 'object'.

Compartilhar via

TeamWherx

Criando uma conexão

Padrão

Limitações

Ações

Assinar o web hook de dados GPS

Parâmetros

Retornos

Assinar o web hook de eventos

Parâmetros

Retornos

Ativar um usuário

Parâmetros

Ativar um veículo

Parâmetros

Retornos

Atualizar o status do pedido

Parâmetros

Retornos

Atualizar parte de um usuário

Parâmetros

Retornos

Atualizar um cliente

Parâmetros

Retornos

Atualizar um pedido

Parâmetros

Retornos

Atualizar um usuário

Parâmetros

Retornos

Atualizar um veículo

Parâmetros

Retornos

Atualizar uma cerca geográfica existente

Parâmetros

Retornos

Atualização parcial de um veículo

Parâmetros

Retornos

Cancelar assinatura do web hook de dados GPS

Parâmetros

Cancelar assinatura do web hook de eventos

Parâmetros

Carregar arquivo binário

Retornos

Carregar arquivo de anexo

Retornos

Criar ou atualizar registro de lista personalizado

Parâmetros

Criar ou atualizar uma definição de evento personalizado

Parâmetros

Criar um cliente

Parâmetros

Retornos

Criar um formulário

Parâmetros

Retornos

Criar um usuário

Parâmetros

Retornos

Criar um veículo

Parâmetros

Retornos

Criar uma cerca geográfica

Parâmetros

Retornos

Crie um pedido

Parâmetros

Retornos

Desativar um usuário

Parâmetros

Desativar um veículo

Parâmetros

Retornos

Enviar evento

Parâmetros

Excluir registro de lista personalizado

Parâmetros