TeamWherx

TeamWherx(TW) es una plataforma de administración de servicios todo en uno que le ayuda a administrar de forma más eficaz los equipos remotos de empleados y operaciones empresariales generales fuera de la oficina. Como solución basada en la nube, TW permite la recopilación remota de datos y la muestra a través de su panel de aplicaciones web, lo que proporciona a los administradores la información adicional que necesitan para crear estrategias más inteligentes para aumentar la eficiencia, la productividad y reducir los costos a la vez que coordinan sus empleados móviles.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Soporte técnico de Actsoft
URL	https://www.actsoft.com/self-help-wizards
Correo Electrónico	support@actsoft.com

Metadatos del conector
Publicador	Actsoft
Sitio web	https://actsoft.com
Directiva de privacidad	https://www.actsoft.com/privacy
Categorías	Productividad

Descripción del conector:

TeamWherx le permite crear y capturar información de formulario digital, información de mantenimiento de tiempo de los empleados y administrar los pedidos de trabajo con un sistema de distribución.

Descripción detallada

El conector TeamWherx permite a los usuarios conectarse e intercambiar información entre varias plataformas. Puede animar los datos para crear flujos de proceso, impulsar otras aplicaciones internas e informar a los análisis eficaces. Automatice y optimice los procesos diarios, semanales o mensuales con acceso a up-todatos accionables en el momento.

Requisitos previos de ##

Para usar este conector, necesitará lo siguiente:

Cuenta teamWherx
Clave de API teamWherx
Plan de Microsoft Power Apps o Power Automate

## Obtención de credenciales

Portal para desarrolladores de API

Para acceder al conector, primero debe configurar un nombre de usuario y una contraseña para el portal para desarrolladores de API y suscribirse a la API del cliente:

Desde dentro de la aplicación, vaya a Configuración administrativa>configuración>de API.
Elija Crear credenciales.
Escriba su nombre y apellido en los campos adecuados.
Escriba su dirección de correo electrónico en el campo Dirección de correo electrónico.
Elija Guardar e invitación por correo electrónico. A continuación, compruebe el correo electrónico para obtener instrucciones sobre cómo crear una contraseña.
Una vez dentro del correo electrónico de invitación, haga clic en Elegircontraseña, que abrirá un cuadro de diálogo que le permitirá crear una contraseña.
Elija Guardar contraseña.
Para continuar con el portal para desarrolladores, desde dentro de la aplicación, vaya aConfiguración>administrativa>Vayaal portal para desarrolladores.
En el portal para desarrolladores, elija Productos y, a continuación, seleccione API de cliente.
Elija Suscribirse.

Clave de API

Ahora que es un usuario de API registrado, se ha generado una secuencia alfanumérica, denominada clave. Necesitará esta clave para trabajar con los datos de la API.

Para buscar la clave de API:

Elija Productos en el menú portal para desarrolladores. Se mostrarán los productos de API disponibles en la licencia.
Seleccione la versión de API del cliente , en "Tiene suscripciones X a este producto".
Elija Mostrar junto a la clave principal de la suscripción.
Seleccione el contenido del campo, haga clic con el botón derecho y elija Copiar. La clave ahora se guarda en el Portapapeles y está lista para pegarla.

## Introducción al conector

Vaya a Mis flujos>Nuevo flujo y, a continuación, seleccione Flujo de nube automatizado.
Elija Desencadenar manualmente un flujo en el cuadro de diálogo Compilar un flujo de nube automatizado.
Asigne un nombre al flujo o deje que el sistema genere uno automáticamente.
Busque y elija un desencadenador para el flujo.
Seleccione Crear.
En el campo de búsqueda, busque y elija el conector TeamWherx.
Busque la acción que desea realizar con el conector.

El sistema le pedirá que inicie sesión en todas las aplicaciones necesarias para realizar la acción elegida, omitiendo los que ya haya iniciado sesión.

Escriba un nombre para el nuevo conector en el campo Conector.
A continuación, escriba la clave de API.
Seleccione Crear. El primer paso del flujo de proceso se muestra como el primer "cuadro" en un diagrama de flujo.
Elija Nuevopaso para continuar agregando más acciones y pasos al flujo de proceso del conector.
Elija Guardar.

**Uso del conector: ejemplo de sondeo de estado de pedido
** Las instrucciones siguientes muestran cómo crear un flujo de proceso para insertar filas en una hoja de cálculo e insertar datos de identificación del empleado que actualizaron el pedido cuando se actualiza un estado de pedido.

Vaya a Conectores.
Busque y elija el conector [TeamWherx].
Elija Estado de pedido sondear en la lista de acciones.
Escriba un nombre para la nueva conexión en el campo Nombre de conexión.
A continuación, escriba la clave de API.
Seleccione Crear. El primer paso del flujo de proceso se muestra como el primer "cuadro" en un diagrama de flujo.

Cada cuadro de diálogo de acción de los pasos del flujo de conexión tendrá campos de propiedad que puede personalizar para controlar la acción realizada.

Siguiendo con el ejemplo, elija si desea que se muestren los valores de campo de Formularios (parámetro excludeFormData).
Elija la versión de X-API para la conexión.
Elija Siguiente paso para establecer la acción que desea que se produzca cuando se cambie un estado de pedido.
En el cuadro de diálogo Elegir una operación , use el campo de búsqueda para buscar la aplicación y, a continuación, la acción deseada. Por ejemplo, si desea insertar una fila en una hoja de cálculo de Google cada vez que se cambia un estado de pedido, elegiría Hojas de Google y, a continuación, insertarfila para la acción.
En el cuadro de diálogo Insertarfila siguiente, haga clic en el campo Archivo y elija el archivo que contendrá los resultados.
En el campo Hoja de cálculo , elija el tipo de hoja de cálculo de datos . Los campos que se muestran dinámicamente son las columnas de datos de la hoja de cálculo.
Haga clic en el campo para cada columna y elija una propiedad en la lista de propiedades de sondeo de estado de pedido . O bien, puede usar el campo de búsqueda para buscar una propiedad específica.
Puede escribir más de una propiedad en cada campo de columna; en la columna Evento, elija StatusLabel, inserte un guión y, a continuación, elija StatusStartDate. Esto significa que, para cada actualización de estado de pedido, la etiqueta de estado y la fecha de inicio del estado se escribirán en la columna Evento de la nueva fila.
Seleccione Nuevopaso. Como nota aparte, siempre puede mantener el puntero y hacer clic en el conector de flecha para insertar un nuevo paso.
En el cuadro de diálogo Elegir una operación, seleccione de nuevo el conector TeamWherx y, a continuación, Cree un cliente para la acción.

De nuevo, cada campo que se muestra en el cuadro de diálogo representará una columna en la hoja de cálculo de Hojas de Google. Haga clic en cada campo para activar la lista de propiedades de sondeo Estado de pedido y seleccione las propiedades que desee.

En este ejemplo, elija EmployeeNumber para el campo Nombre para identificar al empleado que actualizó el estado del pedido.
Elija GroupName e insértelo también en el campo Nombre .
Elija Guardar.

Ahora, ha creado un flujo de proceso que actualizará la hoja de cálculo con el número de empleado y su grupo asociado cada vez que se actualice un estado de pedido.

## Problemas conocidos y limitaciones

Las cargas binarias de archivos de audio (POST) para todos los puntos de conexión solo se limitan a MP4.
Las fechas de todos los puntos de conexión que requieren información de fecha y hora deben especificarse según RFC3339 directrices, como en el ejemplo siguiente: 2021-09-22T02:36:56.52Z. No es necesario especificar los segundos exactos en la marca de tiempo; 00 es aceptable.

## Errores y soluciones comunes

Puede encontrar ejemplos de errores comunes que pueden producirse, códigos de respuesta y correcciones en los portales de desarrolladores de API:

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

Preguntas más frecuentes sobre ##

Creación de una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
Clave de API	securestring	La clave de API de esta API	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Activación de un usuario	Activa un usuario existente por su identificador.
Activar un vehículo	Active un vehículo por identificador.
Actualización de una geovalla existente	Actualiza una geovalla existente por su identificador.
Actualización parcial de un vehículo	Actualización parcial de un vehículo por identificador.
Actualizar parte de un usuario	Actualiza parte de las propiedades del usuario.
Actualizar un cliente	Actualiza un cliente existente.
Actualizar un pedido	Actualiza un pedido existente.
Actualizar un usuario	Actualiza un usuario existente.
Actualizar un vehículo	Actualizar un vehículo por identificador.
Cancelación de la suscripción de webhook de datos GPS	Elimina una suscripción de webook de datos GPS por su identificador.
Cancelar la suscripción de eventos webhook	Elimina una suscripción de web hook de eventos por su identificador.
Carga de un archivo binario	Use esta opción para cargar imágenes de formulario y archivos de audio. El tamaño binario está limitado a 10 MB. Los tipos de archivo admitidos son: JPEG, PNG y MP4.
Cargar archivo adjunto	Use esta opción para cargar datos adjuntos de archivos de formulario. El tamaño binario está limitado a 25 MB. Se esperaba una solicitud multipart/form-data con un único archivo.
Crea un pedido.	Agrega un nuevo orden.
Creación de un usuario	Crea un nuevo usuario.
Creación de un vehículo	Crea un vehículo.
Creación de una geovalla	Crea una nueva geovalla.
Creación o actualización de una definición de evento personalizada	Crea o actualiza una definición de evento personalizada.
Crear o actualizar un registro de lista personalizado	Crea o actualiza el registro de datos de lista personalizado. Se puede omitir el valor de columna única, pero si está presente, debe coincidir con el valor de Identificador único en el parámetro de consulta.
Crear un cliente	Crea un nuevo cliente.
Crear un formulario	Agrega un nuevo formulario.
Desactivar un usuario	Desactiva un usuario existente por su identificador.
Desactivar un vehículo	Desactive un vehículo por identificador.
Devolución de llamada de webhook con fuente de distribución de datos GPS	Gpsdata/subscribe usa este método de ejemplo para publicar la fuente de distribución de datos mediante la dirección URL proporcionada por el cliente.
Devolución de llamada de webhook con fuente de eventos	Los eventos o la suscripción usan este método de ejemplo para publicar la fuente de distribución de datos de eventos mediante la dirección URL proporcionada por el cliente.
Eliminación de un cliente	Elimina un cliente existente por su identificador.
Eliminación de una definición de evento personalizada	Elimina una definición de evento personalizada.
Eliminar registro de lista personalizado	Elimina el registro existente en la lista personalizada por su customListId e id. id: es un valor único del registro de lista personalizado. Errores: 404: customListId o identificador no encontrado.
Eliminar un vehículo	Elimina un vehículo por identificador.
Eliminar una geovalla	Elimina una geovalla existente por su identificador.
Enviar evento	Envía el evento.
Estado del pedido de actualización	Cambia el estado de un pedido existente.
Obtención de datos de lista personalizados por CustomListID	Recupera todos los registros de datos de una sola lista personalizada mediante CustomListID. Los resultados se ordenan por columna y se admite la paginación. Errores: 404: no hay ninguna lista personalizada para customListId proporcionada.
Obtención de definiciones de lista personalizadas	Recupera una lista de definiciones de lista personalizada. La lista de definiciones contiene CustomListID, Name y Version para todas las listas personalizadas existentes.
Obtención de entradas de datos GPS	Recupera entradas de datos GPS para un intervalo de fechas especificado. También devuelve un token de continuación y un vínculo para obtener la siguiente parte de datos. Puede especificar el número de páginas devueltas y el número de elementos por página. No se devuelven posiciones para usuarios o vehículos eliminados. Sin embargo, si el usuario o vehículo existía cuando se solicitaron datos y se quitaron posteriormente, se devolverán los datos del usuario o vehículo solicitados por un token de continuación. Los resultados se ordenan automáticamente por UtcTime y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtención de la versión secundaria	Devuelve la versión secundaria actual de la API.
Obtención de una definición de evento personalizada por identificador	Recupera una única definición de evento personalizada por identificador.
Obtener la lista de campos de lista personalizados por CustomListID	Recupera una lista de campos de una sola lista personalizada mediante CustomListID.
Obtener un cliente	Recupera un objeto de cliente por su identificador.
Obtener un formulario	Recupera un formulario por su identificador.
Obtener un pedido	Obtiene un orden existente por su identificador.
Obtener un registro único de la lista personalizada	Recupera el registro de datos de lista personalizado único encontrado por CustomListId y el valor de columna único. Errores: 404: no hay ningún registro de lista personalizado para customListId proporcionado y un valor de columna único
Obtener un usuario	Obtiene un usuario por su identificador.
Obtener un vehículo por identificador	Recupera un solo vehículo por identificador.
Obtener una entrada de mantenimiento de tiempo	Recupera una entrada por su identificador.
Obtener una geovalla	Recupera una geovalla por su identificador.
Obtener una lista de clientes	Recupera una lista de clientes. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por Nombre y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de definiciones de eventos personalizados	Recupera una lista de definiciones de eventos personalizadas.
Obtener una lista de entradas de mantenimiento de tiempo	Recupera una lista de entradas de mantenimiento de tiempo en función del intervalo de fechas. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por ClockInTime y, a continuación, por TimekeepingStatusId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de eventos	Recupera una lista de eventos durante un período de tiempo específico. Puede especificar el número de páginas devueltas y el número de elementos por página. Filtre por tipo de evento para obtener eventos específicos. Los eventos de vehículo se pueden devolver para un empleado si el empleado está asociado al vehículo.
Obtener una lista de formularios	Recupera una lista de formularios mediante cualquiera de los filtros de los parámetros de solicitud que se muestran a continuación. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubmittedTime y en orden descendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de geovallas	Recupera una lista de geovallas. Puede especificar el número de páginas devueltas y el número de elementos por página, así como si las coordenadas de geovalla son métricas. Los resultados se ordenan automáticamente por Nombre y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de pedidos	Recupera una lista de pedidos mediante los filtros de los parámetros de solicitud que se muestran a continuación. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por Client.Name y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de suscripciones	Recupera una lista de suscripciones de web hook. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubscriptionId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de suscripciones de webook de eventos	Recupera una lista de suscripciones de webhook de eventos. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubscriptionId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de usuarios	Recupera una lista de usuarios. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por UserId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Obtener una lista de vehículos	Recupera una lista de vehículos.
Obtener una lista de viajes	Recupera una lista de viajes durante un período de tiempo específico. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por StartUtcTIme y en orden ascendente. Los parámetros de ordenación no se pueden configurar.
Restablece el estado de la suscripción	Cambia el estado de la suscripción al estado = 1 ("En ejecución").
Restablece el estado de la suscripción de webook de eventos	Cambia el estado de la suscripción al estado = 1 ("En ejecución").
Suscribirse a eventos webhook	Agrega una nueva suscripción de web hook de eventos. Los enlaces web permiten recibir notificaciones automáticas sobre eventos de la empresa que se producen en una dirección URL especificada.
Suscripción de webhook de datos GPS	Agrega un nuevo webhook de datos de seguimiento GPS (posiciones GPS). Los enlaces web permiten recibir posiciones GPS que se producen en una dirección URL especificada.

Activación de un usuario

Id. de la operación:: UserController_Activate

Activa un usuario existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Activar un vehículo

Id. de la operación:: VehicleController_Activate

Active un vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

response: integer

Actualización de una geovalla existente

Id. de la operación:: GeofenceController_UpdateGeofence

Actualiza una geovalla existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Identificador de geovalla.
GroupNames	GroupNames		array of string	GroupPaths de GeofenceUpdateApiModel.
Latitude	Latitude		double
Longitude	Longitude		double
Nombre	Name		string	Nombre de GeofenceApiModelBase.
Tipo	Type		string	Tipo de GeofenceApiModel.
Shape	Shape		integer	Forma: 0 para círculo y 1 para polígono.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Radius	Radius		double	Radio de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress de GeofenceApiModel.
useMetric	useMetric		boolean	Use o no el sistema de métricas.
geocódigo	geocode		boolean	Debe estar codificada geográficamente o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualización parcial de un vehículo

Id. de la operación:: VehicleController_PartialUpdateVehicle

Actualización parcial de un vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualizar parte de un usuario

Id. de la operación:: UserController_PartialUpdate

Actualiza parte de las propiedades del usuario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
			object
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualizar un cliente

Id. de la operación:: ClientController_Update

Actualiza un cliente existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
ExternalId	ExternalId		string	Identificador de uso externo para la propiedad De extensión de API de cliente.
FieldIndex	FieldIndex		integer	Índice de campo.
Importancia	Value			Valor de campo.
Nombre	Name		string	Nombre del cliente.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Nombre	Name		string	Nombre de ContactApiModel.
Número de teléfono	PhoneNumber		string	PhoneNumber de ContactApiModel.
Correo Electrónico	Email		string	Correo electrónico de ContactApiModel.
geocódigo	geocode		boolean	Debe estar codificada geográficamente o no.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualizar un pedido

Id. de la operación:: OrderController_Update

Actualiza un pedido existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
ExternalOrderId	ExternalOrderId		string	OrderId de uso externo para la propiedad Client - API Extension.
IsClosed	IsClosed		boolean	Estado que muestra si updateOrderApiModel está cerrado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Nombre	Name		string	Nombre de ContactApiModel.
Número de teléfono	PhoneNumber		string	PhoneNumber de ContactApiModel.
Correo Electrónico	Email		string	Correo electrónico de ContactApiModel.
Fecha de vencimiento	DueDate		date-time	A un momento dado, este BaseUpdateOrderApiModel se debe completar (obsoleto en la versión 1.3).
StartTime	StartTime		date-time	A un momento dado, este BaseUpdateOrderApiModel debe iniciarse (introducido en la versión 1.3).
EndTime	EndTime		date-time	A un momento dado, este BaseUpdateOrderApiModel debe finalizar (introducido en la versión 1.3).
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Número de Empleado	EmployeeNumber	True	string	EmployeeNumber del usuario que creó este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etiquetar el contenido de StatusLabel asociado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	A un momento dado, se inició el estado de NewOrderStatusApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
FieldIndex	FieldIndex		integer	Índice de campo.
Importancia	Value			Valor de campo.
geocódigo	geocode		boolean	Debe estar codificada geográficamente o no.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualizar un usuario

Id. de la operación:: UserController_Update

Actualiza un usuario existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
Nombre de usuario	UserName		string	UserName del usuario.
Contraseña	Password		password	Contraseña del usuario.
GroupName	GroupName		string	Nombre del grupo del usuario.
Primer Nombre	FirstName		string	Nombre del usuario.
Apellido	LastName		string	Apellidos del usuario.
Número de Empleado	EmployeeNumber		string	Número de empleado del usuario.
Correo Electrónico	Email		string	Dirección de correo electrónico del usuario.
Teléfono	Phone		string	Número de teléfono del usuario.
RoleId	RoleId		integer	RoleId del usuario : (administrador: 1, usuario: 3, usuario avanzado: 5).
IsActive	IsActive		boolean	Estado activo del usuario.
EPTTEnabled	EPTTEnabled		boolean	Estado de la característica de inserción a conversación mejorada para el usuario: booleano.
EPTTNumber	EPTTNumber		string	Número de teléfono para la característica de inserción a conversación mejorada para usuario: cadena.
EPTTWebMDN	EPTTWebMDN		string	Número de teléfono utilizado para autenticar al usuario en el sistema EPTT de Kodiak - Proporcionado por Kodiak.
EPTTToken	EPTTToken		string	Token de API usado para autenticar al usuario en el sistema EPTT de Kodiak : proporcionado por Kodiak.
GPSEnabled	GPSEnabled		boolean	Estado de la característica GPS para el usuario.
MobileOnly	MobileOnly		boolean	Estado del acceso a aplicaciones web de escritorio para CAB : (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType		integer	Tipo de licencia asignada al usuario: - 0 para Undefined, 1 para Regular, 2 para WebOnly y 3 para Employee.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Actualizar un vehículo

Id. de la operación:: VehicleController_UpdateVehicle

Actualizar un vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
Number	Number		string
Nombre	Name		string
Tipo	Type		string
Etiqueta	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
Zona horaria	TimeZone		string
Hacer	Make		string
Año	Year		integer
Modelo	Model		string
Color	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Tipo de dispositivo	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

response: integer

Cancelación de la suscripción de webhook de datos GPS

Id. de la operación:: TrackingController_RemoveGpsDataFeedSubscription

Elimina una suscripción de webook de datos GPS por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID de suscripción	subscriptionId	True	string	Identificador de suscripción que se va a eliminar.

Cancelar la suscripción de eventos webhook

Id. de la operación:: EventController_RemoveEventDataFeedSubscription

Elimina una suscripción de web hook de eventos por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID de suscripción	subscriptionId	True	string	Identificador de suscripción que se va a eliminar.

Carga de un archivo binario

Id. de la operación:: BinaryController_UploadBinary

Use esta opción para cargar imágenes de formulario y archivos de audio. El tamaño binario está limitado a 10 MB. Los tipos de archivo admitidos son: JPEG, PNG y MP4.

Devoluciones

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Cargar archivo adjunto

Id. de la operación:: BinaryController_UploadAttachment

Use esta opción para cargar datos adjuntos de archivos de formulario. El tamaño binario está limitado a 25 MB. Se esperaba una solicitud multipart/form-data con un único archivo.

Devoluciones

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Crea un pedido.

Id. de la operación:: OrderController_Create

Agrega un nuevo orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Fecha y hora de creación	CreatedDateTime		date-time	A un momento dado, se creó este createUpdateOrderApiModel.
ExternalClientId	ExternalClientId	True	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
ServiceType	ServiceType	True	string	Tipo de servicio asociado a este CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	OrderId de uso externo para la propiedad Client - API Extension.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Nombre	Name		string	Nombre de ContactApiModel.
Número de teléfono	PhoneNumber		string	PhoneNumber de ContactApiModel.
Correo Electrónico	Email		string	Correo electrónico de ContactApiModel.
Fecha de vencimiento	DueDate		date-time	A un momento dado, este BaseUpdateOrderApiModel se debe completar (obsoleto en la versión 1.3).
StartTime	StartTime		date-time	A un momento dado, este BaseUpdateOrderApiModel debe iniciarse (introducido en la versión 1.3).
EndTime	EndTime		date-time	A un momento dado, este BaseUpdateOrderApiModel debe finalizar (introducido en la versión 1.3).
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Número de Empleado	EmployeeNumber	True	string	EmployeeNumber del usuario que creó este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etiquetar el contenido de StatusLabel asociado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	A un momento dado, se inició el estado de NewOrderStatusApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
FieldIndex	FieldIndex		integer	Índice de campo.
Importancia	Value			Valor de campo.
geocódigo	geocode		boolean	Debe estar codificada geográficamente o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Creación de un usuario

Id. de la operación:: UserController_Create

Crea un nuevo usuario.

Parámetros

Nombre	Clave	Tipo	Description
Nombre de usuario	UserName	string	UserName del usuario.
Contraseña	Password	password	Contraseña del usuario.
GroupName	GroupName	string	Nombre del grupo del usuario.
Primer Nombre	FirstName	string	Nombre del usuario.
Apellido	LastName	string	Apellidos del usuario.
Número de Empleado	EmployeeNumber	string	Número de empleado del usuario.
Correo Electrónico	Email	string	Dirección de correo electrónico del usuario.
Teléfono	Phone	string	Número de teléfono del usuario.
RoleId	RoleId	integer	RoleId del usuario : (administrador: 1, usuario: 3, usuario avanzado: 5).
IsActive	IsActive	boolean	Estado activo del usuario.
EPTTEnabled	EPTTEnabled	boolean	Estado de la característica de inserción a conversación mejorada para el usuario: booleano.
EPTTNumber	EPTTNumber	string	Número de teléfono para la característica de inserción a conversación mejorada para usuario: cadena.
EPTTWebMDN	EPTTWebMDN	string	Número de teléfono utilizado para autenticar al usuario en el sistema EPTT de Kodiak - Proporcionado por Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar al usuario en el sistema EPTT de Kodiak : proporcionado por Kodiak.
GPSEnabled	GPSEnabled	boolean	Estado de la característica GPS para el usuario.
MobileOnly	MobileOnly	boolean	Estado del acceso a aplicaciones web de escritorio para CAB : (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Tipo de licencia asignada al usuario: - 0 para Undefined, 1 para Regular, 2 para WebOnly y 3 para Employee.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Creación de un vehículo

Id. de la operación:: VehicleController_CreateVehicle

Crea un vehículo.

Parámetros

Nombre	Clave	Tipo
Number	Number	string
Nombre	Name	string
Tipo	Type	string
Etiqueta	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
Zona horaria	TimeZone	string
Hacer	Make	string
Año	Year	integer
Modelo	Model	string
Color	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Tipo de dispositivo	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Creación de una geovalla

Id. de la operación:: GeofenceController_CreateGeofence

Crea una nueva geovalla.

Parámetros

Nombre	Clave	Tipo	Description
GroupNames	GroupNames	array of string	GroupPaths de GeofenceCreateApiModel.
Latitude	Latitude	double
Longitude	Longitude	double
Nombre	Name	string	Nombre de GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo y 1 para polígono.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de este locationApiModel.
City	City	string	Ciudad de LocationApiModel.
Nombre de la región	RegionName	string	Nombre de región de LocationApiModel.
Código postal	PostalCode	string	Código postal de LocationApiModel.
Código de país	CountryCode	string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName	string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregión de LocationApiModel.
RegionCode	RegionCode	string	Código de región de LocationApiModel.
Radius	Radius	double	Radio de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.
useMetric	useMetric	boolean	Use o no el sistema de métricas.
geocódigo	geocode	boolean	Debe estar codificada geográficamente o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Creación o actualización de una definición de evento personalizada

Id. de la operación:: EventController_Put

Crea o actualiza una definición de evento personalizada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. de definición de evento.
Nombre	Name		string
ReverseGeocode	ReverseGeocode		boolean
Nombre	Name		string
Tipo	Type		integer
Subtítulo	Caption		string
Obligatorio	Required		boolean

Crear o actualizar un registro de lista personalizado

Id. de la operación:: CustomListController_PutRecord

Crea o actualiza el registro de datos de lista personalizado. Se puede omitir el valor de columna única, pero si está presente, debe coincidir con el valor de Identificador único en el parámetro de consulta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
customListId	customListId	True	integer	Identificador de lista personalizado.
id	id	True	string	Valor único.
ColumnIndex	ColumnIndex		integer	Índice de columna de lista personalizado.
Subtítulo	Caption		string	Leyenda de columna de lista personalizada.
Importancia	Value			Valor de columna de lista personalizada.

Crear un cliente

Id. de la operación:: ClientController_Create

Crea un nuevo cliente.

Parámetros

Nombre	Clave	Tipo	Description
ExternalId	ExternalId	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
FieldIndex	FieldIndex	integer	Índice de campo.
Importancia	Value		Valor de campo.
Nombre	Name	string	Nombre del cliente.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de este locationApiModel.
City	City	string	Ciudad de LocationApiModel.
Nombre de la región	RegionName	string	Nombre de región de LocationApiModel.
Código postal	PostalCode	string	Código postal de LocationApiModel.
Código de país	CountryCode	string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName	string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregión de LocationApiModel.
RegionCode	RegionCode	string	Código de región de LocationApiModel.
Nombre	Name	string	Nombre de ContactApiModel.
Número de teléfono	PhoneNumber	string	PhoneNumber de ContactApiModel.
Correo Electrónico	Email	string	Correo electrónico de ContactApiModel.
geocódigo	geocode	boolean	Debe estar codificada geográficamente o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Crear un formulario

Id. de la operación:: FormController_PostFormAsync

Agrega un nuevo formulario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ApiModuleId	ApiModuleId		string	Id. de la ApiModule asociada a este CreateStandaloneFormApiModel.
Revisado	Reviewed		boolean	Estado de la revisión de este CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId del usuario.
Número de Empleado	EmployeeNumber		string	Número de empleado del usuario.
SubmittedTime	SubmittedTime	True	date-time	Momento en que se envió CreateStandaloneFormApiModel.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
ApiFieldId	ApiFieldId	True	string	Id. de campo de API.
Importancia	Value	True		Valor de FormFieldDataApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Sign" (referencia binaria): { "BinaryId": string // Binary ID de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Hora en que se capturaron los datos binarios. Formato: fecha y hora (como fecha y hora en RFC3339) incluido el desplazamiento.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
ApiFieldId	ApiFieldId	True	string	Id. de campo de API.
Importancia	Value	True		Valor de FormFieldDataApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Sign" (referencia binaria): { "BinaryId": string // Binary ID de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Hora en que se capturaron los datos binarios. Formato: fecha y hora (como fecha y hora en RFC3339) incluido el desplazamiento.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Desactivar un usuario

Id. de la operación:: UserController_Deactivate

Desactiva un usuario existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Desactivar un vehículo

Id. de la operación:: VehicleController_Deactivate

Desactive un vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

response: integer

Devolución de llamada de webhook con fuente de distribución de datos GPS

Id. de la operación:: TrackingController_subscribe_callback

Gpsdata/subscribe usa este método de ejemplo para publicar la fuente de distribución de datos mediante la dirección URL proporcionada por el cliente.

Parámetros

Nombre	Clave	Tipo	Description
Id	Id	string	Dirección URL que contiene la dirección de WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto Id asociado a la suscripción.
Tipo de dispositivo	DeviceType	integer	GpsDeviceDto tipo: Auricular(0), CalAmp(1), Geotab (2), Xirgo (3).
Marca de tiempo	Timestamp	date-time	Formato ISO con Local y Offset.
CompanyId	CompanyId	integer	Id. de empresa.
UserId	UserId	integer	ID de usuario.
VehicleId	VehicleId	integer	Id. del vehículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Si un usuario está vinculado al vehículo.
LocationProvider	LocationProvider	string	Nombre del proveedor de ubicación.
Lat	Lat	double	Latitud.
Lon	Lon	double	Longitud.
PrecisionFt	AccuracyFt	double	Precisión de posición (pies).
AltitudFt	AltitudeFt	double	Altitud (pies).
Heading	Heading	integer	Dirección de brújula en grados.
SpeedMph	SpeedMph	double	Velocidad de movimiento (Mph).
BatteryStatus	BatteryStatus	integer	Estado de la batería: No carga (0), Carga(1).
BatteryLevel	BatteryLevel	integer	Nivel de batería en porcentaje.
ActivityState	ActivityState	integer	Estado de la actividad: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Es el dispositivo conectado a la red en este momento.
Rssi	Rssi	integer	Indicador de intensidad de señal recibido.
DOdoMl	DOdoMl	double	GpsDeviceDto Odómetro (Millas).
VOdoMl	VOdoMl	double	Odómetro de vehículo (Millas).

Devoluciones

response: object

Devolución de llamada de webhook con fuente de eventos

Id. de la operación:: EventController_subscribe_callback

Los eventos o la suscripción usan este método de ejemplo para publicar la fuente de distribución de datos de eventos mediante la dirección URL proporcionada por el cliente.

Parámetros

Nombre	Clave	Tipo	Description
Id	Id	string	Dirección URL que contiene la dirección de WebHookSubscriptionParamsApiModel.
Tipo de evento	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	Formato ISO con Local y Offset.
DeviceId	DeviceId	string	GpsDeviceDto Id asociado a la suscripción.
Tipo de dispositivo	DeviceType	integer	GpsDeviceDto tipo: Terminal (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	ID de usuario.
VehicleId	VehicleId	integer	Id. del vehículo.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Si un usuario está vinculado al vehículo.
Lat	Lat	double	Latitud.
Lon	Lon	double	Longitud.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Parámetros de evento.

Devoluciones

response: object

Eliminación de un cliente

Id. de la operación:: ClientController_Delete

Elimina un cliente existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. de cliente.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Eliminación de una definición de evento personalizada

Id. de la operación:: EventController_Delete

Elimina una definición de evento personalizada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. de definición de evento.

Eliminar registro de lista personalizado

Id. de la operación:: CustomListController_DeleteRecord

Elimina el registro existente en la lista personalizada por su customListId e id.

id: es un valor único del registro de lista personalizado.

Errores:

404: customListId o identificador no encontrado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
customListId	customListId	True	integer	Identificador de lista personalizado.
id	id	True	string	Valor único.

Eliminar un vehículo

Id. de la operación:: VehicleController_Delete

Elimina un vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Eliminar una geovalla

Id. de la operación:: GeofenceController_DeleteGeofence

Elimina una geovalla existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Identificador de geovalla.

Enviar evento

Id. de la operación:: EventController_Post

Envía el evento.

Parámetros

Nombre	Clave	Tipo	Description
EventDefinitionId	EventDefinitionId	string	Identificador de definición de evento.
Número de Empleado	EmployeeNumber	string	Número de empleado.
VehicleNumber	VehicleNumber	string	Número de vehículo.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto número de serie.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de este locationApiModel.
City	City	string	Ciudad de LocationApiModel.
Nombre de la región	RegionName	string	Nombre de región de LocationApiModel.
Código postal	PostalCode	string	Código postal de LocationApiModel.
Código de país	CountryCode	string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName	string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregión de LocationApiModel.
RegionCode	RegionCode	string	Código de región de LocationApiModel.
Time	Time	date-time
Parámetros	Parameters	object	Parámetros de evento.

Estado del pedido de actualización

Id. de la operación:: OrderController_ChangeStatus

Cambia el estado de un pedido existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
Número de Empleado	EmployeeNumber	True	string	EmployeeNumber del usuario que creó este NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etiquetar el contenido de StatusLabel asociado a este NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	A un momento dado, se inició el estado de NewOrderStatusApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de este locationApiModel.
City	City		string	Ciudad de LocationApiModel.
Nombre de la región	RegionName		string	Nombre de región de LocationApiModel.
Código postal	PostalCode		string	Código postal de LocationApiModel.
Código de país	CountryCode		string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName		string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode		string	Código de subregión de LocationApiModel.
RegionCode	RegionCode		string	Código de región de LocationApiModel.
Subtítulo	Caption	True	string
Importancia	Value			Valor de UpdateFormFieldApiModel. Formato de valor de campo "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Formato de valor de campo "Camera" (referencia binaria): { "BinaryId": string, // Binary ID de una imagen cargada (vea upload binary API) "Note": string // Note for the referenced image } Formato de valor de campo "Firma" (referencia binaria): { "BinaryId": cadena // Id. binario de una imagen cargada (consulte upload binary API) } Formato de valor de campo "Audio" (referencia binaria): { "BinaryId": string, // Binary ID de un audio cargado (vea upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Se capturó el valor de un momento dado.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.ReturnIdApiModel

Obtención de datos de lista personalizados por CustomListID

Id. de la operación:: CustomListController_GetCustomList

Recupera todos los registros de datos de una sola lista personalizada mediante CustomListID.

Los resultados se ordenan por columna y se admite la paginación.

Errores:

404: no hay ninguna lista personalizada para customListId proporcionada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
customListId	customListId	True	integer	Identificador de lista personalizado.
pageNumber	pageNumber		integer	Número de página de inicio.
pageSize	pageSize		integer	Tamaño de página.

Devoluciones

Contenedor para la matriz de datos de columna de lista personalizada.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obtención de definiciones de lista personalizadas

Id. de la operación:: CustomListController_Get

Recupera una lista de definiciones de lista personalizada. La lista de definiciones contiene CustomListID, Name y Version para todas las listas personalizadas existentes.

Devoluciones

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Obtención de entradas de datos GPS

Id. de la operación:: TrackingController_GetGpsData

Recupera entradas de datos GPS para un intervalo de fechas especificado. También devuelve un token de continuación y un vínculo para obtener la siguiente parte de datos. Puede especificar el número de páginas devueltas y el número de elementos por página.

No se devuelven posiciones para usuarios o vehículos eliminados. Sin embargo, si el usuario o vehículo existía cuando se solicitaron datos y se quitaron posteriormente, se devolverán los datos del usuario o vehículo solicitados por un token de continuación.

Los resultados se ordenan automáticamente por UtcTime y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Tipo	Description
fromDate	fromDate	date-time	Inicio del intervalo de fechas. Recomendación: Use intervalos de fechas grandes (>=4 horas) en lugar de intervalos de fechas pequeños.
toDate	toDate	date-time	Fin del intervalo de fechas. Recomendación: Use intervalos de fechas grandes (>=4 horas) en lugar de intervalos de fechas pequeños.
número de empleado	employeeNumber	string	Número de empleado.
Vin	vin	string	Número vin del vehículo.
useMetric	useMetric	boolean	Use o no el sistema de métricas.
token	token	string	Token de continuación devuelto por la llamada inicial y se usará en la llamada sucesiva.

Devoluciones

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Obtención de la versión secundaria

Id. de la operación:: VersionController_Get

Devuelve la versión secundaria actual de la API.

Obtención de una definición de evento personalizada por identificador

Id. de la operación:: EventController_Get

Recupera una única definición de evento personalizada por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. de definición de evento.

Devoluciones

Modelo de definición de eventos personalizado.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obtener la lista de campos de lista personalizados por CustomListID

Id. de la operación:: CustomListController_GetById

Recupera una lista de campos de una sola lista personalizada mediante CustomListID.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
customListId	customListId	True	integer	Identificador de lista personalizado.

Devoluciones

Modelo de lista personalizada.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Obtener un cliente

Id. de la operación:: ClientController_Get

Recupera un objeto de cliente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. de cliente.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.Client.ReadClientApiModel

Obtener un formulario

Id. de la operación:: FormController_GetFormAsync

Recupera un formulario por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Id. de formulario.

Devoluciones

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Obtener un pedido

Id. de la operación:: OrderController_GetOrder

Obtiene un orden existente por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
include-status-history	include-status-history		string	Si es true, la respuesta contendrá todos los datos de formulario y historial de estado para este pedido.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.Order.OrderApiModel

Obtener un registro único de la lista personalizada

Id. de la operación:: CustomListController_GetSingleRecord

Recupera el registro de datos de lista personalizado único encontrado por CustomListId y el valor de columna único.

Errores:

404: no hay ningún registro de lista personalizado para customListId proporcionado y un valor de columna único

Parámetros

Nombre	Clave	Requerido	Tipo	Description
customListId	customListId	True	integer	Identificador de lista personalizado.
id	id	True	string	Valor único.

Devoluciones

Contenedor para la matriz de datos de columna de lista personalizada.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obtener un usuario

Id. de la operación:: UserController_Get

Obtiene un usuario por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Body: CustomerAPI.Models.User.ReadUserApiModel

Obtener un vehículo por identificador

Id. de la operación:: VehicleController_GetVehicle

Recupera un solo vehículo por identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Id. externo o interno depende del valor del parámetro use-external-id.
use-external-id	use-external-id		boolean	Use el identificador externo o no.

Devoluciones

Modelo de datos del vehículo.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Obtener una entrada de mantenimiento de tiempo

Id. de la operación:: TimekeepingController_GetTimekeepingEntryAsync

Recupera una entrada por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	string	Identificador del registro.

Devoluciones

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obtener una geovalla

Id. de la operación:: GeofenceController_GetGeofence

Recupera una geovalla por su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
id	id	True	integer	Identificador de geovalla.
useMetric	useMetric		boolean	Use o no el sistema de métricas.

Devoluciones

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Obtener una lista de clientes

Id. de la operación:: ClientController_GetClients

Recupera una lista de clientes. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por Nombre y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
pageNumber	pageNumber		integer	Número de página de inicio.
pageSize	pageSize		integer	Tamaño de página.

Devoluciones

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Obtener una lista de definiciones de eventos personalizados

Id. de la operación:: EventController_GetList

Recupera una lista de definiciones de eventos personalizadas.

Devoluciones

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obtener una lista de entradas de mantenimiento de tiempo

Id. de la operación:: TimekeepingController_GetTimekeepingDataList

Recupera una lista de entradas de mantenimiento de tiempo en función del intervalo de fechas. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por ClockInTime y, a continuación, por TimekeepingStatusId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
fromDate	fromDate	True	date-time	Fecha de inicio.
toDate	toDate	True	date-time	Fecha final.
número de empleado	employeeNumber		string	Número de empleado.
aprobado	approved		boolean	Filtre solo para la entrada aprobada.
closedOnly	closedOnly		boolean	Filtre solo para la entrada cerrada.
excludeFormData	excludeFormData		boolean	Filtre por excluir los datos del formulario.
pageNumber	pageNumber		integer	Número de página de inicio (valor predeterminado 1).
pageSize	pageSize		integer	Tamaño de página (valor predeterminado 1000).

Devoluciones

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obtener una lista de eventos

Id. de la operación:: EventController_GetEvents

Recupera una lista de eventos durante un período de tiempo específico. Puede especificar el número de páginas devueltas y el número de elementos por página.

Filtre por tipo de evento para obtener eventos específicos. Los eventos de vehículo se pueden devolver para un empleado si el empleado está asociado al vehículo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
fromDate	fromDate	True	date-time	Inicio del intervalo de fechas.
toDate	toDate	True	date-time	Fin del intervalo de fechas.
número de empleado	employeeNumber		string	Número de empleado.
vehicleNumber	vehicleNumber		string	Número de vehículo.
pageNumber	pageNumber		integer	Número de página de inicio.
pageSize	pageSize		integer	Tamaño de página.
eventType	eventType		integer	Filtre por tipo de evento. se especifica el número de empleado: UserEvents(0): solo eventos de usuario. VehicleEvents(1): solo eventos de vehículo, incluidos los eventos del sensor. ExternalEvents(2): solo eventos externos. se especifica el número de vehículo: UserEvents(0): N/A. VehicleEvents(1): solo eventos de vehículo, incluidos los eventos del sensor. ExternalEvents(2): solo eventos externos. No se especifica ni el número de empleado ni el número de vehículo: UserEvents(0): solo eventos de usuario. VehicleEvents(1): solo eventos de vehículo, incluidos los eventos del sensor. ExternalEvents(2): solo eventos externos.

Devoluciones

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Obtener una lista de formularios

Id. de la operación:: FormController_GetFormsAsync

Recupera una lista de formularios mediante cualquiera de los filtros de los parámetros de solicitud que se muestran a continuación. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubmittedTime y en orden descendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
submittedStartDate	submittedStartDate	True	date-time	Fecha de inicio del formulario enviado.
submittedEndDate	submittedEndDate	True	date-time	Fecha de finalización del formulario enviado.
apiModuleId	apiModuleId		string	Id. del módulo de formulario.
número de empleado	employeeNumber		string	Número de empleado.
reviewed	reviewed		boolean	Solo recupera formularios revisados o no. El valor predeterminado es NULL para todos.
pageNumber	pageNumber		integer	Número de página inicial. El valor predeterminado es 1.
pageSize	pageSize		integer	Tamaño de página. El valor predeterminado es 1000.

Devoluciones

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Obtener una lista de geovallas

Id. de la operación:: GeofenceController_GetGeofences

Recupera una lista de geovallas. Puede especificar el número de páginas devueltas y el número de elementos por página, así como si las coordenadas de geovalla son métricas. Los resultados se ordenan automáticamente por Nombre y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Tipo	Description
pageNumber	pageNumber	integer	Número de página de inicio. El valor predeterminado es 1.
pageSize	pageSize	integer	Tamaño de página. El valor predeterminado es 500.
useMetric	useMetric	boolean	Use o no el sistema de métricas.

Devoluciones

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Obtener una lista de pedidos

Id. de la operación:: OrderController_GetOrders

Recupera una lista de pedidos mediante los filtros de los parámetros de solicitud que se muestran a continuación. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por Client.Name y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
dueDateFrom	dueDateFrom	True	date-time	Filtre por fecha de inicio de fecha de vencimiento.
dueDateTo	dueDateTo	True	date-time	Filtre por fecha de finalización de fecha de vencimiento.
número de empleado	employeeNumber		string	Filtre por número de empleado.
pageNumber	pageNumber		integer	Número de página de inicio (valor predeterminado 1).
pageSize	pageSize		integer	Tamaño de página (valor predeterminado 500).

Devoluciones

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Obtener una lista de suscripciones

Id. de la operación:: TrackingController_GetSubscriptions

Recupera una lista de suscripciones de web hook. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubscriptionId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Devoluciones

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obtener una lista de suscripciones de webook de eventos

Id. de la operación:: EventController_GetSubscriptions

Recupera una lista de suscripciones de webhook de eventos. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por SubscriptionId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Devoluciones

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obtener una lista de usuarios

Id. de la operación:: UserController_GetUsers

Recupera una lista de usuarios. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por UserId y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
pageNumber	pageNumber		integer	Número de página de inicio. El valor predeterminado es 1.
pageSize	pageSize		integer	Tamaño de página. El valor predeterminado es 500.

Devoluciones

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Obtener una lista de vehículos

Id. de la operación:: VehicleController_GetVehicles

Recupera una lista de vehículos.

Parámetros

Nombre	Clave	Tipo	Description
pageNumber	pageNumber	integer	Número de página.
pageSize	pageSize	integer	Número máximo de elementos de una página. Valor predeterminado = 1000. Valor máximo = 2000.
activeOnly	activeOnly	boolean	si es true: devuelve solo vehículos activos. Valor predeterminado = false.

Devoluciones

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Obtener una lista de viajes

Id. de la operación:: TrackingController_GetTrips

Recupera una lista de viajes durante un período de tiempo específico. Puede especificar el número de páginas devueltas y el número de elementos por página. Los resultados se ordenan automáticamente por StartUtcTIme y en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
fromDate	fromDate	True	date-time	Inicio del intervalo de fechas. Recomendación: Use intervalos de fechas grandes (>=4 horas) en lugar de intervalos de fechas pequeños.
toDate	toDate	True	date-time	Fin del intervalo de fechas. Recomendación: Use intervalos de fechas grandes (>=4 horas) en lugar de intervalos de fechas pequeños.
número de empleado	employeeNumber		string	Número de empleado.
Vin	vin		string	Número vin del vehículo.
pageNumber	pageNumber		integer	Número de página de inicio. El valor predeterminado es 1.
pageSize	pageSize		integer	Tamaño de página. El valor predeterminado es 1000.
useMetric	useMetric		boolean	Use o no el sistema de métricas.

Devoluciones

response: array of CustomerAPI.Models.Tracking.TripApiModel

Restablece el estado de la suscripción

Id. de la operación:: TrackingController_ResetSubscriptionHealthStatus

Cambia el estado de la suscripción al estado = 1 ("En ejecución").

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID de suscripción	subscriptionId	True	integer	Identificador de suscripción.

Restablece el estado de la suscripción de webook de eventos

Id. de la operación:: EventController_ResetSubscriptionHealthStatus

Cambia el estado de la suscripción al estado = 1 ("En ejecución").

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID de suscripción	subscriptionId	True	integer	Identificador de suscripción.

Suscribirse a eventos webhook

Id. de la operación:: EventController_SubscribeToEventDataFeed

Agrega una nueva suscripción de web hook de eventos. Los enlaces web permiten recibir notificaciones automáticas sobre eventos de la empresa que se producen en una dirección URL especificada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
URL	Url		string	Dirección URL que contiene la dirección de WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de seguridad asociado a este WebHookSubscriptionParamsApiModel.

Devoluciones

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Suscripción de webhook de datos GPS

Id. de la operación:: TrackingController_SubscribeToGpsDataFeed

Agrega un nuevo webhook de datos de seguimiento GPS (posiciones GPS). Los enlaces web permiten recibir posiciones GPS que se producen en una dirección URL especificada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
URL	Url		string	Dirección URL que contiene la dirección de WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token de seguridad asociado a este WebHookSubscriptionParamsApiModel.

Devoluciones

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Desencadenadores

Sondeo de datos de formulario	El punto de conexión de sondeo de la API de Forms permite a la aplicación sondear y procesar continuamente formularios independientes enviados recientemente. Integración: Este punto de conexión está diseñado para funcionar de forma predeterminada con Microsoft Flow como una integración de desencadenador de sondeo. Como alternativa, puede desarrollar su propia integración personalizada mediante cualquier lenguaje. Uso: En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas: Código de respuesta HTTP 200: existen registros de formulario enviados recientemente; el cuerpo de la respuesta mostrará los datos del formulario. Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío. En ambos casos, hay dos (2) encabezados importantes en la respuesta: Ubicación: la dirección URL de la siguiente solicitud. Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300. Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los parámetros necesarios para asegurarse de que no faltan formularios de la solicitud. Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por FormHeaderId, en orden ascendente. Los parámetros de ordenación no se pueden configurar. Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de formulario más reciente.
Sondeo de estados de pedido	El punto de conexión de sondeo de la API Order Statuses permite a la aplicación sondear y procesar continuamente los cambios recientes en los pedidos. Integración: Este punto de conexión está diseñado para funcionar de forma predeterminada con Microsoft Flow como una integración de desencadenador de sondeo. Como alternativa, puede desarrollar su propia integración personalizada mediante cualquier lenguaje. Uso: En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas: Código de respuesta HTTP 200: existen registros de estado de pedido modificados recientemente; el cuerpo de la respuesta mostrará los datos de estado del pedido. Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío. En ambos casos, hay dos (2) encabezados importantes en la respuesta: Ubicación: la dirección URL de la siguiente solicitud. Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300. Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los necesarios para asegurarse de que no faltan los estados de orden de la solicitud. Los resultados se ordenan por ModifiedUtc y, a continuación, por StatusId, en orden ascendente. Los parámetros de ordenación no se pueden configurar. Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de estado de pedido más reciente.
Sondeo de mantenimiento de tiempo	El punto de conexión de sondeo de timekeeping API permite a la aplicación sondear y procesar continuamente entradas de mantenimiento de tiempo enviadas recientemente. Integración: Este punto de conexión está diseñado para funcionar de forma predeterminada con Microsoft Flow como una integración de desencadenador de sondeo. Como alternativa, puede desarrollar su propia integración personalizada mediante cualquier lenguaje. Uso: En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas: Código de respuesta HTTP 200: existen registros de mantenimiento de tiempo enviados recientemente; el cuerpo de la respuesta mostrará los datos de entrada de mantenimiento de tiempo. Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío. En ambos casos, hay dos (2) encabezados importantes en la respuesta: Ubicación: la dirección URL de la siguiente solicitud. Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300. Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los necesarios para asegurarse de que no faltan las entradas de mantenimiento de tiempo de la solicitud. Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por TimekeepingStatusId y, a continuación, en orden ascendente. Los parámetros de ordenación no se pueden configurar. Definición modifiedUtc: etiqueta de hora interna = hora del cambio de estado de mantenimiento más reciente.
Sondeo de pedidos	El punto de conexión de sondeo de orders API permite a la aplicación sondear y procesar continuamente los cambios recientes en los pedidos. Integración: Este punto de conexión está diseñado para funcionar de forma predeterminada con Microsoft Flow como una integración de desencadenador de sondeo. Como alternativa, puede desarrollar su propia integración personalizada mediante cualquier lenguaje. Uso: En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas: Código de respuesta HTTP 200: existen pedidos modificados recientemente; el cuerpo de la respuesta mostrará los datos de pedido. Código de respuesta HTTP 202: no existen pedidos modificados recientemente; el cuerpo de la respuesta estará vacío. En ambos casos, hay dos (2) encabezados importantes en la respuesta: Ubicación: la dirección URL de la siguiente solicitud. Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300. Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los parámetros necesarios para asegurarse de que no faltan los cambios de orden de la solicitud. Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por OrderId, en orden ascendente. Los parámetros de ordenación no se pueden configurar. Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de pedido más reciente.

Sondeo de datos de formulario

Id. de la operación:: FormController_Poll

El punto de conexión de sondeo de la API de Forms permite a la aplicación sondear y procesar continuamente formularios independientes enviados recientemente.

Integración:

Este punto de conexión está diseñado para funcionar de forma predeterminada con Microsoft Flow como una integración de desencadenador de sondeo. Como alternativa, puede desarrollar su propia integración personalizada mediante cualquier lenguaje.

Uso:

En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas:

Código de respuesta HTTP 200: existen registros de formulario enviados recientemente; el cuerpo de la respuesta mostrará los datos del formulario.
Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío.

En ambos casos, hay dos (2) encabezados importantes en la respuesta:

Ubicación: la dirección URL de la siguiente solicitud.
Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300.

Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los parámetros necesarios para asegurarse de que no faltan formularios de la solicitud.

Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por FormHeaderId, en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de formulario más reciente.

Devoluciones

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Sondeo de estados de pedido

Id. de la operación:: OrderController_StatusPoll

El punto de conexión de sondeo de la API Order Statuses permite a la aplicación sondear y procesar continuamente los cambios recientes en los pedidos.

Integración:

Uso:

En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas:

Código de respuesta HTTP 200: existen registros de estado de pedido modificados recientemente; el cuerpo de la respuesta mostrará los datos de estado del pedido.
Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío.

En ambos casos, hay dos (2) encabezados importantes en la respuesta:

Ubicación: la dirección URL de la siguiente solicitud.
Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300.

Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los necesarios para asegurarse de que no faltan los estados de orden de la solicitud.

Los resultados se ordenan por ModifiedUtc y, a continuación, por StatusId, en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de estado de pedido más reciente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
excludeFormData	excludeFormData		boolean	Si es true, FieldValues siempre será una matriz vacía.

Devoluciones

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Sondeo de mantenimiento de tiempo

Id. de la operación:: TimekeepingController_Poll

El punto de conexión de sondeo de timekeeping API permite a la aplicación sondear y procesar continuamente entradas de mantenimiento de tiempo enviadas recientemente.

Integración:

Uso:

En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas:

Código de respuesta HTTP 200: existen registros de mantenimiento de tiempo enviados recientemente; el cuerpo de la respuesta mostrará los datos de entrada de mantenimiento de tiempo.
Código de respuesta HTTP 202: no existen registros enviados recientemente; el cuerpo de la respuesta estará vacío.

En ambos casos, hay dos (2) encabezados importantes en la respuesta:

Ubicación: la dirección URL de la siguiente solicitud.
Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300.

Nota: Estos son solo valores recomendados: la aplicación puede elegir sondear con una frecuencia diferente en función de sus requisitos. Después de la primera solicitud, todas las solicitudes posteriores deben usar la dirección URL proporcionada en el encabezado Location de la respuesta más reciente. No agregue más parámetros a la dirección URL, ya que ya contiene los necesarios para asegurarse de que no faltan las entradas de mantenimiento de tiempo de la solicitud.

Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por TimekeepingStatusId y, a continuación, en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Definición modifiedUtc: etiqueta de hora interna = hora del cambio de estado de mantenimiento más reciente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
excludeFormData	excludeFormData		boolean	Si es true, ClockInFormData y ClockOutFormData siempre serán NULL.

Devoluciones

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Sondeo de pedidos

Id. de la operación:: OrderController_Poll

El punto de conexión de sondeo de orders API permite a la aplicación sondear y procesar continuamente los cambios recientes en los pedidos.

Integración:

Uso:

En un escenario típico, la primera solicitud a este punto de conexión no debe proporcionar ningún parámetro. Hay dos (2) posibles respuestas correctas:

Código de respuesta HTTP 200: existen pedidos modificados recientemente; el cuerpo de la respuesta mostrará los datos de pedido.
Código de respuesta HTTP 202: no existen pedidos modificados recientemente; el cuerpo de la respuesta estará vacío.

En ambos casos, hay dos (2) encabezados importantes en la respuesta:

Ubicación: la dirección URL de la siguiente solicitud.
Retry-After: intervalo de tiempo recomendado en segundos para la siguiente solicitud. Por ejemplo, si hay datos que recuperar, el encabezado Retry-After tendrá un valor de 1 o 60. Si no hay datos que recuperar, el valor del encabezado Retry-After será 300.

Los resultados se ordenan automáticamente por ModifiedUtc y, a continuación, por OrderId, en orden ascendente. Los parámetros de ordenación no se pueden configurar.

Definición modifiedUtc: etiqueta de hora interna = hora del cambio de datos de pedido más reciente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
excludeFormData	excludeFormData		boolean	Si es true, OrderFormFields siempre será una matriz vacía.
excludeCustomFieldData	excludeCustomFieldData		boolean	Si es true, no se devolverá CustomFields.

Devoluciones

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Definiciones

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	integer	Id. del cliente.
ExternalId	ExternalId	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
CreatedUtc	CreatedUtc	date-time	El momento original en el que se creó el cliente.
ModifiedUtc	ModifiedUtc	date-time	Último momento en que se actualizó el cliente.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Nombre	Name	string	Nombre del cliente.
Dirección	Address	CustomerAPI.Models.LocationApiModel
Contacto	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Nombre	Ruta de acceso	Tipo	Description
FieldIndex	FieldIndex	integer	Índice de campo.
Subtítulo	Caption	string	Título del campo.
tipo de dato	DataType	integer	Tipo de datos de campo.
DateTimeFormat	DateTimeFormat	integer	Formato DateTime.
Importancia	Value		Valor de campo.

CustomerAPI.Models.LocationApiModel

Nombre	Ruta de acceso	Tipo	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 de este locationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de este locationApiModel.
City	City	string	Ciudad de LocationApiModel.
Nombre de la región	RegionName	string	Nombre de región de LocationApiModel.
Código postal	PostalCode	string	Código postal de LocationApiModel.
Código de país	CountryCode	string	Código alfa-2 ISO 3166-1.
SubRegionName	SubRegionName	string	SubRegión de LocationApiModel.
SubRegionCode	SubRegionCode	string	Código de subregión de LocationApiModel.
RegionCode	RegionCode	string	Código de región de LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Nombre	Ruta de acceso	Tipo	Description
Nombre	Name	string	Nombre de ContactApiModel.
Número de teléfono	PhoneNumber	string	PhoneNumber de ContactApiModel.
Correo Electrónico	Email	string	Correo electrónico de ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Nombre	Ruta de acceso	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	integer	Id. de objeto.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Define el modelo de API de elemento de lista de definición de lista personalizada.

Nombre	Ruta de acceso	Tipo	Description
CustomListId	CustomListId	integer	Id. de lista personalizada.
Nombre	Name	string	Nombre de lista personalizado.
Versión	Version	string	Versión de lista personalizada.

CustomerAPI.Models.CustomLists.CustomListApiModel

Modelo de lista personalizada.

Nombre	Ruta de acceso	Tipo	Description
CustomListId	CustomListId	integer	Id. de lista personalizada.
Nombre	Name	string	Nombre de lista personalizado.
Versión	Version	string	Versión de lista personalizada.
Definición	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Define el modelo de API de definición de lista personalizada.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Define el modelo de API de definición de lista personalizada.

Nombre	Ruta de acceso	Tipo	Description
Columnas	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Columnas de lista personalizadas.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Índice de columna único.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Define el modelo de API de columna de definición de lista personalizada.

Nombre	Ruta de acceso	Tipo	Description
Index	Index	integer	Índice de columna.
tipo de dato	DataType	integer	Column DataType (Text: 0, Numeric: 1, Date: 2, Time: 3, DateTime: 4, Email: 5).
Nombre	Name	string	Nombre de columna.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Contenedor para la matriz de datos de columna de lista personalizada.

Nombre	Ruta de acceso	Tipo	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Matriz de columnas con datos.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Este modelo define el valor de columna de lista personalizado.

Nombre	Ruta de acceso	Tipo	Description
ColumnIndex	ColumnIndex	integer	Índice de columna de lista personalizado.
Subtítulo	Caption	string	Leyenda de columna de lista personalizada.
Importancia	Value		Valor de columna de lista personalizada.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Modelo de definición de eventos personalizado.

Nombre	Ruta de acceso	Tipo
Id	Id	string
Nombre	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parámetros	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Nombre	Ruta de acceso	Tipo
Nombre	Name	string
Tipo	Type	integer
Subtítulo	Caption	string
Obligatorio	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Nombre	Ruta de acceso	Tipo	Description
EventId	EventId	integer	Id. de evento.
Tipo de evento	EventType	integer
EventCode	EventCode	string	Código de evento.
EventTime	EventTime	date-time	Formato ISO con Local y Offset.
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
Vehículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Si está habilitado, el vehículo del evento ha asignado al usuario.
Ubicación	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Id. de definición de evento externo.
EventParams	EventParams	object	Parámetros de evento.

CustomerAPI.Models.UserReferenceApiModel

Nombre	Ruta de acceso	Tipo	Description
UserId	UserId	integer	UserId del usuario.
Primer Nombre	FirstName	string	Nombre del usuario.
Apellido	LastName	string	Apellidos del usuario.
Número de Empleado	EmployeeNumber	string	Número de empleado del usuario.
GroupName	GroupName	string	Nombre del grupo asignado al usuario.

CustomerAPI.Models.ReadVehicleApiModel

Nombre	Ruta de acceso	Tipo	Description
VehicleId	VehicleId	integer	Identificador de BaseVehicleApiModel.
Nombre	Name	string	Nombre de BaseVehicleApiModel.
VIN	VIN	string	Número de identificación del vehículo de BaseVehicleApiModel.
Nombre del dispositivo	DeviceName	string	Nombre de GpsDeviceDto asociado a BaseVehicleApiModel.
Número de serie	SerialNumber	string	SerialNumber de BaseVehicleApiModel.
GroupName	GroupName	string	GroupName de BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Nombre	Ruta de acceso	Tipo	Description
GeofenceId	GeofenceId	integer	Identificador de la geovalla.
Nombre	Name	string	Nombre de la geovalla.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Nombre	Ruta de acceso	Tipo	Description
Id de suscripción	SubscriptionId	string	Identificador de WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Nombre	Ruta de acceso	Tipo	Description
Id de suscripción	SubscriptionId	string
URL	Url	string
Estado	Status	integer	Estado de la suscripción: (En ejecución: 1, Detenido: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	integer	Identificador asociado a este StandaloneFormApiModel : (comentario heredado: FormHeaderId).
FormId	FormId	integer	Id. del formulario al que hace referencia este StandaloneFormApiModel.
FormName	FormName	string	Nombre del formulario al que hace referencia este StandaloneFormApiModel.
EntryNumber	EntryNumber	string	Número de entrada de datos del formulario.
Revisado	Reviewed	boolean	Estado de la revisión de este standaloneFormApiModel.
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	Momento en que se envió standaloneFormApiModel.
StartTime	StartTime	date-time	Momento en que se inició standaloneFormApiModel.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Lista de los campos asociados a este StandaloneFormApiModel.
ApiModuleId	ApiModuleId	string	Id. de apiModule asociado a este StandaloneFormApiModel.
SharedUrl	SharedUrl	string	Dirección URL compartida de este StandaloneFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Hora de la revisión del formulario

CustomerAPI.Models.Forms.FormFieldDataApiModel

Nombre	Ruta de acceso	Tipo	Description
Repetibles	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	Identificador de FormFieldDataApiModel.
Importancia	Value		Valor de FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue de FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	El valor de un momento dado se capturó de FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Subtítulo	Caption	string	Contenido del título de FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id. de ApiField de FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	string	Identificador de FormFieldDataApiModel.
Importancia	Value		Valor de FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue de FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	El valor de un momento dado se capturó de FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Subtítulo	Caption	string	Contenido del título de FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id. de ApiField de FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Nombre	Ruta de acceso	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId de GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc de GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc de GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths de GeofenceApiModel.
Nombre	Name	string	Nombre de GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo y 1 para polígono.
Dirección	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Radio de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Nombre	Ruta de acceso	Tipo	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Nombre	Ruta de acceso	Tipo	Description
GeofenceId	GeofenceId	integer	GeofenceId de GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc de GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc de GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths de GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Puntos de polígono. Debe rellenarse cuando Shape es igual a 1.
Nombre	Name	string	Nombre de GeofenceApiModelBase.
Tipo	Type	string	Tipo de GeofenceApiModel.
Shape	Shape	integer	Forma: 0 para círculo y 1 para polígono.
Dirección	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Radio de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Nombre	Ruta de acceso	Tipo	Description
Id de pedido	OrderId	integer	Identificador de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de uso externo para la propiedad Client - API Extension.
Fecha de vencimiento	DueDate	date-time	A un momento dado, orderBaseApiModel se debe completar (obsoleto en la versión 1.3).
StartTime	StartTime	date-time	A un momento dado, este OrderBaseApiModel debe iniciarse (introducido en la versión 1.3).
EndTime	EndTime	date-time	A un momento dado, orderBaseApiModel se debe completar (introducido en la versión 1.3).
ServiceType	ServiceType	string	ServiceType asociado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	A un momento dado, se creó este OrderBaseApiModel.
Número de pedido	OrderNumber	string	Número de pedido asociado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Estado que muestra si OrderBaseApiModel está cerrado.
Estado	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
ClientId	ClientId	integer	internal Use Id para el cliente: propiedad de extensión de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Identificador de ApiService asociado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versión del módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Nombre	Ruta de acceso	Tipo	Description
StatusIndex	StatusIndex	integer	Índice de OrderStatusApiModel.
TipoDeEstado	StatusType	integer	Estado del pedido: 0 para nuevo pedido, 1 para envío, 2 para en curso, 3 para completado y 4 para cancelado.
StatusLabel	StatusLabel	string	Etiquetado del contenido de OrderStatusApiModel.
StatusId	StatusId	integer	Identificador de OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Momento dado del inicio de OrderStatusApiModel.
Usuario	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Nombre	Ruta de acceso	Tipo	Description
GroupNames	GroupNames	array of string	Nombres jerárquicos de grupo de clientes.
Nombre	Name	string	Nombre del cliente.
Dirección	Address	CustomerAPI.Models.LocationApiModel
Contacto	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Nombre	Ruta de acceso	Tipo	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Lista de orderStatusListItems asociados a este OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Id de pedido	OrderId	integer	Identificador de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de uso externo para la propiedad Client - API Extension.
Fecha de vencimiento	DueDate	date-time	A un momento dado, orderBaseApiModel se debe completar (obsoleto en la versión 1.3).
StartTime	StartTime	date-time	A un momento dado, este OrderBaseApiModel debe iniciarse (introducido en la versión 1.3).
EndTime	EndTime	date-time	A un momento dado, orderBaseApiModel se debe completar (introducido en la versión 1.3).
ServiceType	ServiceType	string	ServiceType asociado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	A un momento dado, se creó este OrderBaseApiModel.
Número de pedido	OrderNumber	string	Número de pedido asociado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Estado que muestra si OrderBaseApiModel está cerrado.
Estado	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
ClientId	ClientId	integer	internal Use Id para el cliente: propiedad de extensión de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Identificador de ApiService asociado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versión del módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Nombre	Ruta de acceso	Tipo	Description
StatusStartDateTime	StatusStartDateTime	date-time	A un momento dado, se inició el estado orderStatusHistoryListItemApiModel.
StatusEndDateTime	StatusEndDateTime	date-time	A un momento dado, se finalizó el estado orderStatusHistoryListItemApiModel.
StatusId	StatusId	integer	Identificador asociado a este OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Índice asociado a este OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Etiquetado del contenido asociado a este OrderStatusHistoryListItemApiModel.
TipoDeEstado	StatusType	integer	Estado del pedido: 0 para nuevo pedido, 1 para envío, 2 para en curso, 3 para completado y 4 para cancelado.
ExternalOrderId	ExternalOrderId	string	OrderId de uso externo para la propiedad Client - API Extension.
Id de pedido	OrderId	integer	OrderId asociado a este OrderStatusHistoryListItemApiModel.
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	Identificador de ApiService asociado a este OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Nombre	Ruta de acceso	Tipo	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Id de pedido	OrderId	integer	Identificador de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId de uso externo para la propiedad Client - API Extension.
Fecha de vencimiento	DueDate	date-time	A un momento dado, orderBaseApiModel se debe completar (obsoleto en la versión 1.3).
StartTime	StartTime	date-time	A un momento dado, este OrderBaseApiModel debe iniciarse (introducido en la versión 1.3).
EndTime	EndTime	date-time	A un momento dado, orderBaseApiModel se debe completar (introducido en la versión 1.3).
ServiceType	ServiceType	string	ServiceType asociado a este OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	A un momento dado, se creó este OrderBaseApiModel.
Número de pedido	OrderNumber	string	Número de pedido asociado a este OrderBaseApiModel.
IsClosed	IsClosed	boolean	Estado que muestra si OrderBaseApiModel está cerrado.
Estado	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identificador de uso externo para la propiedad De extensión de API de cliente.
ClientId	ClientId	integer	internal Use Id para el cliente: propiedad de extensión de API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Identificador de ApiService asociado a este OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Versión del módulo campos personalizados.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	integer	Identificador de la entrada Timekeeping (comentario heredado: RootSubmittedStatusId).
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Momento dado en el que el usuario se desencargó en el sistema.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Momento dado en el que el usuario se desencargó del sistema.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Número total de horas para esta entrada de mantenimiento de horas.
TotalBreakHours	TotalBreakHours	double	Número total de horas de interrupción (no laborables) para esta entrada de mantenimiento de horas.
NetHours	NetHours	double	Número total de horas cobrables para esta entrada de mantenimiento de tiempo.
Aprobado	Approved	boolean	Estado de aprobación del supervisor para esta entrada de mantenimiento de tiempo.
Interrupciones	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	Identificador del módulo de empresa usado para enviar esta entrada de mantenimiento de tiempo.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Nombre	Ruta de acceso	Tipo	Description
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Hora de comienzo.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Hora de finalización.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Duración en horas. Puede ser null si EndTime es null.
TipoDeEstado	StatusType	integer	Tipo de estado: 1 para descanso y 2 para el almuerzo.
StartLabel	StartLabel	string	Etiqueta de inicio.
EndLabel	EndLabel	string	Etiqueta final.
Subtítulo	Caption	string	Subtítulo.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Nombre	Ruta de acceso	Tipo
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Nombre	Ruta de acceso	Tipo
_Destacado	_Major	integer
_Menor	_Minor	integer
_Construir	_Build	integer
_Revisión	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Nombre	Ruta de acceso	Tipo	Description
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
Vehículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Punto en el tiempo en que se inició este estado de TripApiModel.
EndTime	EndTime	date-time	Punto en el tiempo que finalizó el estado de TripApiModel.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	Cantidad de tiempo de detención en horas asociado a este TripApiModel.
TotalIdleTime	TotalIdleTime	double	Cantidad de tiempo de inactividad en horas asociadas a este TripApiModel.
TotalDuration	TotalDuration	double	Cantidad total de tiempo en horas asociada a este TripApiModel.
Distancia	Distance	double	Distancia recorrida en unidades localizadas asociadas a este TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Nombre	Ruta de acceso	Tipo	Description
Registros	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
Token de Continuación	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Nombre	Ruta de acceso	Tipo	Description
Usuario	User	CustomerAPI.Models.UserReferenceApiModel
Vehículo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag asociado a este GpsDataRecordApiModel.
Ubicación	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geovalla	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Velocidad	Speed	double	Velocidad de movimiento asociada a este GpsDataRecordApiModel.
Heading	Heading	double	Dirección de brújula en grados asociados a este GpsDataRecordApiModel.
Estado	Status	integer	ApiMovementStatus asociado con OrderBaseApiModel - (Detenido: 1, Inactivo: 2, Mover: 3, NotTracking: 4) : OrderStatusApiModel.
StatusTime	StatusTime	string	A un momento dado, se estableció este estado gpsDataRecordApiModel.
Distancia	Distance	double	Distancia viajada en unidades localizadas asociadas a este TripApiModel.
IgniciónOn	IgnitionOn	boolean	Estado de encendido del vehículo asociado a este GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Proveedor de ubicación de API asociado a este GpsDataRecordApiModel - (GPS: 1, Red: 2).

CustomerAPI.Models.User.ReadUserApiModel

Nombre	Ruta de acceso	Tipo	Description
Nombre de usuario	UserName	string	UserName del usuario.
UserId	UserId	integer	Valor de id. del usuario.
GroupName	GroupName	string	Nombre del grupo del usuario.
Primer Nombre	FirstName	string	Nombre del usuario.
Apellido	LastName	string	Apellidos del usuario.
Número de Empleado	EmployeeNumber	string	Número de empleado del usuario.
Correo Electrónico	Email	string	Dirección de correo electrónico del usuario.
Teléfono	Phone	string	Número de teléfono del usuario.
RoleId	RoleId	integer	RoleId del usuario : (administrador: 1, usuario: 3, usuario avanzado: 5).
IsActive	IsActive	boolean	Estado activo del usuario.
EPTTEnabled	EPTTEnabled	boolean	Estado de la característica de inserción a conversación mejorada para el usuario: booleano.
EPTTNumber	EPTTNumber	string	Número de teléfono para la característica de inserción a conversación mejorada para usuario: cadena.
EPTTWebMDN	EPTTWebMDN	string	Número de teléfono utilizado para autenticar al usuario en el sistema EPTT de Kodiak - Proporcionado por Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar al usuario en el sistema EPTT de Kodiak : proporcionado por Kodiak.
GPSEnabled	GPSEnabled	boolean	Estado de la característica GPS para el usuario.
MobileOnly	MobileOnly	boolean	Estado del acceso a aplicaciones web de escritorio para CAB : (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Tipo de licencia asignada al usuario: - 0 para Undefined, 1 para Regular, 2 para WebOnly y 3 para Employee.

CustomerAPI.Models.User.ReadUserListItemApiModel

Nombre	Ruta de acceso	Tipo	Description
UserId	UserId	integer	Valor de id. del usuario.
Primer Nombre	FirstName	string	Nombre del usuario.
Apellido	LastName	string	Apellidos del usuario.
Número de Empleado	EmployeeNumber	string	Número de empleado del usuario.
Correo Electrónico	Email	string	Dirección de correo electrónico del usuario.
Teléfono	Phone	string	Número de teléfono del usuario.
RoleId	RoleId	integer	RoleId del usuario : (administrador: 1, usuario: 3, usuario avanzado: 5).
IsActive	IsActive	boolean	Estado activo del usuario.
EPTTEnabled	EPTTEnabled	boolean	Estado de la característica de inserción a conversación mejorada para el usuario: booleano.
EPTTNumber	EPTTNumber	string	Número de teléfono para la característica de inserción a conversación mejorada para usuario: cadena.
EPTTWebMDN	EPTTWebMDN	string	Número de teléfono utilizado para autenticar al usuario en el sistema EPTT de Kodiak - Proporcionado por Kodiak.
EPTTToken	EPTTToken	string	Token de API usado para autenticar al usuario en el sistema EPTT de Kodiak : proporcionado por Kodiak.
GPSEnabled	GPSEnabled	boolean	Estado de la característica GPS para el usuario.
MobileOnly	MobileOnly	boolean	Estado del acceso a aplicaciones web de escritorio para CAB : (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Tipo de licencia asignada al usuario: - 0 para Undefined, 1 para Regular, 2 para WebOnly y 3 para Employee.

CustomerAPI.Models.Vehicles.VehicleReadApi

Modelo de datos del vehículo.

Nombre	Ruta de acceso	Tipo
InternalId	InternalId	integer
Number	Number	string
Nombre	Name	string
Tipo	Type	string
Etiqueta	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
Zona horaria	TimeZone	string
Hacer	Make	string
Año	Year	integer
Modelo	Model	string
Color	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Tipo de dispositivo	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

entero

Este es el tipo de datos básico "entero".

objeto

Este es el tipo 'object'.

Compartir a través de

TeamWherx

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Activación de un usuario

Parámetros

Activar un vehículo

Parámetros

Devoluciones

Actualización de una geovalla existente

Parámetros

Devoluciones

Actualización parcial de un vehículo

Parámetros

Devoluciones

Actualizar parte de un usuario

Parámetros

Devoluciones

Actualizar un cliente

Parámetros

Devoluciones

Actualizar un pedido

Parámetros

Devoluciones

Actualizar un usuario

Parámetros

Devoluciones

Actualizar un vehículo

Parámetros

Devoluciones

Cancelación de la suscripción de webhook de datos GPS

Parámetros

Cancelar la suscripción de eventos webhook

Parámetros

Carga de un archivo binario

Devoluciones

Cargar archivo adjunto

Devoluciones

Crea un pedido.

Parámetros

Devoluciones

Creación de un usuario

Parámetros

Devoluciones

Creación de un vehículo

Parámetros

Devoluciones

Creación de una geovalla

Parámetros

Devoluciones

Creación o actualización de una definición de evento personalizada

Parámetros

Crear o actualizar un registro de lista personalizado

Parámetros

Crear un cliente

Parámetros

Devoluciones

Crear un formulario

Parámetros

Devoluciones

Desactivar un usuario

Parámetros

Desactivar un vehículo

Parámetros

Devoluciones

Devolución de llamada de webhook con fuente de distribución de datos GPS

Parámetros

Devoluciones

Devolución de llamada de webhook con fuente de eventos

Parámetros

Devoluciones

Eliminación de un cliente

Parámetros

Eliminación de una definición de evento personalizada

Parámetros

Eliminar registro de lista personalizado

Parámetros

Eliminar un vehículo