NAV
cURL

Inicio

Bienvenid@ a la API de Partes de Trabajo en la Nube.

Mediante esta API podrás integrar la app de partes con cualquier desarrollo que tengas.

Para hacer uso de la misma ponte en contacto con nosotros.

Autenticación

Para autorizar las consultas debes usar el siguiente código:

# Se debe proporcionar este dato en el header de cada consulta para que sea validada
curl "endpoint_de_la_api" \
  -H "X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx"

Asegúrate de reemplazar xxxxxxxxxxxxxxx con el token privado proporcionado.

La API de Partes de Trabajo en la Nube valida mediante el uso de API Keys privadas. Para obtener el API Key y hacer uso de la misma debes ponerte primeramente en contacto con nosotros.

Nuestra API espera que el API key sea incluido en el header de todas las consultas:

X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx

Obtener los datos del usuario autenticado

curl -X GET "https://api.partedetrabajo.com/v1/me"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "email": "test@test.com",
    "nombrecompleto": "Test",
    "empresa": "Test S.L.",
    "logo": "/9j/4AAQSLZb... ...DSY5EigAAAAAAAAAD//Z",
    "domicilio": "C/ Test, 123 ",
    "localidad": "Test",
    "provincia": "Test",
    "codigopostal": "00000",
    "telefono": "555444333",
    "movil": "555444333",
    "emailcontacto": "test@test.com",
    "web": "www.partedetrabajo.com",
    "cif": "B00000000"
}

Este endpoint devuelve el usuario autenticado

HTTP Request

GET https://api.partedetrabajo.com/v1/me/

Actuaciones

El objeto actuacion

Ejemplo de objeto actuacion:

{
    "id": "D892C0572D8",
    "codigo": "001",
    "descripcion": "Descripcion 1",
    "notas": "Nota de prueba"
}
Parámetro Tipo Descripción
id string Identificador único de la actuación (Auto-asignado, NO personalizable)
codigo  string Código interno (personalizable) de la actuación. Debe ser único.
descripcion  string  Descripción de la actuación
notas  string Notas a tener en cuenta con respecto a la actuación

Obtener todas las actuaciones

curl -X GET "https://api.partedetrabajo.com/v1/actuaciones/"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
      {
            "id": "D892C0572D8",
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "notas": "Nota de prueba"
        },
        {
            "id": "13BD4C880009",
            "codigo": "002",
            "descripcion": "Descripción 2",
            "notas": "Nota de prueba"
        }
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todas las actuaciones

HTTP Request

GET https://api.partedetrabajo.com/v1/actuaciones/

Query params

Parámetro Valor por defecto  Opcional Descripción
limite  25 Si  Número máximo de actuaciones a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Filtrar actuaciones

curl -X GET "https://api.partedetrabajo.com/v1/actuaciones/filtrar?codigo=001"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
        {
            "id": "D892C0572D8",
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "notas": "Nota de prueba"
        },
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todas las actuaciones filtrando

HTTP Request

GET https://api.partedetrabajo.com/v1/actuaciones/filtrar?codigo=001

Query params

Parámetro Valor por defecto  Opcional Descripción
codigo  -- Si  Filtro - Código interno de la actuación
limite  25 Si  Número máximo de actuaciones a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Obtener una actuación específica

curl -X GET "https://api.partedetrabajo.com/v1/actuaciones/D892C0572D8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "D892C0572D8",
    "codigo": "001",
    "descripcion": "Descripcion 1",
    "notas": "Nota de prueba"
}

Este endpoint devuelve una actuación específica

HTTP Request

GET https://api.partedetrabajo.com/v1/actuaciones/<ID>

URL Parameters

Parámetro Descripción
ID El ID de la actuación que se desea obtener

Crear una actuación

curl -X POST "https://api.partedetrabajo.com/v1/actuaciones/"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "notas": "Nota de prueba"
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Actuación creada"
}

Este endpoint crea una actuación con los datos proporcionados

HTTP Request

POST https://api.partedetrabajo.com/v1/actuaciones/

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de actuación con los datos en formato raw

Propiedades del JSON de actuación

Propiedad Tipo Descripción
codigo  string Código interno
descripcion  string Descripción de la actuación
notas  string Notas a tener en cuenta sobre la actuación

Actualizar una actuación

curl -X PUT "https://api.partedetrabajo.com/v1/actuaciones/D892C0572D8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "descripcion": "Descripcion 1 actualizada",
            "notas": "Nota de prueba"
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Actuación actualizada correctamente"
}

Este endpoint actualiza una actuación con los datos proporcionados

HTTP Request

PUT https://api.partedetrabajo.com/v1/actuaciones/<ID>

URL Parameters

Parámetro Descripción
ID El ID de la actuación que se desea actualizar

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de actuación con los datos en formato raw

Propiedades del JSON de actuación

Propiedad Tipo Descripción
descripcion  string Descripción de la actuación
notas  string Notas sobre la actuación

Eliminar una actuación

curl -X DELETE "https://api.partedetrabajo.com/v1/actuaciones/D892C0572D8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Actuación eliminada correctamente"
}

Este endpoint elimina una actuación específica

HTTP Request

DELETE https://api.partedetrabajo.com/v1/actuaciones/<ID>

URL Parameters

Parámetro Descripción
ID El ID de la actuación que se desea eliminar

Clientes

El objeto cliente

Ejemplo de objeto cliente:

{
    "id": "4425EB6144",
    "codigoInterno": "001",
    "empresa": "Test, S.L. ",
    "nombreComercial": "Prueba",
    "cif": "BXXXXXXXX",
    "personaContacto": "Pepe",
    "email": "test@prueba.com;test@prueba.es",
    "telefono1": "555 444 333",
    "telefono2": "555 666 777",
    "direccion": "C/Falsa, 123",
    "cp": "00000",
    "localidad": "Alicante ",
    "provincia": "Alicante",
    "pais": "España",
    "foto": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBYRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAA... (truncado) ...KACiiigApfakooGmFFFFAgooooAKKKKACiiigAooooA//Z",
    "fechaCreacion": "2018-09-24T09:17:33+02:00"
}
Parámetro Tipo Descripción
id string Identificador único del cliente (Auto-asignado, NO personalizable)
codigoInterno  string Código interno (personalizable) del cliente.
empresa  string  Nombre de la empresa
nombreComercial  string Nombre comercial de la empresa
cif  string  CIF/NIF del cliente
personaContacto  string  Nombre de la persona de contacto
email  string  Email o emails del cliente. Para añadir varios deben estar separados por un punto y coma ";"
telefono1  string  Teléfono principal del cliente
telefono2 string  Teléfono secundario del cliente
direccion  string  Dirección del cliente
cp  string Código postal
localidad  string  Localidad del cliente
provincia string  Provincia del cliente
pais  string  País del cliente
foto base64 Imagen del cliente
fechaCreacion  Fecha  Fecha de creación del cliente (Auto-asignado, NO personalizable).

Obtener todos los clientes

curl -X GET "https://api.partedetrabajo.com/v1/clientes/"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
        {
            "id": "4425EB6144",
            "codigoInterno": "001",
            "empresa": "Test, S.L. ",
            "nombreComercial": "Prueba",
            "cif": "BXXXXXXXX",
            "personaContacto": "Pepe",
            "email": "test@prueba.com;test@prueba.es",
            "telefono1": "555 444 333",
            "telefono2": "555 666 777",
            "direccion": "C/Falsa, 123",
            "cp": "00000",
            "localidad": "Alicante ",
            "provincia": "Alicante",
            "pais": "España",
            "fechaCreacion": "2018-09-24T09:17:33+02:00"
        },
        {
            "id": "EC5645DEC7D",
            "codigoInterno": "002",
           "empresa": "Test 2, S.L. ",
            "nombreComercial": "Prueba 2",
            "cif": "BXXXXXXXX",
            "personaContacto": "Juan",
            "email": "test@prueba.com;test@prueba.es",
            "telefono1": "555 444 333",
            "telefono2": "555 666 777",
            "direccion": "C/Falsa, 123",
            "cp": "00000",
            "localidad": "Alicante ",
            "provincia": "Alicante",
            "pais": "España",
            "fechaCreacion": "2019-04-10T17:09:22+02:00"
        }
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todos los clientes

HTTP Request

GET https://api.partedetrabajo.com/v1/clientes/

Query params

Parámetro Valor por defecto  Opcional Descripción
incluye_foto false  Si Si se pasa a true devuelve la imagen (En caso de tenerla) del cliente en base64.
limite  25 Si  Número máximo de clientes a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Filtrar clientes

curl -X GET "https://api.partedetrabajo.com/v1/clientes/filtrar?codigo=001&incluye_foto=false"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
       "docs": [
        {
           "id": "4425EB6144",
            "codigoInterno": "001",
            "empresa": "Test, S.L. ",
            "nombreComercial": "Prueba",
            "cif": "BXXXXXXXX",
            "personaContacto": "Pepe",
            "email": "test@prueba.com;test@prueba.es",
            "telefono1": "555 444 333",
            "telefono2": "555 666 777",
            "direccion": "C/Falsa, 123",
            "cp": "00000",
            "localidad": "Alicante ",
            "provincia": "Alicante",
            "pais": "España",
            "fechaCreacion": "2018-09-24T09:17:33+02:00"
        }
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todos los clientes filtrados

HTTP Request

GET https://api.partedetrabajo.com/v1/clientes/filtrar?codigo=001&incluye_foto=false

Query params

Parámetro Valor por defecto  Opcional Descripción
codigo  -- Si  Filtro - Código interno del cliente 
incluye_foto false  Si Si se pasa a true devuelve la imagen (En caso de tenerla) del cliente en base64.
limite  25 Si  Número máximo de clientes a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Obtener un cliente específico

curl -X GET "https://api.partedetrabajo.com/v1/clientes/4425EB6144"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "4425EB6144",
    "codigoInterno": "001",
    "empresa": "Test, S.L. ",
    "nombreComercial": "Prueba",
    "cif": "BXXXXXXXX",
    "personaContacto": "Pepe",
    "email": "test@prueba.com",
    "telefono1": "555 444 333",
    "telefono2": "555 666 777",
    "direccion": "C/Falsa, 123",
    "cp": "00000",
    "localidad": "Alicante ",
    "provincia": "Alicante",
    "pais": "España",
}

Este endpoint devuelve un cliente específico

HTTP Request

GET https://api.partedetrabajo.com/v1/clientes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del cliente que se desea obtener

Crear un cliente

curl -X POST "https://api.partedetrabajo.com/v1/clientes/"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "codigoInterno": "001",
            "empresa": "Test, S.L. ",
            "nombreComercial": "Prueba",
            "cif": "BXXXXXXXX",
            "personaContacto": "Pepe",
            "email": "test@prueba.com",
            "telefono1": "555 444 333",
            "telefono2": "555 666 777",
            "direccion": "C/Falsa, 123",
            "cp": "00000",
            "localidad": "Alicante ",
            "provincia": "Alicante",
            "pais": "España",
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Cliente creado"
}

Este endpoint crea un cliente con los datos proporcionados

HTTP Request

POST https://api.partedetrabajo.com/v1/clientes/

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de cliente con los datos en formato raw

Propiedades del JSON de cliente

Propiedad Tipo Descripción
codigoInterno  string Código interno
empresa  string Nombre de la emplesa
nombreComercial  string Nombre comercial
cif  string CIF de la empresa
personaContacto  string Nombre de la persona de contacto
email  string Email
telefono1  string Teléfono principal
telefono2  string Teléfono secundario
direccion  string Dirección del cliente
cp  string Código postal
localidad  string Localidad
provincia  string Provincia
pais  string País
foto base64 Imagen

Actualizar un cliente

curl -X PUT "https://api.partedetrabajo.com/v1/clientes/4425EB6144"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "codigoInterno": "001",
            "empresa": "Test, S.L. ",
            "nombreComercial": "Prueba",
            "cif": "BXXXXXXXX",
            "personaContacto": "Pepe",
            "email": "test@prueba.com",
            "telefono1": "555 444 333",
            "telefono2": "555 666 777",
            "direccion": "C/Falsa, 123",
            "cp": "00000",
            "localidad": "Alicante ",
            "provincia": "Alicante",
            "pais": "España",
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Cliente actualizado correctamente"
}

Este endpoint actualiza un cliente con los datos proporcionados

HTTP Request

PUT https://api.partedetrabajo.com/v1/clientes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del cliente que se desea actualizar

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de cliente con los datos en formato raw

Propiedades del JSON de cliente

Propiedad Tipo Descripción
codigoInterno  string Código interno
empresa  string Nombre de la emplesa
nombreComercial  string Nombre comercial
cif  string CIF de la empresa
personaContacto  string Nombre de la persona de contacto
email  string Email
telefono1  string Teléfono principal
telefono2  string Teléfono secundario
direccion  string Dirección del cliente
cp  string Código postal
localidad  string Localidad
provincia  string Provincia
pais  string País
foto base64 Imagen

Eliminar un cliente

curl -X DELETE "https://api.partedetrabajo.com/v1/clientes/4425EB6144"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Cliente eliminado correctamente"
}

Este endpoint elimina un cliente específico

HTTP Request

DELETE https://api.partedetrabajo.com/v1/clientes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del cliente que se desea eliminar

Partes

El objeto parte

Ejemplo de objeto parte:

{
    "id": "1780355C534C",
    "fecha": "2021-03-18T07:18:33.963Z",
    "horaIni": "2021-03-12T12:12",
    "horaFin": "2021-03-13T12:02",
    "kilometraje": null,
    "trabajoSolicitado": "Descripción del trabajo solicitado",
    "notas": " - ",
    "notasInternas": "Notas internas del parte",
    "notasInternasAdministracion": "Notas internas para la administración",
    "estado": 2,
    "dniFirma": "",
    "personaFirmante": "",
    "firma": "",
    "tecnicos": [
        {
        "user": "pepe@test.es",
        "nombre": "pepe",
        "tipocuenta": 0
        }
    ],
            "log": [
                {
                "accion": 0,
                "descripcion": "",
                "fecha": "2019-10-21T17:14:20.000Z",
                "autor": "pepe (pepe@test.es)"
                }
            ],
            "fotos_id": [],
            "lineasProducto": [],
            "lineasActuacion": [
                {
                "codigo": "001",
                "descripcion": "Actuacion 1",
                "notas": "Notas sobre la actuacion 1",
                },
                {
                "codigo": "",
                "descripcion": "Actuacion 2",
                "notas": "Notas sobre la actuacion 2",
                },
            ],
            "coordenadasFirma": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474359782
            },
            "coordenadasInicio": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474357782
            },
            "coordenadasFin": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474359782
            },
            "pausas": [],
            "cliente_codigoInterno": "",
            "cliente_id": "10931D18E043",
            "cliente_empresa": "Empresa 1",
            "cliente_cif": "B12345678",
            "cliente_direccion": "C/Falsa 123",
            "cliente_provincia": "Provincia",
            "cliente_localidad": "Pueblo",
            "cliente_pais": "España",
            "cliente_telefono": "666555444",
            "cliente_email": "Pueba@test.com",
            "proyecto_id": "",
            "ejercicio": "2020",
            "numero": 318
        },
Parámetro Tipo Descripción
id string Identificador único del parte (Auto-asignado, NO personalizable)
fecha Fecha Fecha de creación del parte
horaIni Fecha  Fecha de inicio del parte
horaFin Fecha Fecha de fin del parte
kilometraje Entero o null  Kilometraje imputable
trabajoSolicitado  string  Descripción del trabajo solicitado
notas  string  Notas a tener en cuenta en el parte
notasInternas  string  Notas internas del parte
notasInternasAdministracion string  Anotaciones a tener en cuenta por parte de administración
estado  Entero [0-2]  Estado del parte:
0: Aviso
1: Parte en proceso
2: parte finalizado
dniFirma  string DNI/NIF de la persona firmante
personaFirmante  string  Nombre de la persona firmante
firma base64  Imagen de la firma capturada
tecnicos  Array [tecnicos]  Tecnicos/trabajadores implicados en el parte
log Array [accion] Array con información sobre cambios en el parte
fotos_id  Array [string]  Array con los identificadores de las fotos añadidas al parte
lineasProducto Array [productos]  Array con los productos añadidos al parte
lineasActuacion Array [actuaciones]  Array con las actuaciones añadidas al parte
coordenadasFirma Coordenada  Coordenada registrada al firmar el parte
coordenadasInicio Coordenada  Coordenada registrada al iniciar el parte
coordenadasFin Coordenada  Coordenada registrada al finalizar el parte.
pausas Array [pausas]  Array con las pausas realizadas
cliente_codigoInterno string  Código interno del cliente
cliente_id string  Identificador único del cliente
cliente_empresa string  Nombre del cliente
cliente_cif string  CIF/NIF del cliente
cliente_direccion string  Dirección del cliente
cliente_provincia string  Provinicia del cliente
cliente_localidad string  Localidad del cliente
cliente_pais string  País del cliente
cliente_telefono string  Teléfono del cliente
cliente_email string  Email del cliente
proyecto_id string  Identificador único del proyecto
ejercicio string  Ejercicio del parte
numero Entero  FNúmero de parte

El objeto tecnico

Ejemplo de objeto tecnico:

{
    "user": "pepe@test.es",
    "nombre": "pepe",
    "tipocuenta": 0
}
Parámetro Tipo Descripción
user email Email del técnico (Es su identificador)
nombre string  Nombre del técnico
tipocuenta entero [0-1] Tipo de cuenta:
0: Colaborador
1: Empresa

El objeto accion

Ejemplo de objeto tecnico:

{
    "accion": 0,
    "descripcion": "",
    "fecha": "2019-10-21T17:14:20.000Z",
    "autor": "pepe (pepe@test.es)"
}
Parámetro Tipo Descripción
accion entero [0-6] Acción realizada:
0: Nuevo
1: Actualizar
2: Compartir
3: Cambiar técnicos
4: Firmar
5: Borrar firma
6: Envío de notificación PUSH
descripcion string  Descripción de la acción
fecha Fecha Fecha de creación de la acción
autor  string  Persona que realizó la acción

El objeto coordenada

Ejemplo de objeto coordenada:

{
    "lat": 38.16335989328763,
    "ln": -0.8021086884398485,
    "time": 1615474359782
}
Parámetro Tipo Descripción
lat latitud  Latitud de la coordenada
ln longitud Longitud de la coordenada
time fecha  Fecha de recogida del dato en format timestamp

Obtener todos los partes

curl -X GET "https://api.partedetrabajo.com/v1/partes/"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
        {
            "id": "1780355C534C",
            "fecha": "2021-03-18T07:18:33.963Z",
            "horaIni": "2021-03-12T12:12",
            "horaFin": "2021-03-13T12:02",
            "kilometraje": null,
            "trabajoSolicitado": "Descripción del trabajo solicitado",
            "notas": " - ",
            "notasInternas": "Notas internas del parte",
            "notasInternasAdministracion": "Notas internas para la administración",
            "estado": 2,
            "dniFirma": "",
            "personaFirmante": "",
            "firma": "",
            "tecnicos": [
                {
                "user": "pepe@test.es",
                "nombre": "pepe",
                "tipocuenta": 0
                }
            ],
            "log": [
                {
                "accion": 0,
                "descripcion": "",
                "fecha": "2019-10-21T17:14:20.000Z",
                "autor": "pepe (pepe@test.es)"
                }
            ],
            "fotos_id": [],
            "lineasProducto": [],
            "lineasActuacion": [
                {
                "codigo": "001",
                "descripcion": "Actuacion 1",
                "notas": "Notas sobre la actuacion 1",
                },
                {
                "codigo": "",
                "descripcion": "Actuacion 2",
                "notas": "Notas sobre la actuacion 2",
                },
            ],
            "coordenadasFirma": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474359782
            },
            "coordenadasInicio": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474357782
            },
            "coordenadasFin": {
                "lat": 38.16335989328763,
                "ln": -0.8021086884398485,
                "time": 1615474359782
            },
            "pausas": [],
            "cliente_codigoInterno": "",
            "cliente_id": "10931D18E043",
            "cliente_empresa": "Empresa 1",
            "cliente_cif": "B12345678",
            "cliente_direccion": "C/Falsa 123",
            "cliente_provincia": "Provincia",
            "cliente_localidad": "Pueblo",
            "cliente_pais": "España",
            "cliente_telefono": "666555444",
            "cliente_email": "Pueba@test.com",
            "proyecto_id": "",
            "ejercicio": "2020",
            "numero": 318
        },
        {
            "id": "106685F06537",
            "fecha": "2021-03-18T07:19:03.263Z",
            "horaIni": "2021-03-12T12:12",
            "horaFin": "2021-03-13T12:02",
            "kilometraje": null,
            "trabajoSolicitado": "",
            "notas": "",
            "notasInternas": "",
            "notasInternasAdministracion": "",
            "estado": 1,
            "dniFirma": "",
            "personaFirmante": "",
            "firma": "",
            "tecnicos": [
                {
                    "user": "test@prueba.es",
                    "nombre": "pepe",
                    "tipocuenta": 0
                }
            ],
            "log": [],
            "fotos_id": [],
            "lineasProducto": [],
            "lineasActuacion": [],
            "coordenadasFirma": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "coordenadasInicio": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "coordenadasFin": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "pausas": [],
            "cliente_codigoInterno": "",
            "cliente_id": "10931D18E043",
            "cliente_empresa": "Nombre de la empresa, S.L.",
            "cliente_cif": "BXXXXXXXX",
            "cliente_direccion": "C/Falsa 123",
            "cliente_provincia": "Provincia",
            "cliente_localidad": "Pueblo",
            "cliente_pais": "España",
            "cliente_telefono": "555 444 333",
            "cliente_email": "test@probando.com",
            "proyecto_id": "",
            "ejercicio": "2020",
            "numero": 319
        }
    ],
    "bookmark": "g1AAAABieJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJjlgKnNAekEKBYwMjAx1DYx1DY1CDI2sDI1Agqxg3VlZANdjGDY",
}

Este endpoint devuelve todos los partes

HTTP Request

GET https://api.partedetrabajo.com/v1/partes/

Query params

Parámetro Valor por defecto  Opcional Descripción
limite  25 Si  Número máximo de partes a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Filtrar partes

curl -X GET "https://api.partedetrabajo.com/v1/partes/filtrar?desde=2021-03-11&hasta=2021-03-13&id_colaborador=test@prueba.es&cliente_id=10931D18E043&estado=1"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
        {
            "id": "106685F06537",
            "fecha": "2021-03-18T07:19:03.263Z",
            "horaIni": "2021-03-12T12:12",
            "horaFin": "2021-03-13T12:02",
            "kilometraje": null,
            "trabajoSolicitado": "",
            "notas": "",
            "notasInternas": "",
            "notasInternasAdministracion": "",
            "estado": 1,
            "dniFirma": "",
            "personaFirmante": "",
            "firma": "",
            "tecnicos": [
                {
                    "user": "test@prueba.es",
                    "nombre": "pepe",
                    "tipocuenta": 0
                }
            ],
            "log": [],
            "fotos_id": [],
            "lineasProducto": [],
            "lineasActuacion": [],
            "coordenadasFirma": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "coordenadasInicio": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "coordenadasFin": {
                "lat": null,
                "ln": null,
                "time": 1615474357782
            },
            "pausas": [],
            "cliente_codigoInterno": "",
            "cliente_id": "10931D18E043",
            "cliente_empresa": "Nombre de la empresa, S.L.",
            "cliente_cif": "BXXXXXXXX",
            "cliente_direccion": "C/Falsa 123",
            "cliente_provincia": "Provincia",
            "cliente_localidad": "Pueblo",
            "cliente_pais": "España",
            "cliente_telefono": "555 444 333",
            "cliente_email": "test@probando.com",
            "proyecto_id": "",
            "ejercicio": "2020",
            "numero": 319
        }
    ],
    "bookmark": "g1AAAABieJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJjlgKnNAekEKBYwMjAx1DYx1DY1CDI2sDI1Agqxg3VlZANdjGDY",
}

Este endpoint devuelve todos los partes filtrados

HTTP Request

GET https://api.partedetrabajo.com/v1/partes/filtrar?codigo=001&incluye_foto=false

Query params

Parámetro Valor por defecto  Opcional Descripción
desde  -  Si Devuelve los partes posteriores a la fecha proporcionada en formato aaaa-mm-dd (Ej. 2021-03-11)
hasta  -  Si Devuelve los anteriores a la fecha proporcionada en formato aaaa-mm-dd (Ej. 2021-03-13)
estado  -  Si Devuelve los partes en un estado concreto 0: Aviso,  1: En proceso, 2: Finalizado (Ej. 1)
cliente_id  -  Si Devuelve los partes de un clinente en concreto
proyecto_id  -  Si Devuelve los partes asociados a un proyecto
id_colaborador  -  Si Devuelve los partes en los que está incluido el colaborador
limite  25 Si  Número máximo de clientes a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Obtener un parte específico

curl -X GET "https://api.partedetrabajo.com/v1/partes/106685F06537"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "106685F06537",
    "fecha": "2021-03-18T07:19:03.263Z",
    "horaIni": "2021-03-12T12:12",
    "horaFin": "2021-03-13T12:02",
    "kilometraje": null,
    "trabajoSolicitado": "",
    "notas": "",
    "notasInternas": "",
    "notasInternasAdministracion": "",
    "estado": 1,
    "dniFirma": "",
    "personaFirmante": "",
    "firma": "",
    "tecnicos": [
        {
            "user": "test@prueba.es",
            "nombre": "pepe",
            "tipocuenta": 0
        }
    ],
    "log": [],
    "fotos_id": [],
    "lineasProducto": [],
    "lineasActuacion": [],
    "coordenadasFirma": {
        "lat": null,
        "ln": null,
        "time": 1615474357782
    },
    "coordenadasInicio": {
        "lat": null,
        "ln": null,
        "time": 1615474357782
    },
    "coordenadasFin": {
        "lat": null,
        "ln": null,
        "time": 1615474357782
    },
    "pausas": [],
    "cliente_codigoInterno": "",
    "cliente_id": "10931D18E043",
    "cliente_empresa": "Nombre de la empresa, S.L.",
    "cliente_cif": "BXXXXXXXX",
    "cliente_direccion": "C/Falsa 123",
    "cliente_provincia": "Provincia",
    "cliente_localidad": "Pueblo",
    "cliente_pais": "España",
    "cliente_telefono": "555 444 333",
    "cliente_email": "test@probando.com",
    "proyecto_id": "",
    "ejercicio": "2020",
    "numero": 319
}

Este endpoint devuelve un parte específico

HTTP Request

GET https://api.partedetrabajo.com/v1/partes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del parte que se desea obtener

Crear un parte

curl -X POST "https://api.partedetrabajo.com/v1/partes/"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "cliente_id": "75E9982D796",
            "horaIni": "2021-03-12T12:12",
            "horaFin": "2021-03-13T12:02",
            "estado": 0,
            "tecnicos": [
                {
                    "user": "pepe@prueba.test",
                    "nombre": "pepe",
                    "tipocuenta": 0
                }
            ]
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "11A0327C36CA",
    "message": "Parte creado con éxito"
}

Este endpoint crea un parte con los datos proporcionados

HTTP Request

POST https://api.partedetrabajo.com/v1/partes/

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de parte con los datos en formato raw

Propiedades del JSON de parte

Propiedad Tipo Descripción
cliente_id  string  ID del cliente al que se desea crear el parte.
horaIni Fecha Fecha con la hora de inicio en formato ISO8601. Debe contener la fecha con horas y minutos. Por ejemplo: '2021-07-16T19:20';
horaFin Fecha Fecha con la hora de fin en formato ISO8601. Debe contener la fecha con horas y minutos. Por ejemplo: '2021-07-16T19:20';
estado  Entero [0-2]  Estado del parte:
0: Aviso
1: Parte en proceso
2: parte finalizado
tecnicos  Array [tecnicos]  Tecnicos/trabajadores implicados en el parte

Actualizar un parte

curl -X PUT "https://api.partedetrabajo.com/v1/partes/11A0327C36CA"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "cliente_id": "75E9982D796",
            "horaIni": "2021-03-12T12:12",
            "horaFin": "2021-03-13T12:02",
            "estado": 0,
            "tecnicos": [
                {
                    "user": "pepe@prueba.test",
                    "nombre": "pepe",
                    "tipocuenta": 0
                }
            ]
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "11A0327C36CA",
    "message": "Parte actualizado con éxito"
}

Este endpoint actualiza un parte con los datos proporcionados

HTTP Request

PUT https://api.partedetrabajo.com/v1/partes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del parte que se desea actualizar

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de parte con los datos en formato raw

Eliminar un parte

curl -X DELETE "https://api.partedetrabajo.com/v1/partes/11A0327C36CA"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Parte eliminado correctamente"
}

Este endpoint elimina un parte específico

HTTP Request

DELETE https://api.partedetrabajo.com/v1/partes/<ID>

URL Parameters

Parámetro Descripción
ID El ID del parte que se desea eliminar

Productos

El objeto producto

Ejemplo de objeto producto:

{
    "id": "12213F3A24A8",
    "codigo": "001",
    "descripcion": "Descripcion 1",
    "precio": 3.7,
    "notas": "Nota de prueba"
}
Parámetro Tipo Descripción
id string Identificador único del producto (Auto-asignado, NO personalizable)
codigo  string Código interno (personalizable) del producto. Debe ser único.
descripcion  string  Descripción del producto
precio  Float  Precio del producto
notas  string Notas a tener en cuenta con respecto al producto

Obtener todas las productos

curl -X GET "https://api.partedetrabajo.com/v1/productos/"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
      {
            "id": "12213F3A24A8",
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "precio": 3.7,
            "notas": "Nota de prueba"
        },
        {
            "id": "13124CFC2EE1",
            "codigo": "002",
            "descripcion": "Descripción 2",
            "precio": 0,
            "notas": "Nota de prueba"
        }
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todos los productos

HTTP Request

GET https://api.partedetrabajo.com/v1/productos/

Query params

Parámetro Valor por defecto  Opcional Descripción
limite  25 Si  Número máximo de productos a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Filtrar productos

curl -X GET "https://api.partedetrabajo.com/v1/productos/filtrar?codigo=001"   
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "docs": [
        {
            "id": "12213F3A24A8",
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "precio": 3.7,
            "notas": "Nota de prueba"
        },
    ],
    "bookmark": "g1AAAAD5eJxVjk0KwjAQhYPgz0IT0I4_Q6aJ4A6NtQco"
}

Este endpoint devuelve todao los productos filtrando

HTTP Request

GET https://api.partedetrabajo.com/v1/productos/filtrar?codigo=001

Query params

Parámetro Valor por defecto  Opcional Descripción
codigo  -- Si  Filtro - Código interno del producto
limite  25 Si  Número máximo de productos a devolver
bookmark  ''  Si  Marcador del último documento obtenido en la consulta (Puede usarse para paginación)

Obtener un producto específica

curl -X GET "https://api.partedetrabajo.com/v1/productos/12213F3A24A8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "id": "12213F3A24A8",
    "codigo": "001",
    "descripcion": "Descripcion 1",
    "precio": 3.7,
    "notas": "Nota de prueba"
}

Este endpoint devuelve un producto específico

HTTP Request

GET https://api.partedetrabajo.com/v1/productos/<ID>

URL Parameters

Parámetro Descripción
ID El ID del producto que se desea obtener

Crear un producto

curl -X POST "https://api.partedetrabajo.com/v1/productos/"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "codigo": "001",
            "descripcion": "Descripcion 1",
            "precio": 3.7,
            "notas": "Nota de prueba"
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Producto creado"
}

Este endpoint crea un producto con los datos proporcionados

HTTP Request

POST https://api.partedetrabajo.com/v1/productos/

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de producto con los datos en formato raw

Propiedades del JSON de producto

Propiedad Tipo Descripción
codigo  string Código interno
descripcion  string Descripción del producto
precio  Float  Precio del producto
notas  string Notas a tener en cuenta sobre el producto

Actualizar un producto

curl -X PUT "https://api.partedetrabajo.com/v1/productos/12213F3A24A8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`
  -H `Content-Type: application/json`
  --data `{
            "descripcion": "Descripcion 1 actualizada",
            "precio": 3.8,
            "notas": "Nota de prueba"
        }`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Producto actualizado correctamente"
}

Este endpoint actualiza un producto con los datos proporcionados

HTTP Request

PUT https://api.partedetrabajo.com/v1/productos/<ID>

URL Parameters

Parámetro Descripción
ID El ID del producto que se desea actualizar

Body Parameters

Parámetro Tipo Descripción
--data JSON JSON de producto con los datos en formato raw

Propiedades del JSON de producto

Propiedad Tipo Descripción
descripcion  string Descripción del producto
precio  Float  Precio del producto
notas  string Notas sobre el producto

Eliminar un producto

curl -X DELETE "https://api.partedetrabajo.com/v1/productos/12213F3A24A8"
  -H `X-Auth-Partedetrabajo-Token: xxxxxxxxxxxxxxx`

El comando anterior devuelve un JSON estructurado como el siguiente:

{
    "message": "Producto eliminado correctamente"
}

Este endpoint elimina un producto específico

HTTP Request

DELETE https://api.partedetrabajo.com/v1/productos/<ID>

URL Parameters

Parámetro Descripción
ID El ID del producto que se desea eliminar

Errores

La API de Partes de Trabajo en la Nube usa los siguientes códigos genéricos de error:

Código de error Significado
400 Bad Request -- Petición inválida.
401 Unauthorized -- Token secreto no válido o incorrecto.
403 Forbidden -- Recurso no accesible.
404 Not Found -- No se encuentra el recurso.
405 Method Not Allowed -- Método no permitido.
406 Not Acceptable -- Formato de la petición no válido
410 Gone -- Este servicio ya no está disponible en nuestro sistema.
418 Soy una tetera :-).
429 Too Many Requests -- Demasiadas consultas
500 Internal Server Error -- Error en servidor. Trata de acceder al recurso más tarde.
503 Service Unavailable -- Servidor en mantenimiento. Trata de acceder más tarde.