TeamWherx

TeamWherx(TW) é uma plataforma de gerenciamento de serviços tudo-em-um que ajuda você a gerenciar de forma mais eficaz suas equipes remotas de funcionários e operações de negócios gerais fora do escritório. Como uma solução baseada em nuvem, a TW permite a coleta remota de dados e os exibe por meio de seu painel de aplicativos 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 reduzir os custos enquanto coordenam suas forças de trabalho móveis.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Actsoft
Sítio Web	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ários digitais, informações de cronometragem de funcionários e gerencie ordens de serviço com um sistema de despacho.

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 poderosas. Automatize e simplifique seus processos diários, semanais ou mensais com acesso a up-todados acionáveis no momento.

## Pré-requisitos

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

Conta TeamWherx
Chave da API TeamWherx
Plano Microsoft Power Apps ou Power Automate

## Como obter credenciais

Portal do desenvolvedor da API

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

De dentro do aplicativo, vá para Configuração daAPI deConfigurações>Administrativas>.
Escolha Criar credenciais.
Introduza o seu nome próprio e apelido nos campos apropriados.
Introduza o seu endereço de e-mail no campo Endereço de e-mail.
Escolha Salvar convite por e-mail. Em seguida, verifique seu e-mail para obter instruções sobre como criar uma senha.
Uma vez dentro do e-mail de convite, clique em Escolher senha, 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, vá paraConfigurações>administrativas>Vápara o portal do desenvolvedor.
Dentro do portal do desenvolvedor, escolha Produtos e, em seguida, selecione API do cliente.
Escolha Subscrever.

Chave da API

Agora que você é um usuário registrado da API, uma sequência alfanumérica, chamada 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 uma assinatura X para este produto".
Escolha Mostrar ao lado da chave primária da sua assinatura.
Selecione o conteúdo do campo, clique com o botão direito do mouse e escolha Copiar. A chave está agora guardada na área de transferência e pronta para colar.

## Comece a usar seu conector

Vá para Meus fluxos>Novo fluxo e selecione Fluxo de nuvem automatizado.
Escolha Acionar manualmente um fluxo na caixa de diálogo Criar um fluxo de nuvem automatizado.
Nomeie seu fluxo ou deixe o sistema gerar um automaticamente.
Procure e escolha um gatilho para o seu fluxo.
Selecione Criar.
No campo de pesquisa, procure e escolha o conector TeamWherx.
Encontre a ação que você deseja executar com o conector.

O sistema solicitará que você faça login 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.
Selecione Criar. A primeira etapa do fluxo do processo é exibida como a primeira 'caixa' em um fluxograma.
Escolha Novaetapa para continuar adicionando mais ações e etapas ao fluxo do processo do conector.
Escolha Guardar.

**Usando o conector - Exemplo de pesquisa de status do pedido
** 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 o status de um pedido é atualizado.

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

Cada caixa de diálogo de ação nas etapas do seu 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 do campo Forms sejam exibidos (parâmetro excludeFormData).
Escolha a versão X-API para a conexão.
Escolha Próxima etapa para definir a ação que você gostaria que ocorresse quando o status de um pedido fosse alterado.
Na caixa de diálogo Escolha uma operação , use o campo de pesquisa para localizar o aplicativo e, em seguida, a ação desejada. Por exemplo, se você quiser inserir uma linha em uma planilha do Google sempre que o status de um pedido for alterado, escolha Planilhas Google e, em seguida, Inserirlinha para a ação.
Na caixa de diálogo Inserirlinha a seguir, clique no campo Arquivo e escolha o arquivo que conterá os 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 de cada coluna e escolha uma propriedade na listagem Propriedades da pesquisa de status do pedido . 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 gravarão na coluna Evento na nova linha.
Selecione Novaetapa. Como uma observação à parte, você sempre pode passar o mouse e clicar no conector de seta para inserir uma nova etapa
Na caixa de diálogo Escolha uma operação, selecione o conector TeamWherx novamente e, em seguida, Criar um cliente para a ação.

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

Para este exemplo, escolha Número do Funcionário 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 Guardar.

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

## Problemas conhecidos e limitações

Os uploads binários de arquivos de áudio (POST) para todos os pontos finais 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 RFC3339 diretrizes, 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 no(s) Portal(is) de desenvolvedores de API:

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

## Perguntas frequentes

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Ativar um utilizador	Ativa um usuário existente por sua Id.
Ativar um veículo	Ative um veículo por identificação.
Atualizar o status do pedido	Altera o status de um pedido existente.
Atualizar parte de um usuário	Atualiza parte das propriedades do usuário.
Atualizar um cliente	Atualiza um cliente existente.
Atualizar um utilizador	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 pelo seu Id.
Atualizar uma encomenda	Atualiza um pedido existente.
Atualização parcial de um veículo	Atualização parcial de um veículo por ID.
Cancelar inscrição GPS data web hook	Exclui uma assinatura de gancho da web de dados GPS por seu ID.
Cancelar inscrição no gancho da web de eventos	Exclui uma assinatura de gancho da Web de eventos por sua ID.
Carregar arquivo binário	Use esta opção para carregar imagens de formulário e arquivos de áudio. O tamanho binário é limitado a 10MB. Os tipos de ficheiros suportados são: JPEG, PNG e MP4.
Carregar ficheiro anexo	Use esta opção para carregar anexos de arquivo de formulário. O tamanho binário é limitado a 25MB. Solicitação esperada de dados de várias partes/formulários com um único arquivo.
Criar ou atualizar o registro de lista personalizada	Cria ou atualiza o registro de dados de lista personalizada. O valor da coluna exclusiva pode ser omitido, mas, se presente, deve corresponder ao valor da ID exclusiva no parâmetro de consulta.
Criar ou atualizar uma definição de evento personalizada	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 utilizador	Cria um novo usuário.
Criar um veículo	Cria um veículo.
Criar uma cerca geográfica	Cria uma nova cerca geográfica.
Criar uma encomenda	Adiciona uma nova ordem.
Desativar um utilizador	Desativa um usuário existente por sua Id.
Desativar um veículo	Desative um veículo por ID.
Eliminar um veículo	Eliminar um veículo por ID.
Excluir registro de lista personalizada	Exclui o registro existente na lista personalizada por seu customListId e id. id - é o valor exclusivo do registro de lista personalizada. Erros: 404 - customListId ou id não encontrado.
Excluir um cliente	Exclui um cliente existente por sua Id.
Excluir uma cerca geográfica	Exclui uma cerca geográfica existente por sua Id.
Excluir uma definição de evento personalizada	Exclui uma definição de evento personalizada.
Inscrever-se para eventos web hook	Adiciona nova assinatura de gancho da Web de eventos. Os ganchos da Web permitem que você receba notificações automáticas sobre eventos da empresa que ocorrem em uma URL especificada.
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 a paginação é suportada. Erros: 404 - não há nenhuma lista personalizada para customListId fornecido.
Obter definições de lista personalizadas	Recupera uma listagem de definição de Lista Personalizada. A listagem de definições contém o 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 dos utilizadores/veículos eliminados não são devolvidas. No entanto, se o utilizador/veículo existia quando os dados foram solicitados e foram posteriormente removidos, os dados do utilizador/veículo solicitados por um token de continuação serão devolvidos. 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 personalizada por CustomListID	Recupera uma lista de campos para uma única lista personalizada, usando o CustomListID.
Obter registro único da lista personalizada	Recupera um único registro de dados de lista personalizada encontrado por CustomListId e valor de coluna exclusivo. Erros: 404 - não há nenhum registro de lista personalizada para customListId fornecido e valor de coluna exclusivo
Obter um cliente	Recupera um objeto cliente por sua Id.
Obter um formulário	Recupera um formulário por sua Id.
Obter um utilizador	Obtém um usuário por sua Id.
Obter um veículo por ID	Recupera um único veículo por ID.
Obter uma cerca geográfica	Recupera uma cerca geográfica pelo seu id.
Obter uma definição de evento personalizada por ID	Recupera uma única definição de evento personalizada por ID.
Obter uma entrada de cronometragem	Recupera uma entrada por seu Id.
Obter uma lista de assinaturas de gancho da Web de evento	Recupera uma lista de assinaturas de gancho da Web de evento. 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 da 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 encomendas	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 entradas de cronometragem	Recupera uma lista de entradas de cronometragem 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 por 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. Filtre por tipo de evento para obter eventos específicos. Os eventos do veículo podem ser devolvidos 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 subscrições	Recupera uma lista de assinaturas de gancho da Web. 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 utilizadores	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.
Receba uma encomenda	Obtém uma ordem existente por seu Id.
Redefine o status da assinatura	Altera o status da assinatura para o status = 1 ("Em execução").
Redefine o status da assinatura do gancho da Web do evento	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 Webhook com feed de dados GPS	Este método de exemplo é usado por gpsdata/subscribe para postar feed de dados de volta usando a URL fornecida pelo cliente.
Submeter evento	Submete evento.
Subscrever gancho web de dados GPS	Adiciona novos dados de rastreamento GPS (posições GPS) web hook. Os ganchos da Web permitem que você receba posições de GPS que ocorrem em uma URL especificada.

Ativar um utilizador

ID da Operação:: UserController_Activate

Ativa um usuário existente por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Ativar um veículo

ID da Operação:: VehicleController_Activate

Ative um veículo por identificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

response: integer

Atualizar o status do pedido

ID da Operação:: OrderController_ChangeStatus

Altera o status de um pedido existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
Número de Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo para o StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ponto no tempo este NewOrderStatusApiModel Status Status foi iniciado.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualizar parte de um usuário

ID da Operação:: UserController_PartialUpdate

Atualiza parte das propriedades do usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualizar um cliente

ID da Operação:: ClientController_Update

Atualiza um cliente existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
Identificação externa	ExternalId		string	ID de uso externo para o cliente - propriedade de extensão de API.
FieldIndex	FieldIndex		integer	Índice de campo.
Valor	Value			Valor do campo.
Nome	Name		string	Nome do Cliente.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	Número de telefone 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 id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualizar um utilizador

ID da Operação:: UserController_Update

Atualiza um usuário existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
Nome de Utilizador	UserName		string	Nome de usuário do usuário.
Palavra-passe	Password		password	Palavra-passe do Utilizador.
Nome do Grupo	GroupName		string	Nome do grupo do usuário.
Primeiro Nome	FirstName		string	Nome próprio do Utilizador.
Apelido	LastName		string	Apelido do Utilizador.
Número de Funcionário	EmployeeNumber		string	Número de funcionário do Utilizador.
Email	Email		string	Endereço de e-mail do Utilizador.
Telemóvel	Phone		string	Número de telefone do Utilizador.
RoleId	RoleId		integer	RoleId do Usuário - (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive		boolean	Estado ativo do Utilizador.
EPTTEnabled	EPTTEnabled		boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booleano.
EPTTNumber	EPTTNumber		string	Número de telefone para o recurso Enhanced Push-to-Talk para User: string.
EPTTWebMDN	EPTTWebMDN		string	Número de telefone usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pela Kodiak.
EPTTToken	EPTTToken		string	API Token usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pelo Kodiak.
GPSEnabled	GPSEnabled		boolean	Status do recurso GPS para o usuário.
Apenas para dispositivos móveis	MobileOnly		boolean	Status do acesso ao aplicativo Web desktop para CAB - (Sem acesso WebApp: True, Acesso Completo ao Aplicativo: False).
Tipo de Licença	LicenseType		integer	Tipo de Licença atribuída ao utilizador: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualizar um veículo

ID da Operação:: VehicleController_UpdateVehicle

Atualize um veículo por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
Número	Number		string
Nome	Name		string
Tipo	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
Nome do Grupo	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 id externo ou não.

Devoluções

response: integer

Atualizar uma cerca geográfica existente

ID da Operação:: GeofenceController_UpdateGeofence

Atualiza uma cerca geográfica existente pelo seu Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	integer	Geofence Id.
Nomes de Grupo	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
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Raio	Radius		double	Raio do GeofenceApiModel.
UseGeofenceEndereço	UseGeofenceAddress		boolean	UseGeofenceAddress do GeofenceApiModel.
useMetric	useMetric		boolean	Use sistema métrico ou não.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualizar uma encomenda

ID da Operação:: OrderController_Update

Atualiza um pedido existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
ExternalOrderId	ExternalOrderId		string	Uso externo OrderId para o cliente - API Extension propriedade.
IsClosed	IsClosed		boolean	Status mostrando se o UpdateOrderApiModel fechou.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	Número de telefone do ContactApiModel.
Email	Email		string	Email do ContactApiModel.
Data de vencimento	DueDate		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve iniciar (introduzido na v1.3).
EndTime	EndTime		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve terminar (introduzido na v1.3).
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Número de Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo para o StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ponto no tempo este NewOrderStatusApiModel Status Status foi iniciado.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
FieldIndex	FieldIndex		integer	Índice de campo.
Valor	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 id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Atualização parcial de um veículo

ID da Operação:: VehicleController_PartialUpdateVehicle

Atualização parcial de um veículo por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Cancelar inscrição GPS data web hook

ID da Operação:: TrackingController_RemoveGpsDataFeedSubscription

Exclui uma assinatura de gancho da web de dados GPS por seu ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de subscrição	subscriptionId	True	string	ID da subscrição a eliminar.

Cancelar inscrição no gancho da web de eventos

ID da Operação:: EventController_RemoveEventDataFeedSubscription

Exclui uma assinatura de gancho da Web de eventos por sua ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de subscrição	subscriptionId	True	string	ID da subscrição a eliminar.

Carregar arquivo binário

ID da Operação:: BinaryController_UploadBinary

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

Devoluções

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Carregar ficheiro anexo

ID da Operação:: BinaryController_UploadAttachment

Use esta opção para carregar anexos de arquivo de formulário. O tamanho binário é limitado a 25MB. Solicitação esperada de dados de várias partes/formulários com um único arquivo.

Devoluções

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Criar ou atualizar o registro de lista personalizada

ID da Operação:: CustomListController_PutRecord

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor único.
ColumnIndex	ColumnIndex		integer	Índice de coluna de lista personalizada.
Legenda	Caption		string	Legenda da coluna da lista personalizada.
Valor	Value			Valor da coluna da lista personalizada.

Criar ou atualizar uma definição de evento personalizada

ID da Operação:: EventController_Put

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	ID da definição do 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

Name	Chave	Tipo	Description
Identificação externa	ExternalId	string	ID de uso externo para o cliente - propriedade de extensão de API.
FieldIndex	FieldIndex	integer	Índice de campo.
Valor	Value		Valor do campo.
Nome	Name	string	Nome do Cliente.
Latitude	Latitude	double
Longitude	Longitude	double
EndereçoLinha1	AddressLine1	string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode	string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName	string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode	string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode	string	Código de região do LocationApiModel.
Nome	Name	string	Nome do ContactApiModel.
Número de telefone	PhoneNumber	string	Número de telefone do ContactApiModel.
Email	Email	string	Email do ContactApiModel.
geocódigo	geocode	boolean	O endereço deve ser geocodificado ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Criar um formulário

ID da Operação:: FormController_PostFormAsync

Adiciona um novo formulário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ApiModuleId	ApiModuleId		string	Id do ApiModule associado a este CreateStandaloneFormApiModel.
Avaliado	Reviewed		boolean	Status da revisão deste CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId do Usuário.
Número de Funcionário	EmployeeNumber		string	Número de funcionário do Utilizador.
SubmittedTime	SubmittedTime	True	date-time	Ponto no tempo em que o CreateStandaloneFormApiModel foi enviado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID do campo da API.
Valor	Value	True		Valor do FormFieldDataApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Sign" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	Momento em que os dados binários foram capturados. Formato - data-hora (como data-hora em RFC3339) incluindo deslocamento.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID do campo da API.
Valor	Value	True		Valor do FormFieldDataApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Sign" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	Momento em que os dados binários foram capturados. Formato - data-hora (como data-hora em RFC3339) incluindo deslocamento.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Criar um utilizador

ID da Operação:: UserController_Create

Cria um novo usuário.

Parâmetros

Name	Chave	Tipo	Description
Nome de Utilizador	UserName	string	Nome de usuário do usuário.
Palavra-passe	Password	password	Palavra-passe do Utilizador.
Nome do Grupo	GroupName	string	Nome do grupo do usuário.
Primeiro Nome	FirstName	string	Nome próprio do Utilizador.
Apelido	LastName	string	Apelido do Utilizador.
Número de Funcionário	EmployeeNumber	string	Número de funcionário do Utilizador.
Email	Email	string	Endereço de e-mail do Utilizador.
Telemóvel	Phone	string	Número de telefone do Utilizador.
RoleId	RoleId	integer	RoleId do Usuário - (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Estado ativo do Utilizador.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booleano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Enhanced Push-to-Talk para User: string.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pela Kodiak.
EPTTToken	EPTTToken	string	API Token usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
Apenas para dispositivos móveis	MobileOnly	boolean	Status do acesso ao aplicativo Web desktop para CAB - (Sem acesso WebApp: True, Acesso Completo ao Aplicativo: False).
Tipo de Licença	LicenseType	integer	Tipo de Licença atribuída ao utilizador: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Criar um veículo

ID da Operação:: VehicleController_CreateVehicle

Cria um veículo.

Parâmetros

Name	Chave	Tipo
Número	Number	string
Nome	Name	string
Tipo	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
Nome do Grupo	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

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Criar uma cerca geográfica

ID da Operação:: GeofenceController_CreateGeofence

Cria uma nova cerca geográfica.

Parâmetros

Name	Chave	Tipo	Description
Nomes de Grupo	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
EndereçoLinha1	AddressLine1	string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode	string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName	string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode	string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode	string	Código de região do LocationApiModel.
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceEndereço	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.
useMetric	useMetric	boolean	Use sistema métrico ou não.
geocódigo	geocode	boolean	O endereço deve ser geocodificado ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Criar uma encomenda

ID da Operação:: OrderController_Create

Adiciona uma nova ordem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
CreatedDateTime	CreatedDateTime		date-time	Ponto no tempo este 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	Uso externo OrderId para o cliente - API Extension propriedade.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Nome	Name		string	Nome do ContactApiModel.
Número de telefone	PhoneNumber		string	Número de telefone do ContactApiModel.
Email	Email		string	Email do ContactApiModel.
Data de vencimento	DueDate		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve iniciar (introduzido na v1.3).
EndTime	EndTime		date-time	Ponto no tempo este BaseUpdateOrderApiModel deve terminar (introduzido na v1.3).
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Número de Funcionário	EmployeeNumber	True	string	EmployeeNumber do usuário que criou este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Rotule o conteúdo para o StatusLabel associado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ponto no tempo este NewOrderStatusApiModel Status Status foi iniciado.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
Latitude	Latitude		double
Longitude	Longitude		double
EndereçoLinha1	AddressLine1		string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode		string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName		string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode		string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode		string	Código de região do LocationApiModel.
Legenda	Caption	True	string
Valor	Value			Valor do UpdateFormFieldApiModel. Formato do valor do campo "NFC": { "Tipo": número, // 0 - Texto "Carga": objeto, // Deve ser texto para Tipo = 0 } Formato do valor do campo "Câmara" (referência binária): { "BinaryId": string, // ID binário de uma imagem carregada (ver carregar API binária) "Nota": string // Nota para a imagem referenciada } Formato do valor do campo "Assinatura" (referência binária): { "BinaryId": string // ID binário de uma imagem carregada (consulte carregar API binária) } Formato do valor do campo "Áudio" (referência binária): { "BinaryId": string, // ID binário de um áudio carregado (consulte API binária de carregamento) "DurationSeconds": número // Duração do áudio em segundos }
Tempo Capturado	CapturedTime		date-time	O valor do ponto no tempo foi capturado.
FieldIndex	FieldIndex		integer	Índice de campo.
Valor	Value			Valor do campo.
geocódigo	geocode		boolean	O endereço deve ser geocodificado ou não.

Devoluções

Body: CustomerAPI.Models.ReturnIdApiModel

Desativar um utilizador

ID da Operação:: UserController_Deactivate

Desativa um usuário existente por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Desativar um veículo

ID da Operação:: VehicleController_Deactivate

Desative um veículo por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

response: integer

Eliminar um veículo

ID da Operação:: VehicleController_Delete

Eliminar um veículo por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Excluir registro de lista personalizada

ID da Operação:: CustomListController_DeleteRecord

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

id - é o valor exclusivo do registro de lista personalizada.

Erros:

404 - customListId ou id não encontrado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor único.

Excluir um cliente

ID da Operação:: ClientController_Delete

Exclui um cliente existente por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	ID do cliente.
use-external-id	use-external-id		boolean	Use id externo 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

Name	Chave	Necessário	Tipo	Description
id	id	True	integer	Geofence Id.

Excluir uma definição de evento personalizada

ID da Operação:: EventController_Delete

Exclui uma definição de evento personalizada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	ID da definição do evento.

Inscrever-se para eventos web hook

ID da Operação:: EventController_SubscribeToEventDataFeed

Adiciona nova assinatura de gancho da Web 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

Name	Chave	Necessário	Tipo	Description
Endereço URL	Url		string	URL que contém o endereço do WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de segurança associado a este WebHookSubscriptionParamsApiModel.

Devoluções

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

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 a paginação é suportada.

Erros:

404 - não há nenhuma lista personalizada para customListId fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
Número da página	pageNumber		integer	Número da página inicial.
pageSize	pageSize		integer	Tamanho da página.

Devoluções

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

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obter definições de lista personalizadas

ID da Operação:: CustomListController_Get

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

Devoluções

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 dos utilizadores/veículos eliminados não são devolvidas. No entanto, se o utilizador/veículo existia quando os dados foram solicitados e foram posteriormente removidos, os dados do utilizador/veículo solicitados por um token de continuação serão devolvidos.

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

Name	Chave	Tipo	Description
deData	fromDate	date-time	Início do intervalo de datas. Recomendação: Por favor, use grandes intervalos de datas (>=4 horas) em vez de pequenos intervalos de datas.
até à data	toDate	date-time	Fim do intervalo de datas. Recomendação: Por favor, use grandes intervalos de datas (>=4 horas) em vez de pequenos intervalos de datas.
Número do empregado	employeeNumber	string	Número de funcionário.
Vin	vin	string	Número VIN do veículo.
useMetric	useMetric	boolean	Use sistema métrico ou não.
token	token	string	Token de continuação que é devolvido pela chamada inicial e deve ser usado na chamada sucessiva.

Devoluções

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Obter listagem de campos de lista personalizada por CustomListID

ID da Operação:: CustomListController_GetById

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.

Devoluções

Modelo de lista personalizada.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Obter registro único da lista personalizada

ID da Operação:: CustomListController_GetSingleRecord

Recupera um único registro de dados de lista personalizada encontrado por CustomListId e valor de coluna exclusivo.

Erros:

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
customListId	customListId	True	integer	ID da lista personalizada.
id	id	True	string	Valor único.

Devoluções

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

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obter um cliente

ID da Operação:: ClientController_Get

Recupera um objeto cliente por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	ID do cliente.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.Client.ReadClientApiModel

Obter um formulário

ID da Operação:: FormController_GetFormAsync

Recupera um formulário por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	integer	Id do formulário.

Devoluções

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Obter um utilizador

ID da Operação:: UserController_Get

Obtém um usuário por sua Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: 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

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Modelo de Dados do Veículo.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Obter uma cerca geográfica

ID da Operação:: GeofenceController_GetGeofence

Recupera uma cerca geográfica pelo seu id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	integer	Geofence Id.
useMetric	useMetric		boolean	Use sistema métrico ou não.

Devoluções

Body: 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 personalizada por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	ID da definição do evento.

Devoluções

Modelo de definição de evento personalizado.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obter uma entrada de cronometragem

ID da Operação:: TimekeepingController_GetTimekeepingEntryAsync

Recupera uma entrada por seu Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id do registo.

Devoluções

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obter uma lista de assinaturas de gancho da Web de evento

ID da Operação:: EventController_GetSubscriptions

Recupera uma lista de assinaturas de gancho da Web de evento. 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.

Devoluções

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 da 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

Name	Chave	Tipo	Description
Número da página	pageNumber	integer	Número da página inicial. O padrão é 1.
pageSize	pageSize	integer	Tamanho da página. O padrão é 500.
useMetric	useMetric	boolean	Use sistema métrico ou não.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Número da página	pageNumber		integer	Número da página inicial.
pageSize	pageSize		integer	Tamanho da página.

Devoluções

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.

Devoluções

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obter uma lista de encomendas

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

Name	Chave	Necessário	Tipo	Description
dueDateFrom	dueDateFrom	True	date-time	Filtre por data de vencimento, data de início.
dueDateTo	dueDateTo	True	date-time	Filtre por data de vencimento, data de término.
Número do empregado	employeeNumber		string	Filtrar por número de funcionário.
Número da página	pageNumber		integer	Número da página inicial (padrão 1).
pageSize	pageSize		integer	Tamanho da página (padrão 500).

Devoluções

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Obter uma lista de entradas de cronometragem

ID da Operação:: TimekeepingController_GetTimekeepingDataList

Recupera uma lista de entradas de cronometragem 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 por ClockInTime e, em seguida, por TimekeepingStatusId e em ordem crescente. Os parâmetros de classificação não são configuráveis.

Parâmetros

Name	Chave	Necessário	Tipo	Description
deData	fromDate	True	date-time	Data de início.
até à data	toDate	True	date-time	Data de fim.
Número do empregado	employeeNumber		string	Número de funcionário.
Aprovado	approved		boolean	Filtrar apenas para entradas aprovadas.
fechadoApenas	closedOnly		boolean	Filtro apenas para entrada fechada.
excludeFormData	excludeFormData		boolean	Filtro para excluir dados de formulário.
Número da página	pageNumber		integer	Número da página inicial (padrão 1).
pageSize	pageSize		integer	Tamanho da página (padrão 1000).

Devoluções

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.

Filtre por tipo de evento para obter eventos específicos. Os eventos do veículo podem ser devolvidos para um funcionário se o funcionário estiver associado ao veículo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
deData	fromDate	True	date-time	Início do intervalo de datas.
até à data	toDate	True	date-time	Fim do intervalo de datas.
Número do empregado	employeeNumber		string	Número de funcionário.
número do veículo	vehicleNumber		string	Número do veículo.
Número da página	pageNumber		integer	Número da página inicial.
pageSize	pageSize		integer	Tamanho da página.
eventType	eventType		integer	Filtrar por tipo de evento. O número do funcionário é especificado: UserEvents(0) - apenas eventos de usuário. VehicleEvents(1) - apenas eventos de veículos, incluindo eventos de sensores. ExternalEvents(2) - apenas eventos externos. O número do veículo é especificado: UserEvents(0) - N/D. VehicleEvents(1) - apenas eventos de veículos, incluindo eventos de sensores. ExternalEvents(2) - apenas eventos externos. Nem o número do empregado nem o número do veículo são especificados: UserEvents(0) - apenas eventos de usuário. VehicleEvents(1) - apenas eventos de veículos, incluindo eventos de sensores. ExternalEvents(2) - apenas eventos externos.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
submittedStartDate	submittedStartDate	True	date-time	Data de início do formulário enviado.
submittedEndDate	submittedEndDate	True	date-time	Data de fim do formulário enviado.
apiModuleId	apiModuleId		string	Id do módulo de formulário.
Número do empregado	employeeNumber		string	Número de funcionário.
avaliou	reviewed		boolean	Recupera apenas formulários revisados ou não. O padrão é null para todos.
Número da página	pageNumber		integer	Número da página inicial. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. A predefinição é 1000.

Devoluções

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Obter uma lista de subscrições

ID da Operação:: TrackingController_GetSubscriptions

Recupera uma lista de assinaturas de gancho da Web. 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.

Devoluções

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obter uma lista de utilizadores

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

Name	Chave	Necessário	Tipo	Description
Número da página	pageNumber		integer	Número da página inicial. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. O padrão é 500.

Devoluções

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

Name	Chave	Tipo	Description
Número da página	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 true - retorna apenas veículos ativos. Valor padrão = false.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
deData	fromDate	True	date-time	Início do intervalo de datas. Recomendação: Por favor, use grandes intervalos de datas (>=4 horas) em vez de pequenos intervalos de datas.
até à data	toDate	True	date-time	Fim do intervalo de datas. Recomendação: Por favor, use grandes intervalos de datas (>=4 horas) em vez de pequenos intervalos de datas.
Número do empregado	employeeNumber		string	Número de funcionário.
Vin	vin		string	Número VIN do veículo.
Número da página	pageNumber		integer	Número da página inicial. O padrão é 1.
pageSize	pageSize		integer	Tamanho da página. A predefinição é 1000.
useMetric	useMetric		boolean	Use sistema métrico ou não.

Devoluções

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.

Receba uma encomenda

ID da Operação:: OrderController_GetOrder

Obtém uma ordem existente por seu Id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
id	id	True	string	Id externo ou interno depende do valor no parâmetro use-external-id.
incluir-status-histórico	include-status-history		string	Se verdadeiro, a resposta conterá todo o histórico de status e dados do formulário para esta ordem.
use-external-id	use-external-id		boolean	Use id externo ou não.

Devoluções

Body: CustomerAPI.Models.Order.OrderApiModel

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

Name	Chave	Necessário	Tipo	Description
ID de subscrição	subscriptionId	True	integer	ID da subscrição.

Redefine o status da assinatura do gancho da Web do evento

ID da Operação:: EventController_ResetSubscriptionHealthStatus

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de subscrição	subscriptionId	True	integer	ID da subscrição.

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

Name	Chave	Tipo	Description
Id	Id	string	URL que contém o endereço do WebHookSubscriptionParamsApiModel.
Tipo de Evento	EventType	integer
Código do Evento	EventCode	string
EventTime	EventTime	date-time	Formato ISO com Local e Offset.
DeviceId	DeviceId	string	GpsDeviceDto Id associado à assinatura.
Tipo de dispositivo	DeviceType	integer	Tipo GpsDeviceDto: Telefone (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	ID do usuário.
Identificação do veículo	VehicleId	integer	Identificação do veículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Se um utilizador está ligado ao veículo.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventosParams	EventParams	object	Parâmetros do evento.

Devoluções

response: object

Retorno de chamada Webhook com feed de dados GPS

ID da Operação:: TrackingController_subscribe_callback

Este método de exemplo é usado por gpsdata/subscribe para postar feed de dados de volta usando a URL fornecida pelo cliente.

Parâmetros

Name	Chave	Tipo	Description
Id	Id	string	URL que contém o endereço do WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto Id associado à assinatura.
Tipo de dispositivo	DeviceType	integer	Tipo GpsDeviceDto: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Data e Hora	Timestamp	date-time	Formato ISO com Local e Offset.
Identificação da empresa	CompanyId	integer	Id da empresa.
UserId	UserId	integer	ID do usuário.
Identificação do veículo	VehicleId	integer	Identificação do veículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Se um utilizador está ligado ao veículo.
LocalizaçãoProvider	LocationProvider	string	Nome do provedor de localização.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
PrecisãoFt	AccuracyFt	double	Precisão de posição (pés).
AltitudeFt	AltitudeFt	double	Altitude (pés).
Heading	Heading	integer	Direção da bússola em graus.
SpeedMph	SpeedMph	double	Velocidade de movimento (Mph).
Estado da bateria	BatteryStatus	integer	Estado da bateria: Não carregar(0), Carregar(1).
Nível da bateria	BatteryLevel	integer	Nível da bateria em percentagem.
Estado da Atividade	ActivityState	integer	Estado de atividade: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	O dispositivo está conectado à rede no momento.
Rssi	Rssi	integer	Indicador de intensidade do sinal recebido.
DOdoMl	DOdoMl	double	Odômetro GpsDeviceDto (Milhas).
VOdoMl	VOdoMl	double	conta-quilómetros do veículo (milhas).

Devoluções

response: object

Submeter evento

ID da Operação:: EventController_Post

Submete evento.

Parâmetros

Name	Chave	Tipo	Description
EventDefinitionId	EventDefinitionId	string	ID da definição do evento.
Número de Funcionário	EmployeeNumber	string	Número de funcionário.
Número do veículo	VehicleNumber	string	Número do veículo.
DeviceSerialNumber	DeviceSerialNumber	string	Número de série GpsDeviceDto.
Latitude	Latitude	double
Longitude	Longitude	double
EndereçoLinha1	AddressLine1	string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode	string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName	string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode	string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode	string	Código de região do LocationApiModel.
Time	Time	date-time
Parâmetros	Parameters	object	Parâmetros do evento.

Subscrever gancho web de dados GPS

ID da Operação:: TrackingController_SubscribeToGpsDataFeed

Adiciona novos dados de rastreamento GPS (posições GPS) web hook. Os ganchos da Web permitem que você receba posições de GPS que ocorrem em uma URL especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Endereço URL	Url		string	URL que contém o endereço do WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de segurança associado a este WebHookSubscriptionParamsApiModel.

Devoluções

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Acionadores

Pesquisa de dados de formulário	O ponto de extremidade de sondagem da API de formulários permite que seu aplicativo pesquise e processe continuamente formulários autônomos enviados recentemente. Integração: Este ponto de extremidade foi projetado para funcionar imediatamente com o Microsoft Flow como uma integração de gatilho de sondagem. Alternativamente, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Utilização: 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 registos de formulários submetidos recentemente; O corpo da resposta exibirá os dados do formulário. Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Localização - O URL para o próximo pedido. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados para recuperar, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados para recuperar, o valor do cabeçalho Retry-After será 300. Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os parâmetros necessários para garantir que os formulários não estejam faltando na 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: tag de tempo interno = hora da última alteração de dados de formulário.
Pesquisa de status do pedido	O ponto de extremidade de sondagem da API de Status de Pedidos permite que seu aplicativo pesquise e processe continuamente alterações recentes em pedidos. Integração: Este ponto de extremidade foi projetado para funcionar imediatamente com o Microsoft Flow como uma integração de gatilho de sondagem. Alternativamente, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Utilização: 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 registos de estado da encomenda recentemente alterados; O corpo da resposta exibirá os dados de status do pedido Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Localização - O URL para o próximo pedido. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados para recuperar, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados para recuperar, o valor do cabeçalho Retry-After será 300. Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele 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: tag de tempo interno = hora da última alteração de dados de status do pedido.
Sondagem de cronometragem	O ponto de extremidade de sondagem da API de cronometragem permite que seu aplicativo pesquise e processe continuamente entradas de cronometragem enviadas recentemente. Integração: Este ponto de extremidade foi projetado para funcionar imediatamente com o Microsoft Flow como uma integração de gatilho de sondagem. Alternativamente, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Utilização: 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 registos de cronometragem submetidos recentemente; O corpo da resposta exibirá os dados de entrada de cronometragem. Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Localização - O URL para o próximo pedido. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados para recuperar, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados para recuperar, o valor do cabeçalho Retry-After será 300. Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os necessários para garantir que as entradas de cronometragem não faltem na 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: tag de hora interna = hora da última alteração de status de cronometragem.
Sondagem de encomendas	O ponto de extremidade de sondagem da API de pedidos permite que seu aplicativo pesquise e processe continuamente as alterações recentes nos pedidos. Integração: Este ponto de extremidade foi projetado para funcionar imediatamente com o Microsoft Flow como uma integração de gatilho de sondagem. Alternativamente, você pode desenvolver sua própria integração personalizada usando qualquer idioma. Utilização: 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 ordens recentemente alteradas; O corpo da resposta exibirá os dados do pedido. Código de resposta HTTP 202 - Não existem ordens alteradas recentemente; O corpo de resposta estará vazio. Em ambos os casos, há dois (2) cabeçalhos importantes na resposta: Localização - O URL para o próximo pedido. Retry-After - O intervalo de tempo recomendado em segundos para a próxima solicitação. Por exemplo, se houver dados para recuperar, o cabeçalho Retry-After terá um valor de 1 ou 60. Se não houver dados para recuperar, o valor do cabeçalho Retry-After será 300. Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os parâmetros necessários para garantir que as alterações de ordem não estejam faltando 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: tag de tempo interno = hora da última alteração de dados do pedido.

Pesquisa de dados de formulário

ID da Operação:: FormController_Poll

O ponto de extremidade de sondagem da API de formulários permite que seu aplicativo pesquise e processe continuamente formulários autônomos enviados recentemente.

Integração:

Este ponto de extremidade foi projetado para funcionar imediatamente com o Microsoft Flow como uma integração de gatilho de sondagem. Alternativamente, você pode desenvolver sua própria integração personalizada usando qualquer idioma.

Utilização:

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 registos de formulários submetidos recentemente; O corpo da resposta exibirá os dados do formulário.
Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio.

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

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

Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os parâmetros necessários para garantir que os formulários não estejam faltando na 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: tag de tempo interno = hora da última alteração de dados de formulário.

Devoluções

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Pesquisa de status do pedido

ID da Operação:: OrderController_StatusPoll

O ponto de extremidade de sondagem da API de Status de Pedidos permite que seu aplicativo pesquise e processe continuamente alterações recentes em pedidos.

Integração:

Utilização:

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 registos de estado da encomenda recentemente alterados; O corpo da resposta exibirá os dados de status do pedido
Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio.

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

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

Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele 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: tag de tempo interno = hora da última alteração de dados de status do pedido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
excludeFormData	excludeFormData		boolean	Se true, FieldValues será sempre uma matriz vazia.

Devoluções

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Sondagem de cronometragem

ID da Operação:: TimekeepingController_Poll

O ponto de extremidade de sondagem da API de cronometragem permite que seu aplicativo pesquise e processe continuamente entradas de cronometragem enviadas recentemente.

Integração:

Utilização:

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 registos de cronometragem submetidos recentemente; O corpo da resposta exibirá os dados de entrada de cronometragem.
Código de resposta HTTP 202 - Não existem registos submetidos recentemente; O corpo de resposta estará vazio.

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

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

Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os necessários para garantir que as entradas de cronometragem não faltem na 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: tag de hora interna = hora da última alteração de status de cronometragem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
excludeFormData	excludeFormData		boolean	Se true, ClockInFormData e ClockOutFormData serão sempre nulos.

Devoluções

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Sondagem de encomendas

ID da Operação:: OrderController_Poll

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

Integração:

Utilização:

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 ordens recentemente alteradas; O corpo da resposta exibirá os dados do pedido.
Código de resposta HTTP 202 - Não existem ordens alteradas recentemente; O corpo de resposta estará vazio.

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

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

Nota: Estes são apenas valores recomendados - a sua aplicação pode optar por sondar com uma frequência diferente, dependendo dos seus requisitos. Após a primeira solicitação, todas as solicitações subsequentes devem usar a URL fornecida no cabeçalho Location da resposta mais recente. Não adicione mais parâmetros ao URL, pois ele já contém os parâmetros necessários para garantir que as alterações de ordem não estejam faltando 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: tag de tempo interno = hora da última alteração de dados do pedido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
excludeFormData	excludeFormData		boolean	Se true, OrderFormFields sempre será uma matriz vazia.
excludeCustomFieldData	excludeCustomFieldData		boolean	Se true, CustomFields não será retornado.

Devoluções

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Definições

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Caminho	Tipo	Description
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Caminho	Tipo	Description
Id	Id	integer	Id do Cliente.
Identificação externa	ExternalId	string	ID de uso externo para o cliente - propriedade de extensão de API.
CreatedUtc	CreatedUtc	date-time	O ponto no tempo original em que o Cliente foi criado.
ModifiedUtc	ModifiedUtc	date-time	O último momento em que o Cliente foi atualizado.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Nome	Name	string	Nome do Cliente.
Address	Address	CustomerAPI.Models.LocationApiModel
Contato	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	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.
Valor	Value		Valor do campo.

CustomerAPI.Models.LocationApiModel

Name	Caminho	Tipo	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
EndereçoLinha1	AddressLine1	string	AddressLine1 deste LocationApiModel.
Linha de Endereço 2	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	Código Postal do LocationApiModel.
Código de País	CountryCode	string	Código ISO 3166-1 alpha-2.
Nome da subregião	SubRegionName	string	Sub-região do LocationApiModel.
Código da sub-região	SubRegionCode	string	Código da sub-região do LocationApiModel.
Código da Região	RegionCode	string	Código de região do LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

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

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Caminho	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Caminho	Tipo	Description
Id	Id	integer	ID do objeto.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Define o Modelo de API de Item de Lista de Definição de Lista Personalizada.

Name	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 personalizada.

Name	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.

Name	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 de Coluna de Definição de Lista Personalizada.

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

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

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

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

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Este modelo define o valor da coluna de lista personalizada.

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

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Modelo de definição de evento personalizado.

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

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

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

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

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

CustomerAPI.Models.UserReferenceApiModel

Name	Caminho	Tipo	Description
UserId	UserId	integer	UserId do Usuário.
Primeiro Nome	FirstName	string	Nome próprio do Utilizador.
Apelido	LastName	string	Apelido do Utilizador.
Número de Funcionário	EmployeeNumber	string	Número de funcionário do Utilizador.
Nome do Grupo	GroupName	string	Nome do Grupo atribuído ao Utilizador.

CustomerAPI.Models.ReadVehicleApiModel

Name	Caminho	Tipo	Description
Identificação do veículo	VehicleId	integer	Id do BaseVehicleApiModel.
Nome	Name	string	Nome do BaseVehicleApiModel.
VIN	VIN	string	Número de identificação do veículo BaseVehicleApiModel.
Nome do dispositivo	DeviceName	string	Nome de GpsDeviceDto associado com o BaseVehicleApiModel.
SerialNumber	SerialNumber	string	SerialNumber do BaseVehicleApiModel.
Nome do Grupo	GroupName	string	GroupName do BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

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

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Caminho	Tipo	Description
Id de Subscrição	SubscriptionId	string	Id do WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Caminho	Tipo	Description
Id de Subscrição	SubscriptionId	string
Endereço URL	Url	string
Situação	Status	integer	Estado da subscrição - (Em execução: 1, Parado: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Caminho	Tipo	Description
Id	Id	integer	Id associado 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.
Número de entrada	EntryNumber	string	Número de entrada de dados do formulário.
Avaliado	Reviewed	boolean	Status da revisão deste StandaloneFormApiModel.
User	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.
SubmittedLocalização	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
RevisãoByTime	ReviewedByTime	date-time	Hora da revisão do formulário

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Caminho	Tipo	Description
Repetíveis	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	Id do FormFieldDataApiModel.
Valor	Value		Valor do FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue do FormFieldDataApiModel.
Tempo Capturado	CapturedTime	date-time	O valor point-in-time foi capturado do FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Legenda	Caption	string	Conteúdo da legenda do FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id do ApiField do FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Caminho	Tipo	Description
Id	Id	string	Id do FormFieldDataApiModel.
Valor	Value		Valor do FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue do FormFieldDataApiModel.
Tempo Capturado	CapturedTime	date-time	O valor point-in-time foi capturado do FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Legenda	Caption	string	Conteúdo da legenda do FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id do ApiField do FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Caminho	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId do GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc do GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc do GeofenceApiModel.
Nomes de Grupo	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.
Address	Address	CustomerAPI.Models.LocationApiModel
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceEndereço	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Name	Caminho	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Caminho	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId do GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc do GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc do GeofenceApiModel.
Nomes de Grupo	GroupNames	array of string	GroupPaths do GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Pontos de polígono. Deve ser preenchido quando 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.
Address	Address	CustomerAPI.Models.LocationApiModel
Raio	Radius	double	Raio do GeofenceApiModel.
UseGeofenceEndereço	UseGeofenceAddress	boolean	UseGeofenceAddress do GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Caminho	Tipo	Description
ID de Pedido	OrderId	integer	Id do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Uso externo OrderId para o cliente - API Extension propriedade.
Data de vencimento	DueDate	date-time	Ponto no tempo este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Ponto no tempo este OrderBaseApiModel deve iniciar (introduzido na v1.3).
EndTime	EndTime	date-time	Ponto no tempo 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 este OrderBaseApiModel foi criado.
Número da encomenda	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.
ID do Cliente	ClientId	integer	ID de uso interno para o cliente - Propriedade de extensão de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Id do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo de campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Caminho	Tipo	Description
StatusIndex	StatusIndex	integer	Índice do OrderStatusApiModel.
Tipo de Estado	StatusType	integer	Status do pedido: 0 para novo pedido, 1 para despachado, 2 para em andamento, 3 para concluído e 4 para cancelado.
StatusLabel	StatusLabel	string	Conteúdo do rótulo do OrderStatusApiModel.
StatusId	StatusId	integer	Id do OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Ponto no tempo de início do OrderStatusApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

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

CustomerAPI.Models.Order.OrderApiModel

Name	Caminho	Tipo	Description
StatusHistórico	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Lista dos OrderStatusListItems associados a este OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
ID de Pedido	OrderId	integer	Id do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Uso externo OrderId para o cliente - API Extension propriedade.
Data de vencimento	DueDate	date-time	Ponto no tempo este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Ponto no tempo este OrderBaseApiModel deve iniciar (introduzido na v1.3).
EndTime	EndTime	date-time	Ponto no tempo 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 este OrderBaseApiModel foi criado.
Número da encomenda	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.
ID do Cliente	ClientId	integer	ID de uso interno para o cliente - Propriedade de extensão de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Id do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo de campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Caminho	Tipo	Description
StatusStartDateTime	StatusStartDateTime	date-time	Ponto no tempo este OrderStatusHistoryListItemApiModel Status foi iniciado.
StatusEndDateTime	StatusEndDateTime	date-time	Ponto no tempo em que este status OrderStatusHistoryListItemApiModel foi encerrado.
StatusId	StatusId	integer	Id associado a este OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Índice associado a este OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Rotule o conteúdo associado a este OrderStatusHistoryListItemApiModel.
Tipo de Estado	StatusType	integer	Status do pedido: 0 para novo pedido, 1 para despachado, 2 para em andamento, 3 para concluído e 4 para cancelado.
ExternalOrderId	ExternalOrderId	string	Uso externo OrderId para o cliente - API Extension propriedade.
ID de Pedido	OrderId	integer	OrderId associado a este OrderStatusHistoryListItemApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
Endereço Inicial	StartAddress	CustomerAPI.Models.LocationApiModel
Endereço final	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

Name	Caminho	Tipo	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
ID de Pedido	OrderId	integer	Id do OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Uso externo OrderId para o cliente - API Extension propriedade.
Data de vencimento	DueDate	date-time	Ponto no tempo este OrderBaseApiModel deve ser concluído (obsoleto na v1.3).
StartTime	StartTime	date-time	Ponto no tempo este OrderBaseApiModel deve iniciar (introduzido na v1.3).
EndTime	EndTime	date-time	Ponto no tempo 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 este OrderBaseApiModel foi criado.
Número da encomenda	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.
ID do Cliente	ClientId	integer	ID de uso interno para o cliente - Propriedade de extensão de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Id do ApiService associado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versão do módulo de campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name	Caminho	Tipo	Description
Id	Id	integer	Id da entrada Timekeeping (comentário herdado: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Ponto no tempo em que o usuário entrou no sistema.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Ponto no tempo em que o usuário saiu do sistema.
ClockOutLocalização	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHoras	TotalHours	double	Número total de horas para esta entrada de cronometragem.
TotalBreakHours	TotalBreakHours	double	Número total de horas de pausa (não úteis) para esta entrada de cronometragem.
Horas de rede	NetHours	double	Número total de horas cobradas por esta entrada de cronometragem.
Aprovado	Approved	boolean	Status da aprovação do supervisor para esta entrada de cronometragem.
Pausas	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 Empresa utilizado para submeter esta entrada de Cronometragem.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Caminho	Tipo	Description
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Hora de início.
InícioLocalização	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Hora de fim.
Localização final	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Duração em horas. Pode ser null se EndTime for null.
Tipo de Estado	StatusType	integer	Tipo de status: 1 para intervalo e 2 para almoço.
Rótulo inicial	StartLabel	string	Iniciar rótulo.
Rótulo final	EndLabel	string	Rótulo final.
Legenda	Caption	string	Legenda.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

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

System.Version

Name	Caminho	Tipo
_Major	_Major	integer
_Minor	_Minor	integer
_Build	_Build	integer
_Revision	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Caminho	Tipo	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Veículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Ponto no tempo em que este Status do TripApiModel foi iniciado.
EndTime	EndTime	date-time	Ponto no tempo em que este Status TripApiModel foi encerrado.
InícioLocalização	StartLocation	CustomerAPI.Models.LocationApiModel
Localização final	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 associada a este TripApiModel.
TotalIdleTime	TotalIdleTime	double	Quantidade de tempo ocioso em horas associado a este TripApiModel.
Duração Total	TotalDuration	double	Tempo total em horas associado a este TripApiModel.
Distância	Distance	double	Distância percorrida em unidades localizadas associadas a este TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Caminho	Tipo	Description
Registos	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Caminho	Tipo	Description
User	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_
Perímetro Geográfico	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Velocidade	Speed	double	Velocidade de movimento associada a este GpsDataRecordApiModel.
Heading	Heading	double	Direção da bússola em graus associados a este GpsDataRecordApiModel.
Situação	Status	integer	ApiMovementStatus associado ao OrderBaseApiModel - (Parado: 1, Inativo: 2, Movendo: 3, NotTracking: 4) : OrderStatusApiModel.
StatusTime	StatusTime	string	Ponto no tempo este GpsDataRecordApiModel Status foi definido.
Distância	Distance	double	Distância percorrida em unidades localizadas associadas a este TripApiModel.
IgniçãoOn	IgnitionOn	boolean	Estado de ignição do veículo associado a este GpsDataRecordApiModel.
LocalizaçãoProvider	LocationProvider	integer	Api Location Provider associado a este GpsDataRecordApiModel - (GPS: 1, Rede: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Caminho	Tipo	Description
Nome de Utilizador	UserName	string	Nome de usuário do usuário.
UserId	UserId	integer	Valor de id do usuário.
Nome do Grupo	GroupName	string	Nome do grupo do usuário.
Primeiro Nome	FirstName	string	Nome próprio do Utilizador.
Apelido	LastName	string	Apelido do Utilizador.
Número de Funcionário	EmployeeNumber	string	Número de funcionário do Utilizador.
Email	Email	string	Endereço de e-mail do Utilizador.
Telemóvel	Phone	string	Número de telefone do Utilizador.
RoleId	RoleId	integer	RoleId do Usuário - (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Estado ativo do Utilizador.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booleano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Enhanced Push-to-Talk para User: string.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pela Kodiak.
EPTTToken	EPTTToken	string	API Token usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
Apenas para dispositivos móveis	MobileOnly	boolean	Status do acesso ao aplicativo Web desktop para CAB - (Sem acesso WebApp: True, Acesso Completo ao Aplicativo: False).
Tipo de Licença	LicenseType	integer	Tipo de Licença atribuída ao utilizador: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Caminho	Tipo	Description
UserId	UserId	integer	Valor de id do usuário.
Primeiro Nome	FirstName	string	Nome próprio do Utilizador.
Apelido	LastName	string	Apelido do Utilizador.
Número de Funcionário	EmployeeNumber	string	Número de funcionário do Utilizador.
Email	Email	string	Endereço de e-mail do Utilizador.
Telemóvel	Phone	string	Número de telefone do Utilizador.
RoleId	RoleId	integer	RoleId do Usuário - (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Estado ativo do Utilizador.
EPTTEnabled	EPTTEnabled	boolean	Status do recurso Push-to-Talk aprimorado para o usuário: booleano.
EPTTNumber	EPTTNumber	string	Número de telefone para o recurso Enhanced Push-to-Talk para User: string.
EPTTWebMDN	EPTTWebMDN	string	Número de telefone usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pela Kodiak.
EPTTToken	EPTTToken	string	API Token usado para autenticar o usuário no sistema Kodiak EPTT - Fornecido pelo Kodiak.
GPSEnabled	GPSEnabled	boolean	Status do recurso GPS para o usuário.
Apenas para dispositivos móveis	MobileOnly	boolean	Status do acesso ao aplicativo Web desktop para CAB - (Sem acesso WebApp: True, Acesso Completo ao Aplicativo: False).
Tipo de Licença	LicenseType	integer	Tipo de Licença atribuída ao utilizador: - 0 para Indefinido, 1 para Regular, 2 para WebOnly e 3 para Funcionário.

CustomerAPI.Models.Vehicles.VehicleReadApi

Modelo de Dados do Veículo.

Name	Caminho	Tipo
Identificação interna	InternalId	integer
Número	Number	string
Nome	Name	string
Tipo	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
Nome do Grupo	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

número inteiro

Este é o tipo de dados básico 'inteiro'.

objecto

Este é o tipo 'objeto'.

Partilhar via

TeamWherx

A criar uma ligação

Padrão

Limites de Limitação

Ações

Ativar um utilizador

Parâmetros

Ativar um veículo

Parâmetros

Devoluções

Atualizar o status do pedido

Parâmetros

Devoluções

Atualizar parte de um usuário

Parâmetros

Devoluções

Atualizar um cliente

Parâmetros

Devoluções

Atualizar um utilizador

Parâmetros

Devoluções

Atualizar um veículo

Parâmetros

Devoluções

Atualizar uma cerca geográfica existente

Parâmetros

Devoluções

Atualizar uma encomenda

Parâmetros

Devoluções

Atualização parcial de um veículo

Parâmetros

Devoluções

Cancelar inscrição GPS data web hook

Parâmetros

Cancelar inscrição no gancho da web de eventos

Parâmetros

Carregar arquivo binário

Devoluções

Carregar ficheiro anexo

Devoluções

Criar ou atualizar o registro de lista personalizada

Parâmetros

Criar ou atualizar uma definição de evento personalizada

Parâmetros

Criar um cliente

Parâmetros

Devoluções

Criar um formulário

Parâmetros

Devoluções

Criar um utilizador

Parâmetros

Devoluções

Criar um veículo

Parâmetros

Devoluções

Criar uma cerca geográfica

Parâmetros

Devoluções

Criar uma encomenda

Parâmetros

Devoluções

Desativar um utilizador

Parâmetros

Desativar um veículo

Parâmetros

Devoluções

Eliminar um veículo

Parâmetros

Excluir registro de lista personalizada

Parâmetros

Excluir um cliente

Parâmetros

Excluir uma cerca geográfica

Parâmetros

Excluir uma definição de evento personalizada

Parâmetros