Persat Api
  • Persat API v1.0
  • Introducción
    • ¿Qué es una API?
    • ¿Cómo funciona?
  • Primeros Pasos
    • Introducción
    • Niveles de Acceso y Consideraciones Importantes
    • Formato de Respuesta
    • Autenticación
      • Como obtener el Api key
    • Configurar Webhooks
      • Primeros pasos
      • Lógica de reintentos
  • Entidades Básicas
    • Clientes
      • Obtener un cliente
      • Agregar un cliente
      • Modificar un cliente
      • Eliminar un cliente
      • Listar Clientes
      • Listar Grupos de Clientes
      • Listar Tipos de Clientes
      • Listar Campos Personalizados
      • Eventos / Webhooks
        • Cliente creado
        • Cliente modificado
        • Cliente eliminado
    • Objetos en Cliente
      • Obtener estructura/esquema de un Objeto en Cliente
      • Listar estructuras/esquemas de los Objetos en Cliente
      • Obtener objeto
      • Insertar objeto
      • Modificar objeto
      • Eliminar objeto
      • Listar Objetos en un Cliente particular
      • Sincronizacion completa
    • Master Db
      • Obtener estructura/esquema de una Master Db
      • Listar estructuras/esquemas de las Master Dbs
      • Obtener elemento
      • Insertar elemento
      • Modificar elemento
      • Eliminar elemento
      • Sincronizacion completa
    • Dispositivos
      • Obtener Dispositivo
      • Listar Dispositivos
    • Usuarios
      • Listar Usuarios
      • Listar Técnicos Activos
    • Seguimientos
      • Crear seguimientos
  • Modulos
    • 🚚Rastreo Satelital
      • Obtener última posición GPS
      • Obtener estadísticas de Rastreo
      • Obtener Visitas a Clientes
      • Integrar Dispositivos de Rastreo a Persat
    • ☑️Formularios Digitales
      • Obtener estructura/esquema de un Formulario
      • Listar estructuras/esquemas de todos los Formularios
      • Obtener formulario
      • Obtener PDF del formulario
      • Tipos de Widgets
        • Campo Texto
        • Campo Párrafo
        • Campo Link
        • Campo Número
        • Campo Fecha
        • Campo Hora
        • Seleccion Simple
        • Lista Desplegable
        • Selección Múltiple
        • Campo Foto (deprecado)
        • Campo Fotos
        • Firma Digital (deprecado)
        • Firma Digital v2
        • Etiquetas
        • Tabla Smart
        • Tabla Master Db
        • Lista de Objetos en Cliente
        • Tabla de Objetos en Cliente
      • Insertar formulario
      • Modificar formulario
      • Modificar estado de formulario
      • Listar historial de estados de un formulario
      • Listar formularios
      • Estados de formulario
        • Obtener estado
        • Listar estados
      • Eventos / Webhooks
        • Formulario Creado
        • Formulario Modificado
        • Formulario estado modificado
        • Formulario estado modificado masivamente
    • 🛠️Órdenes de Trabajo
      • Obtener estructura/esquema de un Tipo de OT
      • Listar estructuras/esquemas de todos los tipos de OTs
      • Administrar Etiquetas
        • Obtener Etiqueta
        • Insertar Etiqueta
        • Modificar Etiqueta
        • Eliminar Etiqueta
        • Listar Etiquetas
      • Obtener OT
        • PENDIENTE sin instrucciones
        • PENDIENTE con instrucciones
        • PROYECTADA sin instrucciones
        • PROYECTADA con instrucciones
        • ASIGNADA
        • INFORME
        • VENCIDA
        • CERRADA_OK
        • CERRADA_CON_DESVIO
        • CERRADA_NO_CUMPLIDA
      • Obtener PDF de la OT
      • Insertar OT
        • Insertar PENDIENTE
        • Insertar PROYECTADA
        • Insertar ASIGNADA
      • Modificar OT
        • Modificar etiquetas
        • Cancelar OT
        • Mover a estado PENDIENTE
      • Listar OTs
      • Obtener link de trackeo
      • Eventos / Webhooks
        • OT creada
        • OT modificada
        • OT finalizada
        • OT cerrada
    • 📦Gestión de Entregas
      • Obtener estructura/esquema de un Tipo de Entrega
      • Listar estructuras/esquemas de todos los tipos de Entregas
      • Administrar Etiquetas
        • Obtener Etiqueta
        • Insertar Etiqueta
        • Modificar Etiqueta
        • Eliminar Etiqueta
        • Listar Etiquetas
      • Obtener entrega
        • Estado PENDING
        • Estado ROUTING
        • Estado ASSIGNED
        • Estado FINISHED
        • Estado FINISHED_WITH_DEVIATION
        • Estado NOT_FINISHED
      • Obtener PDF de entrega
      • Crear entrega
        • Crear Entrega Simple
        • Crear Entrega en Cliente
      • Eliminar entrega
      • Listar Entregas
      • Obtener link de trackeo
      • Eventos / Webhooks
        • Entrega Creada
        • Entrega Finalizada
        • Entrega Eliminada
      • Rutas de Entrega
        • Obtener Ruta
        • Listar Rutas
        • Eventos / Webhooks
          • Ruta Asignada
          • Ruta Modificada
          • Ruta Cancelada
Powered by GitBook
On this page
  • Ejemplo de request
  • Analizando la Respuesta
  1. Modulos
  2. Formularios Digitales

Insertar formulario

Para insertar un formulario en Persat, se debe enviar un POST como el que se especifica a continuación.

POST https://api.persat.com.ar/v1/digital-forms

Headers

Name
Type
Description

Authorization*

String

Bearer API_KEY

Content-Type*

String

application/json

Request Body

Name
Type
Description

uid_client*

String

Identificador del cliente

df_data.schema_id*

Number

Identificador de la plantilla del formulario

df_data.formvalues*

Object

Cada uno de los valores para cada wiidget del formulario

{
    "success": true,
    "data": {
        "_id": "552",
        "created": "2022-05-19T09:26:26.000Z",
        "created_by_user_name": "Creado por Api",
        "created_by_user_id": -1,
        "client": {
            "id": 12796,
            "name": "Logistica Hnos.",
            "uid_client": "AABC9098"
        },
        "df_data": {
            "schema_id": 150,
            "results": {
                "last_updated": "2022-05-19T09:26:26.000Z",
                "formvalues": {
                    "FWA3VCpeS": "Visitado por la mañana",
                    "FWWucoyGH": 321.11,
                }
            }
        },
        "state": {
            "color": "BLUE",
            "deleted": false,
            "id": 26,
            "name": "Listo"
        },
    }
}
{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'uid_client' debe ser un string"
    }
}

Ejemplo de request

body

{
    "uid_client": "AABC9098",
    "df_data": {
        "schema_id": 150, 
        "formvalues": {
            "FWA3VCpeS": "Visitado por la mañana",
            "FWWucoyGH": 321.11
        }
    }
}

Analizando la Respuesta

Cuando se inserta un formulario se agrega el estado inicial.

{
    "success": true,
    "data": {
        "_id": "552",
        "created": "2022-05-19T09:26:26.000Z",
        "created_by_user_name": "Creado por Api",
        "created_by_user_id": -1,
        "client": {
            "id": 12796,
            "name": "Logistica Hnos.",
            "uid_client": "AABC9098"
        },
        "df_data": {
            "schema_id": 150,
            "results": {
                "last_updated": "2022-05-19T09:26:26.000Z",
                "formvalues": {
                    "FWA3VCpeS": "Visitado por la mañana",
                    "FWWucoyGH": 321.11
                }
            }
        },
        "state": {
             "color": "RED",
             "deleted": false,
             "id": 27,
             "name": "Cancelado"
        }
    }
}

Last updated 3 months ago

En este ejemplo insertamos un formulario de tipo 150 (schema_id) en el cliente "AABC9098". Este formulario es sencilllo ya que tiene un widget de CAMPO NUMERO y otro de CAMPO TEXTO. Ver seccion para mas detalles.

En caso que no haya ningun error, obtenemos una respuesta de este estilo. La explicación de cada uno de los campos se puede ver en la sección

☑️
Tipos de Widgets
Obtener Formulario