Guías técnicas

Servicio Web API de Prevengos (documentación técnica)

1. Introducción

La API de Prevengos está organizada en torno a REST. Nuestra API tiene URLs predecibles orientadas a los recursos. Devuelve respuestas codificadas por JSON o XML y utiliza códigos de respuesta HTTP, autenticación y métodos de petición estándar (HTTP verbs).


Nota aclaratoria:
En los ejemplos que se muestran en este documento se ha utilizado como URL de acceso a la API los siguientes parámetros:

URL de acceso a la API https://demo.prevengos.com/PrevengosAPI
Usuario de acceso a la API usuario
Password de acceso a la API password


Estos parámetros variarán en función del proveedor

Para probar el correcto funcionamiento de la API debe consumir alguna de las funciones disponibles (por ejemplo, la que obtiene la versión):
https://demo.prevengos.com/PrevengosAPI/api/version


Las respuestas y las solicitudes se realizarán en formato JSON o XML (siendo JSON el formato por defecto). En el caso de querer operar con XML, deberá llamar a la URI correspondiente para operar en este formato.

Ponemos también a su disposición un proyecto de ejemplo de consumo de esta API realizado en C#.

2. Autenticación

La autenticación de la API se realiza mediante HTTP Basic Auth. Deberá proporcionar sus credenciales en cada petición que realice a la API. Para proteger estas credenciales, todas las solicitudes a la API deben hacerse a través de HTTPS.

3. Errores

La API de Prevengos utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. En general:

  • Los códigos 2xx indican éxito.
  • Los códigos 4xx indican un error que falló por alguna razón (por ejemplo, parámetros mal indicados).
  • Los códigos 5xx indican un error interno de servidor. En este caso, deberá consultar los ficheros de Log para conocer qué error ha sucedido.
Códigos HTTP
200 - OK La solicitud se ha procesado con éxito
201 – Created El registro se ha creado correctamente
204 – No content La solicitud ha ido correctamente, pero no devuelve resultados
400 – Bad request La solicitud es inaceptable. A menudo es por falta de un parámetro requerido, o por un valor no válido.
401 – Unauthorized Credenciales no válidas
403 – Forbidden El usuario proporcionado no tiene permisos para realizar la solicitud
404 – Not found El recurso solicitado no existe
422 – Unprocesable Entity La petición está bien formada pero los datos no equivalen a lo solicitado según este manual
423 – Locked El recurso está bloqueado en este momento. Esto puede deberse a que esté desactivado o en uso por otro usuario
5xx – Errores de servidor Algo ha ido mal en la parte del servidor. En este caso, deberá contactar con el administrador que le proporciona el acceso a la API para subsanar este problema.

 

4. Operaciones de la API

Obtener versión

GET

Media Type URI
URI application/json
/api/version
URI application/xml
/api/xml/version

Devuelve la versión de Prevengos actualmente instalada

Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

String

Versión de la API que se está consumiendo

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/version


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
"PREVENGOS R24C01 - Prevengos Web API"


application/xml
GET ... /api/xml/version


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">PREVENGOS R24C01 - Prevengos Web API</string>

 

Importar fichero Xml

POST

Media Type URI
URI application/json
/api/importar?fichero={fileName}
URI application/xml
/api/xml/importar?fichero={fileName}

Llama al sistema de importación XML que dispone Prevengos.
En el cuerpo del mensaje deberá ir el fichero a importar en binario (application/octet-stream).

Seguridad (permisos necesarios del usuario autenticado)

  • Importación de datos XML

Además de tener permiso para ejecutar este método, el usuario autenticado deberá tener permiso de acceso a todas las empresas

Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

fichero: string

Nombre del fichero que se envía en el body (con extensión)

Cuerpo (body)

application/octet-stream

Fichero que desea importar en binario

Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

Type: object

result: Boolean

Resultado de la importación del fichero: 0: No importado, 1: Importado

message: String

En caso de no haber realizado la importación, devuelve el texto del error

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/importar/fichero=ficheroEjemplo.xml


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

application/octet-stream
Respuesta
{ "result": 0, "message": "La empresa con CIF 'A12345678' no existe" }


application/xml
POST ... /api/xml/importar/fichero=ficheroEjemplo.xml


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

application/octet-stream
Respuesta
<datos xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <result>0</result> <message>La empresa con CIF 'A12345678' no existe</message> </datos>

 

Descargar documento de Prevengos

GET

Media Type URI
URI application/json
/api/documento/{id}
URI application/xml
/api/xml/documento/{id}

Descarga el fichero solicitado por parámetro.
En el cuerpo del mensaje irá el fichero en binario (application/octet-stream).

Seguridad (permisos necesarios del usuario autenticado)

  • Descargar documento de Prevengos

Además de tener permiso para ejecutar este método, el usuario autenticado deberá poder acceder al objeto propietario del documento

Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: string

Identificador único del documento en Prevengos

Cuerpo (body)

application/octet-stream

Fichero que desea importar en binario

Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

application/octet-stream

Fichero en binario

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

El documento con el id indicado no existe o el fichero físico no se encuentra

501 Not Implemented

El administrador del servidor no ha definido las rutas o no son visibles por el servicio actualmente. Póngase en contacto con el administrador para solucionar este problema.

 

Ejemplos

application/json
GET ... /api/documento/4690556B0F607B054A9F5342254D502E56DF171D70131C7310


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
application/octet-stream


application/xml
GET ... /api/xml/documento/4690556B0F607B054A9F5342254D502E56DF171D70131C7310


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
application/octet-stream

 

Mantenimientos. Clínicas concertadas (listado)

GET

Media Type URI
URI application/json
/api/mantenimientos/clinicas?estado={estado}
URI application/xml
/api/xml/mantenimientos/clinicas?estado={estado}

Devuelve el mantenimiento de clínicas o centros médicos

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

estado (opcional): Integer

Permite filtrar por el estado de la clínica

  • 0 – todas (de alta y de baja)
  • 1 – sólo de alta (valor por defecto)
  • 2 – sólo de baja

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de clínicas o centros médicos que cumplen con el filtro

Type: item

key: String

Identificador único de la clínica en Prevengos

codigo: String

Código de la clínica

cif: String

CIF de la clínica

clinica: String

Nombre de la clínica

localidad: String

Localidad de la clínica

provincia: String

Provincia de la clínica

desactivada: Boolean

Indica si la clínica está desactivada

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/mantenimientos/clinicas


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "codigo": "00013", "cif": "B12345679", "clinica": "CLÍNICA MURCIA", "localidad": "MURCIA", "provincia": "MURCIA", "desactivada": false }, { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4", "codigo": "00010", "cif": "B11111111", "clinica": "CLÍNICA CARTAGENA", "localidad": "CARTAGENA", "provincia": "MURCIA", "desactivada": false } ] }


application/xml
GET ... /api/xml/mantenimientos/clinicas


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MTEN_ClinicasConcertadas_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <codigo>00013</codigo> <cif>B12345679</cif> <clinica>CLÍNICA MURCIA</clinica> <localidad>MURCIA</localidad> <provincia>MURCIA</provincia> <desactivada>false</desactivada> </item> <item> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4</key> <codigo>00010</codigo> <cif>B11111111</cif> <clinica>CLÍNICA CARTAGENA</clinica> <localidad>CARTAGENA</localidad> <provincia>MURCIA</provincia> <desactivada>false</desactivada> </item> </result> </MTEN_ClinicasConcertadas_ListadoResponse>

 

Mantenimientos. Clínicas concertadas (buscar)

POST

Media Type URI
URI application/json
/api/mantenimientos/clinicas/buscar
URI application/xml
/api/xml/mantenimientos/clinicas/buscar

Devuelve las clínicas concertadas o centros médicos que cumplen con el filtro

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

field: Enum

Campo por el que se va a buscar la clínica

  • key – buscará la clínica que coincida con el key indicado
  • codigo – buscará cualquier clínica que contenga el texto en el código
  • cif – buscará cualquier clínica que contenga el texto en el cif
  • nombre – buscará cualquier clínica que contenga el texto en el nombre
  • localidad – buscará cualquier clínica que contenga el texto en la localidad
  • provincia – buscará cualquier clínica que contenga el texto en la provincia
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de clínicas o centros médicos que cumplen con el filtro

Type: item

key: String

Identificador único de la clínica en Prevengos

codigo: String

Código de la clínica

cif: String

CIF de la clínica

clinica: String

Nombre de la clínica

localidad: String

Localidad de la clínica

provincia: String

Provincia de la clínica

desactivada: Boolean

Indica si la clínica está desactivada

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/mantenimientos/clinicas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "localidad", "value": "cartagena" }
Respuesta
{ "result": [ { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4", "codigo": "00010", "cif": "B11111111", "clinica": "CLÍNICA CARTAGENA", "localidad": "CARTAGENA", "provincia": "MURCIA", "desactivada": false } ] }


application/xml
POST ... /api/xml/mantenimientos/clinicas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MTEN_ClinicasConcertadas_Buscar> <field>localidad</field> <value>cartagena</value> </MTEN_ClinicasConcertadas_Buscar>
Respuesta
<MTEN_ClinicasConcertadas_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4</key> <codigo>00010</codigo> <cif>B11111111</cif> <clinica>CARTAGENA</clinica> <localidad>CARTAGENA</localidad> <provincia>MURCIA</provincia> <desactivada>false</desactivada> </item> </result> </MTEN_ClinicasConcertadas_BuscarResponse>

 

Mantenimientos. Lugar de la cita médica (listado)

GET

Media Type URI
URI application/json
/api/mantenimientos/localidades
URI application/xml
/api/xml/mantenimientos/localidades

Devuelve el mantenimiento de localidades o lugares de la cita médica

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

<Vacío>

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de localidades o lugares de la cita médica

Type: item

key: String

Identificador único de la localidad en Prevengos

elemento: String

Localidad o lugar de la cita médica

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/mantenimientos/localidades


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "469055632F40452D4C98474B255007701DCE", "elemento": "MURCIA" }, { "key": "469055632F40452D4C98474B255007701DCF", "elemento": "ALICANTE" } ] }


application/xml
GET ... /api/xml/mantenimientos/localidades


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MTEN_Localidades_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>469055632F40452D4C98474B255007701DCE</key> <elemento>MURCIA</elemento> </item> <item> <key>469055632F40452D4C98474B255007701DCF</key> <elemento>ALICANTE</elemento> </item> </result> </MTEN_Localidades_ListadoResponse>

 

Mantenimientos. Lugar de la cita médica (buscar)

POST

Media Type URI
URI application/json
/api/mantenimientos/localidades/buscar
URI application/xml
/api/xml/mantenimientos/localidades/buscar

Devuelve las localidades o lugares de las citas médicas que cumplen con el filtro

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

field: Enum

Campo por el que se va a buscar el médico

  • key – buscará el lugar de la cita que coincida con el key indicado
  • nombre – buscará cualquier localidad que contenga el texto
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de localidades que cumplen con el filtro

Type: item

key: String

Identificador único de la localidad en Prevengos

elemento: String

Localidad o lugar de la cita

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/mantenimientos/localidades/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "nombre", "value": "cieza" }
Respuesta
{ "result": [ { "key": "469055632F40452D4C98474B255007701DCE", "elemento": "MURCIA" } ] }


application/xml
POST ... /api/xml/mantenimientos/localidades/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MTEN_Localidades_Buscar> <field>nombre</field> <value>murcia</value> </MTEN_Localidades_Buscar>
Respuesta
<MTEN_Localidades_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>469055632F40452D4C98474B255007701DCE</key> <elemento>MURCIA</elemento> </item> </result> </MTEN_Localidades_BuscarResponse>

 

Mantenimientos. Médicos (listado)

GET

Media Type URI
URI application/json
/api/mantenimientos/medicos?clinica={clinica}&estado={estado}
URI application/xml
/api/xml/mantenimientos/medicos?clinica={clinica}&estado={estado}

Devuelve el mantenimiento de médicos

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

clinica (opcional): String

Permite filtrar por los médicos de la clínica o centro médico con el identificador único indicado

estado (opcional): Integer

Permite filtrar por el estado del médico

  • 0 – todos (de alta y de baja)
  • 1 – sólo de alta (valor por defecto)
  • 2 – sólo de baja

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de médicos que cumplen con el filtro

Type: item

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre completo del médico

desactivado: Boolean

Indica si el médico está desactivado

204 No Content

La petición se ha realizado correctamente, pero no existen médicos que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/mantenimientos/medicos


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "4690556225474D224A8F051C79", "numCol": "000000000", "nombre": "MEDICO1 APELLIDO APELLIDO2", "desactivado": false } ] }


application/xml
GET ... /api/xml/mantenimientos/medicos


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MTEN_Medicos_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556225474D224A8F051C79</key> <numCol>000000000</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> <desactivado>false</desactivado> </item> </result> </MTEN_Medicos_ListadoResponse>

 

Mantenimientos. Médicos (buscar)

POST

Media Type URI
URI application/json
/api/mantenimientos/medicos/buscar
URI application/xml
/api/xml/mantenimientos/medicos/buscar

Devuelve los médicos que cumplen con el filtro

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará el médico que coincida con el key indicado
  • keyclinica – buscará médicos de la clínica o centro médico con el identificador único indicado
  • numcol – buscará cualquier médico que contenga el texto en el nº de colegiado
  • nombre – buscará cualquier médico que contenga el texto en el nombre
  • estado – permite filtrar por el estado del médico
    • 0 – todos (de alta y de baja)
    • 1 – sólo de alta (valor por defecto)
    • 2 – sólo de baja
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de médicos que cumplen con el filtro

Type: item

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre completo del médico

desactivado: Boolean

Indica si el médico está desactivado

204 No Content

La petición se ha realizado correctamente, pero no existen médicos que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/mantenimientos/medicos/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "keyclinica","value": "4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4"}, {"field": "nombre","value": "MEDICO1"} ] }
Respuesta
{ "result": [ { "key": "4690556225474D224A8F051C79", "numCol": "000000000", "nombre": "MEDICO1 APELLIDO APELLIDO2", "desactivado": false } ] }


application/xml
POST ... /api/xml/mantenimientos/medicos/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MTEN_Medicos_Buscar> <filtros> <filtro> <field>keyclinica</field> <value>4690556C2C4A4A28469D556C2F4D47245788474B2150077015C4</value> </filtro> <filtro> <field>nombre</field> <value>MEDICO</value> </filtro> </filtros> </MTEN_Medicos_Buscar>
Respuesta
<MTEN_Medicos_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556225474D224A8F051C79</key> <numCol>000000000</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> <desactivado>false</desactivado> </item> </result> </MTEN_Medicos_BuscarResponse>

 

Mantenimientos. Estados de la cita médica (listado)

GET

Media Type URI
URI application/json
/api/mantenimientos/agenda-medica/estados
URI application/xml
/api/xml/mantenimientos/agenda-medica/estados

Devuelve el mantenimiento de estados de la cita médicas

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

<Vacío>

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de resultados

Type: item

key: String

Identificador único del estado de la cita médica en Prevengos

elemento: String

Estado de la cita médica

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/mantenimientos/agenda-medica/estados


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "46905579077C65264092424E055050204193654634420770", "elemento": "<Sin especificar>" } ] }


application/xml
GET ... /api/xml/mantenimientos/agenda-medica/estados


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MTEN_Medicina_EstadoCita_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>46905579077C65264092424E055050204193654634420770</key> <elemento>&lt;Sin especificar&gt;</elemento> </item> </result> </MTEN_Medicina_EstadoCita_ListadoResponse>

 

Mantenimientos. Estados de la cita médica (buscar)

POST

Media Type URI
URI application/json
/api/mantenimientos/agenda-medica/estados/buscar
URI application/xml
/api/xml/mantenimientos/agenda-medica/estados/buscar

Devuelve los estados de las citas médicas que cumplen con el filtro

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

field: Enum

Campo por el que se va a buscar el médico

  • key – buscará el estado de la cita que coincida con el key indicado
  • nombre – buscará cualquier estado que contenga el texto indicado
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de elementos que cumplen con el filtro

Type: item

key: String

Identificador único del estado de la cita médica en Prevengos

elemento: String

Estado de la cita médica

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/mantenimientos/agenda-medica/estados/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "nombre", "value": "sin especificar" }
Respuesta
{ "result": [ { "key": "46905579077C65264092424E055050204193654634420770", "elemento": "<Sin especificar>" } ] }


application/xml
POST ... /api/xml/mantenimientos/agenda-medica/estados/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MTEN_Medicina_EstadoCita_Buscar> <field>nombre</field> <value>sin especificar</value> </MTEN_Medicina_EstadoCita_Buscar>
Respuesta
<MTEN_Medicina_EstadoCita_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>46905579077C65264092424E055050204193654634420770</key> <elemento>&lt;Sin especificar&gt;</elemento> </item> </result> </MTEN_Medicina_EstadoCita_BuscarResponse>

 

Mantenimientos. Tipos de cita médica (listado)

GET

Media Type URI
URI application/json
/api/mantenimientos/agenda-medica/tipos
URI application/xml
/api/xml/mantenimientos/agenda-medica/tipos

Devuelve el mantenimiento de tipos de cita médicas

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

<Vacío>

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de tipos de citas médicas

Type: item

key: String

Identificador único del tipo de la cita médica en Prevengos

elemento: String

Tipo de cita médica

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/mantenimientos/agenda-medica/tipos


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "46905579077C65264092424E144A542E6695524E6310", "elemento": "NORMAL" }, { "key": "46905579077C65264092424E144A542E6695524E6312", "elemento": "REVISION" } ] }}


application/xml
GET ... /api/xml/mantenimientos/agenda-medica/tipos


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MTEN_Medicina_TipoCita_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>46905579077C65264092424E144A542E6695524E6310</key> <elemento>NORMAL</elemento> </item> <item> <key>46905579077C65264092424E144A542E6695524E6312</key> <elemento>REVISION</elemento> </item> </result> </MTEN_Medicina_TipoCita_ListadoResponse>

 

Mantenimientos. Tipos de cita médica (buscar)

POST

Media Type URI
URI application/json
/api/mantenimientos/agenda-medica/tipos/buscar
URI application/xml
/api/xml/mantenimientos/agenda-medica/tipos/buscar

Devuelve los tipos de citas médicas que cumplen con el filtro

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

field: Enum

Campo por el que se va a buscar el médico

  • key – buscará el tipo de cita que coincida con el key indicado
  • nombre – buscará cualquier tipo de cita que contenga el texto indicado
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de tipos que cumplen con el filtro

Type: item

key: String

Identificador único del tipo de cita médica en Prevengos

elemento: String

Tipo de cita médica

204 No Content

La petición se ha realizado correctamente, pero no existen registros que listar

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/mantenimientos/agenda-medica/tipos/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "nombre", "value": "NORMAL" }
Respuesta
{ "result": [ { "key": "46905579077C65264092424E144A542E6695524E6310", "elemento": "NORMAL" } ] }


application/xml
POST ... /api/xml/mantenimientos/agenda-medica/tipos/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MTEN_Medicina_TipoCita_Buscar> <field>nombre</field> <value>murcia</value> </MTEN_Medicina_TipoCita_Buscar>
Respuesta
<MTEN_Medicina_TipoCita_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>46905579077C65264092424E144A542E6695524E6310</key> <elemento>NORMAL</elemento> </item> </result> </MTEN_Medicina_TipoCita_BuscarResponse>

 

Empresas (listado)

GET

Media Type URI
URI application/json
/api/gestion/empresas?estado={estado}&modulo={modulo}&pag={pag}&regPorPag={regPorPag}
URI application/xml
/api/xml/gestion/empresas?estado={estado}&modulo={modulo}&pag={pag}&regPorPag={regPorPag}

Devuelve el listado de empresas que puede ver el usuario autenticado

Seguridad (permisos necesarios del usuario autenticado)

  • Listado de empresas (gestión general)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

estado (opcional): Integer

Permite filtrar por el estado de la empresa

  • 0 – todas (de alta y de baja)
  • 1 – sólo de alta (valor por defecto)
  • 2 – sólo de baja
modulo (opcional): String

Permite filtrar por las empresas que estén en algún módulo

  • (valor vacío) – cualquier módulo (valor por defecto)
  • prevencion – sólo empresas que estén en el módulo técnico
  • medicina – sólo empresas que estén en el módulo médico
  • cae – sólo empresas que estén en el módulo de coordinación
pag (opcional): Integer

Si se desea paginar el resultado, indica el nº de página que se desea obtener (valor por defecto: 0).

regPorPag (opcional): Integer

Si se desea paginar el resultado, indica el nº de registros por página.

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

page: Integer

Nº de página

numberOfPages: Integer

Nº de páginas totales

numberOfItems: Integer

Nº de empresas total del listado

itemsPerPage: Integer

Nº de empresas que hay en cada página

items: array (Of item)

Array de empresas que se están listando

Type: item

key: String

Identificador único de la empresa en Prevengos

codCliente: String

Código de cliente

sufijo: String

Sufijo de la empresa

cif: String

Cif de la empresa

nombre: String

Nombre de la empresa

nombreComercial: String

Nombre comercial de la empresa

respComercial: String

Nombre del responsable comercial de la empresa

respTecnico: String

Nombre del técnico responsable

respMedico: String

Nombre del responsable en vigilancia de la salud

respAdministrativo: String

Nombre del responsable administrativo

numTrabs: Integer

Nº de trabajadores indicados

fAltaPrev: Date

Fecha de alta en prevención

fAltaSalud: Date

Fecha de alta en vigilancia de la salud

bajaPrev: Boolean

Indica si la empresa está de baja en prevención

bajaSalud: Boolean

Indica si la empresa está de baja en vigilancia de la salud

cancelada: Boolean

Indica si la empresa está cancelada

grupoAct: String

Grupo de actividad

sectorEmp: String

Sector empresarial

colaboradorCif: String

Cif del colaborador

colaborador: String

Nombre del colaborador

dirPostal_Direccion: String

Dirección postal (domicilio)

dirPostal_Localidad: String

Dirección postal (localidad)

dirPostal_Provincia: String

Dirección postal (provincia)

dirPostal_CodPostal: String

Dirección postal (código postal)

dirFiscal_Direccion: String

Dirección fiscal (domicilio)

dirFiscal_Localidad: String

Dirección fiscal (localidad)

dirFiscal_Provincia: String

Dirección fiscal (provincia)

dirFiscal_CodPostal: String

Dirección fiscal (código postal)

telefono1: String

Teléfono 1

telefono2: String

Teléfono 2

fax: String

Fax

email: String

Email

personaContacto: String

Persona de contacto principal de la empresa

representante: String

Nombre del representante

representanteDni: String

Dni del representante

numSS: String

Número de la seguridad social

204 No content

La petición se ha realizado correctamente pero no existe ninguna empresa que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/gestion/empresas?pag=1&regPorPag=2


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "page": 1, "numberOfPages": 25, "numberOfItems": 50, "itemsPerPage": 2, "items": [ { "key": "4690556A2D535624569D550C71171D741C", "codCliente": "0000115421", "sufijo": "", "cif": "B12345678", "nombre": "EMPRESA SL", "nombreComercial": "SERVICIOS INTEGRALES", "respComercial": "", "respTecnico": "TECNICO APELLIDO1 APELLIDO2", "respMedico": "", "respAdministrativo": "", "numTrabs": 0, "fAltaPrev": "/Date(-2208992400000+0100)/", "fAltaSalud": "/Date(567990000000+0100)/", "bajaPrev": false, "bajaSalud": false, "cancelada": false, "grupoAct": "", "sectorEmp": "", "colaboradorCif": "", "colaborador": "", "dirPostal_Direccion": "C/ DOMICILIO, 45", "dirPostal_Localidad": "MURCIA", "dirPostal_Provincia": "MURCIA", "dirPostal_CodPostal": "30001", "dirFiscal_Direccion": "C/ DOMICILIO, 45", "dirFiscal_Localidad": "MURCIA", "dirFiscal_Provincia": "MURCIA", "dirFiscal_CodPostal": "30001", "telefono1": "", "telefono2": "", "fax": "", "email": "", "personaContacto": "", "representante": "", "representanteDni": "", "numSS": "" }, { "key": "4690556A2D535624569D550C7111137215", "codCliente": "000044421", "sufijo": "", "cif": "B14455668", "nombre": "OBRAS, S.L.", "nombreComercial": "", "respComercial": "COMERCIAL APELLIDO1 APELLIDO2", "respTecnico": "TECNICO APELLIDO1 APELLIDO2", "respMedico": "MEDICO APELLIDO1 APELLIDO2", "respAdministrativo": "", "numTrabs": 7, "fAltaPrev": "/Date(1580684400000+0100)/", "fAltaSalud": "/Date(1580684400000+0100)/", "bajaPrev": false, "bajaSalud": false, "cancelada": false, "grupoAct": "CONSTRUCCION", "sectorEmp": "SECTOR INDUSTRIAL", "colaboradorCif": "B22558877", "colaborador": "COLABORADOR SL", "dirPostal_Direccion": "C/ DIRECCION POSTAL, Nº 4, 3º B", "dirPostal_Localidad": "SAN GINÉS", "dirPostal_Provincia": "MURCIA", "dirPostal_CodPostal": "30169", "dirFiscal_Direccion": "C/ DIRECCION POSTAL, Nº 4, 3º B", "dirFiscal_Localidad": "SAN GINÉS", "dirFiscal_Provincia": "MURCIA", "dirFiscal_CodPostal": "30169", "telefono1": "", "telefono2": "", "fax": "", "email": "email@email.es", "personaContacto": "", "representante": "EJEMPLO APELLIDO1 APELLIDO2", "representanteDni": "12345678Z", "numSS": "" } ] }


application/xml
GET ... /api/xml/gestion/empresas?pag=1&regPorPag=2


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<datos xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <page>1</page> <numberOfPages>25</numberOfPages> <numberOfItems>50</numberOfItems> <itemsPerPage>2</itemsPerPage> <items> <item> <key>4690556A2D535624569D550C71171D741C</key> <codCliente>0000115421</codCliente> <sufijo/> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> <nombreComercial>SERVICIOS INTEGRALES</nombreComercial> <respComercial/> <respTecnico>TECNICO APELLIDO1 APELLIDO2</respTecnico> <respMedico/> <respAdministrativo/> <numTrabs>0</numTrabs> <fAltaPrev>1900-01-01T00:00:00</fAltaPrev> <fAltaSalud>1988-01-01T00:00:00</fAltaSalud> <bajaPrev>false</bajaPrev> <bajaSalud>false</bajaSalud> <cancelada>false</cancelada> <grupoAct/> <sectorEmp/> <colaboradorCif/> <colaborador/> <dirPostal_Direccion>C/ DOMICILIO, 45</dirPostal_Direccion> <dirPostal_Localidad>MURCIA</dirPostal_Localidad> <dirPostal_Provincia>MURCIA</dirPostal_Provincia> <dirPostal_CodPostal>30001</dirPostal_CodPostal> <dirFiscal_Direccion>C/ DOMICILIO, 45</dirFiscal_Direccion> <dirFiscal_Localidad>MURCIA</dirFiscal_Localidad> <dirFiscal_Provincia>MURCIA</dirFiscal_Provincia> <dirFiscal_CodPostal>30001</dirFiscal_CodPostal> <telefono1/> <telefono2/> <fax/> <email/> <personaContacto/> <representante/> <representanteDni/> <numSS/> </item> <item> <key>4690556A2D535624569D550C7111137215</key> <codCliente>000044421</codCliente> <sufijo/> <cif>B14455668</cif> <nombre>OBRAS, S.L.</nombre> <nombreComercial/> <respComercial>COMERCIAL APELLIDO1 APELLIDO2</respComercial> <respTecnico>TECNICO APELLIDO1 APELLIDO2</respTecnico> <respMedico>MEDICO APELLIDO1 APELLIDO2</respMedico> <respAdministrativo/> <numTrabs>7</numTrabs> <fAltaPrev>2020-02-03T00:00:00</fAltaPrev> <fAltaSalud>2020-02-03T00:00:00</fAltaSalud> <bajaPrev>false</bajaPrev> <bajaSalud>false</bajaSalud> <cancelada>false</cancelada> <grupoAct>CONSTRUCCION</grupoAct> <sectorEmp>SECTOR INDUSTRIAL</sectorEmp> <colaboradorCif>B22558877</colaboradorCif> <colaborador>COLABORADOR SL</colaborador> <dirPostal_Direccion>C/ DIRECCION POSTAL, Nº 4, 3º B</dirPostal_Direccion> <dirPostal_Localidad>SAN GINÉS</dirPostal_Localidad> <dirPostal_Provincia>MURCIA</dirPostal_Provincia> <dirPostal_CodPostal>30169</dirPostal_CodPostal> <dirFiscal_Direccion>C/ DIRECCION POSTAL, Nº 4, 3º B</dirFiscal_Direccion> <dirFiscal_Localidad>SAN GINÉS</dirFiscal_Localidad> <dirFiscal_Provincia>MURCIA</dirFiscal_Provincia> <dirFiscal_CodPostal>30169</dirFiscal_CodPostal> <telefono1/> <telefono2/> <fax/> <email>email@email.es</email> <personaContacto/> <representante>EJEMPLO APELLIDO1 APELLIDO2</representante> <representanteDni>12345678Z</representanteDni> <numSS/> </item> </items> </datos>

 

Empresas (buscar)

POST

Media Type URI
URI application/json
/api/gestion/empresas/buscar
URI application/xml
/api/xml/gestion/empresas/buscar

Devuelve el listado de empresas que coincidan con el filtro

Seguridad (el usuario autenticado necesita, al menos, algún permiso de la lista)

  • Listado de empresas (gestión general)
  • Ficha de datos de una empresa (gestión general)
  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará la empresa que coincida con el key indicado
  • cif – buscará la empresa que coincida con el cif indicado
  • nombre – buscará cualquier empresa que contenga el texto en el nombre
  • codigo – buscará cualquier empresa que contenga el texto en el código
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de empresas que coinciden con el filtro

Type: item

key: String

Identificador único de la empresa en Prevengos

codCliente: String

Código de cliente

cif: String

Cif de la empresa

nombre: String

Nombre de la empresa

204 No Content

La petición se ha realizado correctamente, pero no existen empresas que cumplan con el filtro indicado

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/gestion/empresas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "cif","value": "B12345678"} ] }
Respuesta
{ "result": [ { "key": "4690556A2D535624569D550C71171D741C", "codCliente": "0000115421", "cif": "B12345678", "nombre": "EMPRESA SL" } ] }


application/xml
POST ... /api/xml/gestion/empresas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_Empresas_Buscar> <filtros> <filtro> <field>cif</field> <value>B12345678</value> </filtro> </filtros> </GENERAL_Empresas_Buscar>
Respuesta
<GENERAL_Empresas_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556A2D535624569D550C71171D741C</key> <codCliente>0000115421</codCliente> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </item> </result> </GENERAL_Empresas_BuscarResponse>

 

Empresa. Ficha de datos

GET

Media Type URI
URI application/json
/api/gestion/empresa/{id}
URI application/xml
/api/xml/gestion/empresa/{id}

Devuelve la ficha de datos completa de la empresa

Seguridad (permisos necesarios del usuario autenticado)

  • Ficha de datos de la empresa (gestión general)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: Empresa

Datos de la empresa

Type: Empresa

key: String

Identificador único de la empresa en Prevengos

codCliente: String

Código de cliente

cif: String

Cif de la empresa

empresa: String

Nombre de la empresa

centros: array (Of centro)

Centros de trabajo de la empresa (activos)

trabajadores: array (Of trabajador)

Trabajadores de la empresa (activos)

Type: centro

key: String

Identificador único del centro en Prevengos

referencia: String

Referencia

nombre: String

Nombre del centro

numTrabs: Integer

Nº de trabajadores indicados en el centro

direccion: String

Dirección postal del centro

localidad: String

Localidad del centro

provincia: String

Provincia del centro

codPostal: String

Código postal del centro

telefono1: String

Teléfono 1 del centro

telefono2: String

Teléfono 2 del centro

fax: String

Fax del centro

email: String

Email indicado en la ficha del centro

cancelado: Boolean

Indica si el centro está cancelado

Type: trabajador

key: String

Identificador único del trabajador en Prevengos

dni: String

DNI del trabajador

identificador: String

Identificador externo del trabajador en otros sistemas

nombre: String

Nombre del trabajador

puestoRef: String

Referencia del puesto de trabajo

puesto: String

Puesto preventivo del trabajador

sexo: Enum

Sexo del trabajador

  • <Vacío> – No indicado
  • H – Hombre
  • M – Mujer
direccion: String

Domicilio del trabajador

localidad: String

Domicilio del trabajador (localidad)

provincia: String

Domicilio del trabajador (provincia)

codPostal: String

Domicilio del trabajador (código postal)

pais: String

Domicilio del trabajador (país)

telefono1: String

Teléfono 1

telefono2: String

Teléfono 2

email: String

Email indicado en la ficha del centro

fechaNac: Date

Fecha de nacimiento del trabajador

fechaAnt: Date

Fecha de antigüedad

baja: Boolean

Indica si el trabajador está desactivado

fechaBaja: Date

Indica la fecha en la que se dió de baja el trabajador en la empresa

centroPrincipal: centroPrincipal

Indica los datos del centro asignado al trabajador

Type: centroPrincipal

key: String

Identificador único del centro en Prevengos

referencia: String

Referencia

nombre: String

Nombre del centro

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
GET ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": { "key": "4690556A2D535624569D550C71171D741C", "codCliente": "000011542", "cif": "B12345678", "empresa": "EMPRESA SL", "centros": [ { "key": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "referencia": "000011542-C1", "nombre": "EMPRESA SL", "numTrabs": 0, "direccion": "C\\DOMICILIO, 3", "localidad": "MURCIA", "provincia": "MURCIA", "codPostal": "30001", "telefono1": "", "telefono2": "", "fax": "", "email": "", "cancelado": false } ], "trabajadores": [ { "key": "4690557B324246204F9D42403246576214C81F1A790015", "dni": "12345678A", "identificador": "", "nombre": "TRABAJADOR 1", "puestoRef": "", "puesto": "Administrativo", "sexo": "H", "direccion": "", "localidad": "", "provincia": "", "codPostal": "", "pais": "España", "telefono1": "", "telefono2": "", "email": "", "fechaNac": "/Date(-3600000+0100)/", "fechaAnt": "/Date(1689199200000+0200)/", "baja": false, "fechaBaja": "/Date(1702249200000+0100)/", "centroPrincipal": { "key": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "referencia": "000011542-C1", "nombre": "EMPRESA SL" } } ] } }


application/xml
GET ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<Gestion_Empresas_Ficha_GET_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <key>4690556A2D535624569D550C71171D741C</key> <codCliente>000011542</codCliente> <cif>B12345678</cif> <empresa>EMPRESA SL</empresa> <centros> <centro> <key>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</key> <referencia>000011542-C1</referencia> <nombre>EMPRESA SL</nombre> <numTrabs>0</numTrabs> <direccion>C\DOMICILIO, 3</direccion> <localidad>MURCIA</localidad> <provincia>MURCIA</provincia> <codPostal>30001</codPostal> <telefono1/> <telefono2/> <fax/> <email/> <cancelado>false</cancelado> </centro> </centros> <trabajadores> <trabajador> <key>4690557B324246204F9D42403246576214C81F1A790015</key> <dni>12345678A</dni> <identificador/> <nombre>TRABAJADOR 1</nombre> <puestoRef/> <puesto>Administrativo</puesto> <sexo>H</sexo> <direccion/> <localidad/> <provincia/> <codPostal/> <pais>España</pais> <telefono1/> <telefono2/> <email/> <fechaNac>1970-01-01T00:00:00</fechaNac> <fechaAnt>2023-07-13T00:00:00</fechaAnt> <baja>false</baja> <fechaBaja>2023-12-11T00:00:00</fechaBaja> <centroPrincipal> <key>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</key> <referencia>000011542-C1</referencia> <nombre>EMPRESA SL</nombre> </centroPrincipal> </trabajador> </trabajadores> </result> </Gestion_Empresas_Ficha_GET_XMLResponse>

 

Empresa. Centros de trabajo (listado)

GET

Media Type URI
URI application/json
/api/gestion/empresa/{id}/centros?estado={estado}
URI application/xml
/api/xml/gestion/empresa/{id}/centros?estado={estado}

Devuelve el listado de centros de trabajo de la empresa

Seguridad (permisos necesarios del usuario autenticado)

  • Ficha de datos de la empresa (gestión general)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

estado (opcional): Integer

Permite filtrar por el estado del centro de trabajo en la empresa

  • 0 – todos (de alta y de baja)
  • 1 – sólo de alta (valor por defecto)
  • 2 – sólo de baja
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of centro)

Type: centro

key: String

Identificador único del centro en Prevengos

referencia: String

Referencia

nombre: String

Nombre del centro

numTrabs: Integer

Nº de trabajadores indicados en el centro

direccion: String

Dirección postal del centro

localidad: String

Localidad del centro

provincia: String

Provincia del centro

codPostal: String

Código postal del centro

telefono1: String

Teléfono 1 del centro

telefono2: String

Teléfono 2 del centro

fax: String

Fax del centro

email: String

Email indicado en la ficha del centro

cancelado: Boolean

Indica si el centro está cancelado

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
GET ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C/centros


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
[ { "key": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "referencia": "000011542-C1", "nombre": "EMPRESA SL", "numTrabs": 0, "direccion": "C\\DOMICILIO, 3", "localidad": "MURCIA", "provincia": "MURCIA", "codPostal": "30001", "telefono1": "", "telefono2": "", "fax": "", "email": "", "cancelado": false } ]


application/xml
GET ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/centros


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<ArrayOfcentro xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <centro> <key>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</key> <referencia>000011542-C1</referencia> <nombre>EMPRESA SL</nombre> <numTrabs>0</numTrabs> <direccion>C\DOMICILIO, 3</direccion> <localidad>MURCIA</localidad> <provincia>MURCIA</provincia> <codPostal>30001</codPostal> <telefono1/> <telefono2/> <fax/> <email/> <cancelado>false</cancelado> </centro> </ArrayOfcentro>

 

Empresa. Centros de trabajo (buscar)

POST

Media Type URI
URI application/json
/api/gestion/empresa/{id}/centros/buscar
URI application/xml
/api/xml/gestion/empresa/{id}/centros/buscar

Devuelve el listado de centros de la empresa que coincidan con el filtro

Seguridad (el usuario autenticado necesita, al menos, algún permiso de la lista)

  • Ficha de datos de una empresa (gestión general)
  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

Cuerpo (body)

field: Enum

Campo por el que se va a buscar el centro de trabajo en la empresa

  • key – buscará el centro que coincida con el key indicado
  • ref – buscará cualquier centro que contenga el texto en la referencia
  • nombre – buscará cualquier centro que contenga el texto en el nombre
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de centros de la empresa que cumplen con el filtro

Type: item

key: String

Identificador único del centro en Prevengos

keyEmp: String

Identificador único de la empresa en Prevengos

referencia: String

Referencia del centro

nombre: String

Nombre del centro de trabajo

empresa: String

Nombre de la empresa a la que pertenece el centro de trabajo

localidad: String

Localidad del centro de trabajo

provincia: String

Provincia del centro de trabajo

204 No Content

La petición se ha realizado correctamente, pero no existen centros en la empresa que cumplan con el filtro indicado

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
POST ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C/centros/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "ref", "value": "000011542" }
Respuesta
{ "result": [ { "key": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "keyEmp": "4690556A2D535624569D550C71171D741C", "referencia": "000011542-C1", "nombre": "EMPRESA SL", "empresa": "EMPRESA SL", "localidad": "MURCIA", "provincia": "MURCIA" } ] }


application/xml
POST ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/centros/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_FichaEmpresa_Centros_Buscar> <field>ref</field> <value>000011542</value> </GENERAL_FichaEmpresa_Centros_Buscar>
Respuesta
<GENERAL_FichaEmpresa_Centros_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</key> <keyEmp>4690556A2D535624569D550C71171D741C</keyEmp> <referencia>000011542-C1</referencia> <nombre>EMPRESA SL</nombre> <empresa>EMPRESA SL</empresa> <localidad>MURCIA</localidad> <provincia>MURCIA</provincia> </item> </result> </GENERAL_FichaEmpresa_Centros_BuscarResponse>

 

Empresa. Trabajadores (listado)

GET

Media Type URI
URI application/json
/api/gestion/empresa/{id}/trabs?estado={estado}
URI application/xml
/api/xml/gestion/empresa/{id}/trabs?estado={estado}

Devuelve el listado de trabajadores indicados en la empresa

Seguridad (permisos necesarios del usuario autenticado)

  • Ficha de datos de la empresa (gestión general)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

estado (opcional): Integer

Permite filtrar por el estado del trabajador en la empresa

  • 0 – todos (de alta y de baja)
  • 1 – sólo de alta (valor por defecto)
  • 2 – sólo de baja
Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of trabajador)

Type: trabajador

key: String

Identificador único del trabajador en Prevengos

dni: String

DNI del trabajador

identificador: String

Identificador externo del trabajador en otros sistemas

nombre: String

Nombre del trabajador

puestoRef: String

Referencia del puesto de trabajo

puesto: String

Puesto preventivo del trabajador

sexo: Enum

Sexo del trabajador

  • <Vacío> – No indicado
  • H – Hombre
  • M – Mujer
direccion: String

Domicilio del trabajador

localidad: String

Domicilio del trabajador (localidad)

provincia: String

Domicilio del trabajador (provincia)

codPostal: String

Domicilio del trabajador (código postal)

pais: String

Domicilio del trabajador (país)

telefono1: String

Teléfono 1

telefono2: String

Teléfono 2

email: String

Email indicado en la ficha del centro

fechaNac: Date

Fecha de nacimiento del trabajador

fechaAnt: Date

Fecha de antigüedad

baja: Boolean

Indica si el trabajador está desactivado

fechaBaja: Date

Indica la fecha en la que se dió de baja el trabajador en la empresa

centroPrincipal: centroPrincipal

Indica los datos del centro asignado al trabajador

Type: centroPrincipal

key: String

Identificador único del centro en Prevengos

referencia: String

Referencia

nombre: String

Nombre del centro

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
GET ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
[ { "key": "4690557B324246204F9D42403246576214C81F1A790015", "dni": "12345678A", "identificador": "", "nombre": "TRABAJADOR 1", "puestoRef": "", "puesto": "Administrativo", "sexo": "H", "direccion": "", "localidad": "", "provincia": "", "codPostal": "", "pais": "España", "telefono1": "", "telefono2": "", "email": "", "fechaNac": "/Date(-3600000+0100)/", "fechaAnt": "/Date(1689199200000+0200)/", "baja": false, "fechaBaja": "/Date(1702249200000+0100)/", "centroPrincipal": { "key": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "referencia": "000011542-C1", "nombre": "EMPRESA SL" } } ]


application/xml
GET ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<ArrayOftrabajador xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <trabajador> <key>4690557B324246204F9D42403246576214C81F1A790015</key> <dni>12345678A</dni> <identificador/> <nombre>TRABAJADOR 1</nombre> <puestoRef/> <puesto>Administrativo</puesto> <sexo>H</sexo> <direccion/> <localidad/> <provincia/> <codPostal/> <pais>España</pais> <telefono1/> <telefono2/> <email/> <fechaNac>1970-01-01T00:00:00</fechaNac> <fechaAnt>2023-07-13T00:00:00</fechaAnt> <baja>false</baja> <fechaBaja>2023-12-11T00:00:00</fechaBaja> <centroPrincipal> <key>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</key> <referencia>000011542-C1</referencia> <nombre>EMPRESA SL</nombre> </centroPrincipal> </trabajador> </ArrayOftrabajador>

 

Empresa. Trabajadores (buscar)

POST

Media Type URI
URI application/json
/api/gestion/empresa/{id}/trabs/buscar
URI application/xml
/api/xml/gestion/empresa/{id}/trabs/buscar

Devuelve el listado de trabajadores de la empresa que coincidan con el filtro

Seguridad (el usuario autenticado necesita, al menos, algún permiso de la lista)

  • Ficha de datos de una empresa (gestión general)
  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

Cuerpo (body)

field: Enum

Campo por el que se va a buscar el trabajador

  • key – buscará el trabajador que coincida con el key indicado
  • dni – buscará el trabajador que coincida con el dni indicado
  • ref – buscará el trabajador que coincida con el identificador indicado
  • nombre – buscará cualquier trabajador que contenga el texto en el nombre
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de trabajadores que cumplen con el filtro

Type: item

key: String

Identificador único del trabajador en Prevengos

keyEmp: String

Identificador único de la empresa en Prevengos

keyCentroPpal: String

Identificador único del centro principal del trabajador en Prevengos

dni: String

Dni del trabajador

nombre: String

Nombre completo del trabajador

empresa: String

Nombre de la empresa

centroPpal: String

Nombre del centro principal del trabajador

204 No Content

La petición se ha realizado correctamente, pero no existen trabajadores en la empresa que cumplan con el filtro indicado

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
POST ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C/trabs/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "field": "dni", "value": "12345678A" }
Respuesta
{ "result": [ { "key": "4690557B324246204F9D42403246576214C81F1A790015", "keyEmp": "4690556A2D535624569D550C71171D741C", "keyCentroPpal": "4690556C254D50334A8F725D2141452B4ADF171B79161D6214", "dni": "12345678A", "nombre": "TRABAJADOR 1", "empresa": "EMPRESA SL", "centroPpal": "EMPRESA SL" } ] }


application/xml
POST ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/trabs/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_FichaEmpresa_Trabs_Buscar> <field>dni</field> <value>12345678A</value> </GENERAL_FichaEmpresa_Trabs_Buscar>
Respuesta
<GENERAL_FichaEmpresa_Trabs_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690557B324246204F9D42403246576214C81F1A790015</key> <keyEmp>4690556A2D535624569D550C71171D741C</keyEmp> <keyCentroPpal>4690556C254D50334A8F725D2141452B4ADF171B79161D6214</keyCentroPpal> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <empresa>EMPRESA SL</empresa> <centroPpal>EMPRESA SL</centroPpal> </item> </result> </GENERAL_FichaEmpresa_Trabs_BuscarResponse>

 

Empresa. Datos registrados en un periodo

POST

Media Type URI
URI application/json
/api/gestion/empresa/{id}/inf/produccion
URI application/xml
/api/xml/gestion/empresa/{id}/inf/produccion

Devuelve el nº de datos registrados en un periodo de tiempo en la empresa.

Listado de datos que se pueden recuperar:

  • Nº de planes de prevención
  • Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • Nº de evaluaciones de seguridad
  • Nº de evaluaciones de higiene
  • Nº de evaluaciones de ergonomía
  • Nº de evaluaciones psicosociales
  • Nº de planes de emergencia
  • Nº de simulacros realizados
  • Nº de autorizaciones de trabajo
  • Nº de partes de inspección (de tipo visita)
  • Nº de partes de inspección (que no sean de tipo visita)
  • Nº de cursos de formación
  • Nº de trabajadores formados
  • Nº de reconocimientos abiertos
  • Nº de reconocimientos cerrados
  • Nº de reconocimientos renunciados
  • Nº de reconocimientos abiertos (iniciales)
  • Nº de reconocimientos cerrados (iniciales)
  • Nº de reconocimientos renunciados (iniciales)
  • Nº de reconocimientos abiertos (periódicos)
  • Nº de reconocimientos cerrados (periódicos)
  • Nº de reconocimientos renunciados (periódicos)
  • Nº de reconocimientos abiertos (tras ausencia prolongada)
  • Nº de reconocimientos cerrados (tras ausencia prolongada)
  • Nº de reconocimientos renunciados (tras ausencia prolongada)
  • Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • Nº de consultas médicas asistenciales
  • Nº de vacunas administradas (por tipo)
  • Nº de serologías administradas (por tipo)
  • Nº de accidentes cerrados
  • Nº de incidentes cerrados
  • Nº de accidentes biológicos cerrados
  • Nº de no conformidades cerradas
  • Nº de incidencias cerradas
  • Nº de actividades PAA médicas realizadas
  • Nº de actividades PAA técnicas realizadas
  • Nº de medidas de la acción preventiva implantadas

Seguridad (permisos necesarios del usuario autenticado)

  • Datos registrados en la aplicación en un periodo
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la empresa en Prevengos

Cuerpo (body)

ini (opcional): Date

Fecha de inicio que quiere consultar (formato yyyy-MM-dd)

fin (opcional): Date

Fecha de fin que quiere consultar (formato yyyy-MM-dd)

campos: String

Nombre de los campos que desea obtener (separados por comas)

  • numPlanPrev – Nº de planes de prevención
  • numEV – Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • numEV_Seg – Nº de evaluaciones de seguridad
  • numEV_Hig – Nº de evaluaciones de higiene
  • numEV_Erg – Nº de evaluaciones de ergonomía
  • numEV_Psi – Nº de evaluaciones psicosociales
  • numPlanEmer – Nº de planes de emergencia
  • numSimulacros – Nº de simulacros realizados
  • numAutorizaciones – Nº de autorizaciones de trabajo
  • numPartesInsVisita – Nº de partes de inspección (de tipo visita)
  • numPartesInsNoVisita – Nº de partes de inspección (que no sean de tipo visita)
  • numCursos – Nº de cursos de formación
  • numTrabsFormados – Nº de trabajadores formados
  • numRec_Abiertos – Nº de reconocimientos abiertos
  • numRec_Cerrados – Nº de reconocimientos cerrados
  • numRec_Renuncias – Nº de reconocimientos renunciados
  • numRecIni_Abiertos – Nº de reconocimientos abiertos (iniciales)
  • numRecIni_Cerrados – Nº de reconocimientos cerrados (iniciales)
  • numRecIni_Renuncias – Nº de reconocimientos renunciados (iniciales)
  • numRecPer_Abiertos – Nº de reconocimientos abiertos (periódicos)
  • numRecPer_Cerrados – Nº de reconocimientos cerrados (periódicos)
  • numRecPer_Renuncias – Nº de reconocimientos renunciados (periódicos)
  • numRecAus_Abiertos – Nº de reconocimientos abiertos (tras ausencia prolongada)
  • numRecAus_Cerrados – Nº de reconocimientos cerrados (tras ausencia prolongada)
  • numRecAus_Renuncias – Nº de reconocimientos renunciados (tras ausencia prolongada)
  • numRecTareas_Abiertos – Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • numRecTareas_Cerrados – Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • numRecTareas_Renuncias – Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • numConsultasMed – Nº de consultas médicas asistenciales
  • numVacunas – Nº de vacunas administradas (por tipo) *
  • numSerologias – Nº de serologías administradas (por tipo) *
  • numAcc – Nº de accidentes cerrados
  • numInc – Nº de incidentes cerrados
  • numAccBio – Nº de accidentes biológicos cerrados
  • numNC – Nº de no conformidades cerradas
  • numIncidencias – Nº de incidencias cerradas
  • numPAAMed – Nº de actividades PAA médicas realizadas
  • numPAATec – Nº de actividades PAA técnicas realizadas
  • numMedidasImplantadas – Nº de medidas de la acción preventiva implantadas

* Los campos marcados con asterisco devolverán un array de valores en función del tipo

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of item)

Array de campos solicitados junto con el valor producido

Type: item (cualquier campo excepto numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

value: Integer

Nº de objetos registrados en el periodo solicitado

Type: item (sólo para numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

values: array (Of item) – cualquier campo excepto numVacunas, numSerologias

Array de tipos obtenidos junto con el valor producido

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La empresa con el id indicado no existe

 

Ejemplos

application/json
POST ... /api/gestion/empresa/4690556A2D535624569D550C71171D741C/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "ini": "2024-01-01", "fin": "2024-12-31", "campos": "numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAAMed,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas" }
Respuesta
{ "result": [ { "field": "numPlanPrev", "value": "1" }, { "field": "numEV", "value": "16" }, { "field": "numEV_Seg", "value": "10" }, { "field": "numEV_Hig", "value": "4" }, { "field": "numEV_Erg", "value": "2" }, { "field": "numEV_Psi", "value": "0" }, { "field": "numPlanEmer", "value": "1" }, { "field": "numSimulacros", "value": "0" }, { "field": "numAutorizaciones", "value": "0" }, { "field": "numPartesInsVisita", "value": "0" }, { "field": "numPartesInsNoVisita", "value": "5" }, { "field": "numCursos", "value": "18" }, { "field": "numTrabsFormados", "value": "9" }, { "field": "numConsultasMed", "value": "1" }, { "field": "numVacunas", "values": [ { "field": "000006 - Antihepatitis B", "value": "1" } ] }, { "field": "numSerologias", "values": [] }, { "field": "numAcc", "value": "0" }, { "field": "numInc", "value": "1" }, { "field": "numAccBio", "value": "0" }, { "field": "numNC", "value": "0" }, { "field": "numIncidencias", "value": "2" }, { "field": "numPAAMed", "value": "0" }, { "field": "numPAATec", "value": "1" }, { "field": "numRec_Abiertos", "value": "17" }, { "field": "numRec_Cerrados", "value": "0" }, { "field": "numRec_Renuncias", "value": "0" }, { "field": "numRecIni_Abiertos", "value": "2" }, { "field": "numRecIni_Cerrados", "value": "0" }, { "field": "numRecIni_Renuncias", "value": "0" }, { "field": "numRecPer_Abiertos", "value": "11" }, { "field": "numRecPer_Cerrados", "value": "0" }, { "field": "numRecPer_Renuncias", "value": "0" }, { "field": "numRecAus_Abiertos", "value": "1" }, { "field": "numRecAus_Cerrados", "value": "0" }, { "field": "numRecAus_Renuncias", "value": "0" }, { "field": "numRecTareas_Abiertos", "value": "1" }, { "field": "numRecTareas_Cerrados", "value": "0" }, { "field": "numRecTareas_Renuncias", "value": "0" }, { "field": "numMedidasImplantadas", "value": "0" } ] }


application/xml
POST ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_FichaEmpresa_Listados_DatosProduccion_XML> <ini>2024-01-01</ini> <fin>2024-12-31</fin> <campos>numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAAMed,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas</campos> </GENERAL_FichaEmpresa_Listados_DatosProduccion_XML>
Respuesta
<GENERAL_FichaEmpresa_Listados_DatosProduccion_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <field>numPlanPrev</field> <value>1</value> </item> <item> <field>numEV</field> <value>16</value> </item> <item> <field>numEV_Seg</field> <value>10</value> </item> <item> <field>numEV_Hig</field> <value>4</value> </item> <item> <field>numEV_Erg</field> <value>2</value> </item> <item> <field>numEV_Psi</field> <value>0</value> </item> <item> <field>numPlanEmer</field> <value>1</value> </item> <item> <field>numSimulacros</field> <value>0</value> </item> <item> <field>numAutorizaciones</field> <value>0</value> </item> <item> <field>numPartesInsVisita</field> <value>0</value> </item> <item> <field>numPartesInsNoVisita</field> <value>5</value> </item> <item> <field>numCursos</field> <value>18</value> </item> <item> <field>numTrabsFormados</field> <value>9</value> </item> <item> <field>numConsultasMed</field> <value>1</value> </item> <item> <field>numVacunas</field> <values> <item> <field>000006 - Antihepatitis B</field> <value>1</value> </item> </values> </item> <item> <field>numSerologias</field> <values/> </item> <item> <field>numAcc</field> <value>0</value> </item> <item> <field>numInc</field> <value>1</value> </item> <item> <field>numAccBio</field> <value>0</value> </item> <item> <field>numNC</field> <value>0</value> </item> <item> <field>numIncidencias</field> <value>2</value> </item> <item> <field>numPAAMed</field> <value>0</value> </item> <item> <field>numPAATec</field> <value>1</value> </item> <item> <field>numRec_Abiertos</field> <value>17</value> </item> <item> <field>numRec_Cerrados</field> <value>0</value> </item> <item> <field>numRec_Renuncias</field> <value>0</value> </item> <item> <field>numRecIni_Abiertos</field> <value>2</value> </item> <item> <field>numRecIni_Cerrados</field> <value>0</value> </item> <item> <field>numRecIni_Renuncias</field> <value>0</value> </item> <item> <field>numRecPer_Abiertos</field> <value>11</value> </item> <item> <field>numRecPer_Cerrados</field> <value>0</value> </item> <item> <field>numRecPer_Renuncias</field> <value>0</value> </item> <item> <field>numRecAus_Abiertos</field> <value>1</value> </item> <item> <field>numRecAus_Cerrados</field> <value>0</value> </item> <item> <field>numRecAus_Renuncias</field> <value>0</value> </item> <item> <field>numRecTareas_Abiertos</field> <value>1</value> </item> <item> <field>numRecTareas_Cerrados</field> <value>0</value> </item> <item> <field>numRecTareas_Renuncias</field> <value>0</value> </item> <item> <field>numMedidasImplantadas</field> <value>0</value> </item> </result> </GENERAL_FichaEmpresa_Listados_DatosProduccion_XMLResponse>

 

Centro de trabajo. Datos registrados en un periodo

POST

Media Type URI
URI application/json
/api/gestion/centro/{id}/inf/produccion
URI application/xml
/api/xml/gestion/centro/{id}/inf/produccion

Devuelve el nº de datos registrados para un centro de trabajo en un periodo de tiempo.

Listado de datos que se pueden recuperar:

  • Nº de planes de prevención
  • Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • Nº de evaluaciones de seguridad
  • Nº de evaluaciones de higiene
  • Nº de evaluaciones de ergonomía
  • Nº de evaluaciones psicosociales
  • Nº de planes de emergencia
  • Nº de simulacros realizados
  • Nº de autorizaciones de trabajo
  • Nº de partes de inspección (de tipo visita)
  • Nº de partes de inspección (que no sean de tipo visita)
  • Nº de cursos de formación
  • Nº de trabajadores formados
  • Nº de reconocimientos abiertos
  • Nº de reconocimientos cerrados
  • Nº de reconocimientos renunciados
  • Nº de reconocimientos abiertos (iniciales)
  • Nº de reconocimientos cerrados (iniciales)
  • Nº de reconocimientos renunciados (iniciales)
  • Nº de reconocimientos abiertos (periódicos)
  • Nº de reconocimientos cerrados (periódicos)
  • Nº de reconocimientos renunciados (periódicos)
  • Nº de reconocimientos abiertos (tras ausencia prolongada)
  • Nº de reconocimientos cerrados (tras ausencia prolongada)
  • Nº de reconocimientos renunciados (tras ausencia prolongada)
  • Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • Nº de consultas médicas asistenciales
  • Nº de vacunas administradas (por tipo)
  • Nº de serologías administradas (por tipo)
  • Nº de accidentes cerrados
  • Nº de incidentes cerrados
  • Nº de accidentes biológicos cerrados
  • Nº de no conformidades cerradas
  • Nº de incidencias cerradas
  • Nº de actividades PAA técnicas realizadas
  • Nº de medidas de la acción preventiva implantadas

Seguridad (permisos necesarios del usuario autenticado)

  • Datos registrados en la aplicación en un periodo
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único del centro en Prevengos (puede obtener este identificador en el listado de centros de la empresa)

Cuerpo (body)

ini (opcional): Date

Fecha de inicio que quiere consultar (formato yyyy-MM-dd)

fin (opcional): Date

Fecha de fin que quiere consultar (formato yyyy-MM-dd)

campos: String

Nombre de los campos que desea obtener (separados por comas)

  • numPlanPrev – Nº de planes de prevención
  • numEV – Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • numEV_Seg – Nº de evaluaciones de seguridad
  • numEV_Hig – Nº de evaluaciones de higiene
  • numEV_Erg – Nº de evaluaciones de ergonomía
  • numEV_Psi – Nº de evaluaciones psicosociales
  • numPlanEmer – Nº de planes de emergencia
  • numSimulacros – Nº de simulacros realizados
  • numAutorizaciones – Nº de autorizaciones de trabajo
  • numPartesInsVisita – Nº de partes de inspección (de tipo visita)
  • numPartesInsNoVisita – Nº de partes de inspección (que no sean de tipo visita)
  • numCursos – Nº de cursos de formación
  • numTrabsFormados – Nº de trabajadores formados
  • numRec_Abiertos – Nº de reconocimientos abiertos
  • numRec_Cerrados – Nº de reconocimientos cerrados
  • numRec_Renuncias – Nº de reconocimientos renunciados
  • numRecIni_Abiertos – Nº de reconocimientos abiertos (iniciales)
  • numRecIni_Cerrados – Nº de reconocimientos cerrados (iniciales)
  • numRecIni_Renuncias – Nº de reconocimientos renunciados (iniciales)
  • numRecPer_Abiertos – Nº de reconocimientos abiertos (periódicos)
  • numRecPer_Cerrados – Nº de reconocimientos cerrados (periódicos)
  • numRecPer_Renuncias – Nº de reconocimientos renunciados (periódicos)
  • numRecAus_Abiertos – Nº de reconocimientos abiertos (tras ausencia prolongada)
  • numRecAus_Cerrados – Nº de reconocimientos cerrados (tras ausencia prolongada)
  • numRecAus_Renuncias – Nº de reconocimientos renunciados (tras ausencia prolongada)
  • numRecTareas_Abiertos – Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • numRecTareas_Cerrados – Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • numRecTareas_Renuncias – Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • numConsultasMed – Nº de consultas médicas asistenciales
  • numVacunas – Nº de vacunas administradas (por tipo) *
  • numSerologias – Nº de serologías administradas (por tipo) *
  • numAcc – Nº de accidentes cerrados
  • numInc – Nº de incidentes cerrados
  • numAccBio – Nº de accidentes biológicos cerrados
  • numNC – Nº de no conformidades cerradas
  • numIncidencias – Nº de incidencias cerradas
  • numPAATec – Nº de actividades PAA técnicas realizadas
  • numMedidasImplantadas – Nº de medidas de la acción preventiva implantadas

* Los campos marcados con asterisco devolverán un array de valores en función del tipo

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of item)

Array de campos solicitados junto con el valor producido

Type: item (cualquier campo excepto numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

value: Integer

Nº de objetos registrados en el periodo solicitado

Type: item (sólo para numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

values: array (Of item) – cualquier campo excepto numVacunas, numSerologias

Array de tipos obtenidos junto con el valor producido

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

El centro de trabajo con el id indicado no existe

 

Ejemplos

application/json
POST ... /api/gestion/centro/4690556C254D50334A8F725D2141452B4ADF150C71/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "ini": "2024-01-01", "fin": "2024-12-31", "campos": "numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas" }
Respuesta
{ "result": [ { "field": "numPlanPrev", "value": "1" }, { "field": "numEV", "value": "16" }, { "field": "numEV_Seg", "value": "10" }, { "field": "numEV_Hig", "value": "4" }, { "field": "numEV_Erg", "value": "2" }, { "field": "numEV_Psi", "value": "0" }, { "field": "numPlanEmer", "value": "1" }, { "field": "numSimulacros", "value": "0" }, { "field": "numAutorizaciones", "value": "0" }, { "field": "numPartesInsVisita", "value": "0" }, { "field": "numPartesInsNoVisita", "value": "2" }, { "field": "numCursos", "value": "15" }, { "field": "numTrabsFormados", "value": "5" }, { "field": "numConsultasMed", "value": "1" }, { "field": "numVacunas", "values": [ { "field": "000006 - Antihepatitis B", "value": "1" } ] }, { "field": "numSerologias", "values": [] }, { "field": "numAcc", "value": "0" }, { "field": "numInc", "value": "1" }, { "field": "numAccBio", "value": "1" }, { "field": "numNC", "value": "0" }, { "field": "numIncidencias", "value": "2" }, { "field": "numPAATec", "value": "1" }, { "field": "numRec_Abiertos", "value": "16" }, { "field": "numRec_Cerrados", "value": "0" }, { "field": "numRec_Renuncias", "value": "0" }, { "field": "numRecIni_Abiertos", "value": "4" }, { "field": "numRecIni_Cerrados", "value": "0" }, { "field": "numRecIni_Renuncias", "value": "0" }, { "field": "numRecPer_Abiertos", "value": "8" }, { "field": "numRecPer_Cerrados", "value": "0" }, { "field": "numRecPer_Renuncias", "value": "0" }, { "field": "numRecAus_Abiertos", "value": "1" }, { "field": "numRecAus_Cerrados", "value": "0" }, { "field": "numRecAus_Renuncias", "value": "0" }, { "field": "numRecTareas_Abiertos", "value": "1" }, { "field": "numRecTareas_Cerrados", "value": "0" }, { "field": "numRecTareas_Renuncias", "value": "0" }, { "field": "numMedidasImplantadas", "value": "0" } ] }


application/xml
POST ... /api/xml/gestion/centro/4690556C254D50334A8F725D2141452B4ADF150C71/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_FichaCentro_Listados_DatosProduccion_XML> <ini>2024-01-01</ini> <fin>2024-12-31</fin> <campos>numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas</campos> </GENERAL_FichaCentro_Listados_DatosProduccion_XML>
Respuesta
<GENERAL_FichaCentro_Listados_DatosProduccion_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <field>numPlanPrev</field> <value>1</value> </item> <item> <field>numEV</field> <value>16</value> </item> <item> <field>numEV_Seg</field> <value>10</value> </item> <item> <field>numEV_Hig</field> <value>4</value> </item> <item> <field>numEV_Erg</field> <value>2</value> </item> <item> <field>numEV_Psi</field> <value>0</value> </item> <item> <field>numPlanEmer</field> <value>1</value> </item> <item> <field>numSimulacros</field> <value>0</value> </item> <item> <field>numAutorizaciones</field> <value>0</value> </item> <item> <field>numPartesInsVisita</field> <value>0</value> </item> <item> <field>numPartesInsNoVisita</field> <value>2</value> </item> <item> <field>numCursos</field> <value>15</value> </item> <item> <field>numTrabsFormados</field> <value>5</value> </item> <item> <field>numConsultasMed</field> <value>1</value> </item> <item> <field>numVacunas</field> <values> <item> <field>000006 - Antihepatitis B</field> <value>1</value> </item> </values> </item> <item> <field>numSerologias</field> <values/> </item> <item> <field>numAcc</field> <value>0</value> </item> <item> <field>numInc</field> <value>1</value> </item> <item> <field>numAccBio</field> <value>1</value> </item> <item> <field>numNC</field> <value>0</value> </item> <item> <field>numIncidencias</field> <value>2</value> </item> <item> <field>numPAATec</field> <value>1</value> </item> <item> <field>numRec_Abiertos</field> <value>16</value> </item> <item> <field>numRec_Cerrados</field> <value>0</value> </item> <item> <field>numRec_Renuncias</field> <value>0</value> </item> <item> <field>numRecIni_Abiertos</field> <value>4</value> </item> <item> <field>numRecIni_Cerrados</field> <value>0</value> </item> <item> <field>numRecIni_Renuncias</field> <value>0</value> </item> <item> <field>numRecPer_Abiertos</field> <value>8</value> </item> <item> <field>numRecPer_Cerrados</field> <value>0</value> </item> <item> <field>numRecPer_Renuncias</field> <value>0</value> </item> <item> <field>numRecAus_Abiertos</field> <value>1</value> </item> <item> <field>numRecAus_Cerrados</field> <value>0</value> </item> <item> <field>numRecAus_Renuncias</field> <value>0</value> </item> <item> <field>numRecTareas_Abiertos</field> <value>1</value> </item> <item> <field>numRecTareas_Cerrados</field> <value>0</value> </item> <item> <field>numRecTareas_Renuncias</field> <value>0</value> </item> <item> <field>numMedidasImplantadas</field> <value>0</value> </item> </result> </GENERAL_FichaCentro_Listados_DatosProduccion_XMLResponse>

 

Administración. Contratos (listado)

GET

Media Type URI
URI application/json
/api/admon/inf/contratos?fIni={fIni}&fFin={fFin}&cif={cif}&codE={codE}&ref={ref}
URI application/xml
/api/xml/admon/inf/contratos?fIni={fIni}&fFin={fFin}&cif={cif}&codE={codE}&ref={ref}

Devuelve el listado de contratos junto con diferentes contadores de diferentes elementos registrados en Prevengos, resultado de dicha contratación.

Para acotar la lista de contratos resultantes, es obligatorio indicar el periodo contractual que se desea consultar. En base a este periodo, se obtendrán los contratos con vigencia total o parcial dentro del mismo, y de cada contrato los campos que lo identifican y los siguientes datos inherentes:

  • Nº de evaluciones de riesgos, independientemente de la especialidad
  • Nº de planes de prevención
  • Nº de partes de inspección tipo visita exclusivamente
    Sólo partes de inspección con el check "Visita a la empresa" marcado.
  • Nº de cursos realizados de artículo 19 exclusivamente
    Nº de cursos con el check "Formación riesgos específicos del puesto (art 19 LPRL)" marcado exclusivamente, es decir, con ningún otro check marcado del bloque de checks "Tipo de acción formativa", y que además tengan marcado el check "curso o acción formativa realizada".
  • Nº de trabajadores asistidos a cursos realizados de artículo 19 exclusivamente
    Nº de trabajadores con el check "El trabajador ha asistido al curso" marcado de aquellos cursos que corresponden con el punto anterior.
  • Nº de reconocimientos planificados en campaña
    Nº de reconocimientos agregados a las campañas, independientemente de su situación, ya estén realizados, no realizados o con el check de renuncia marcada, es decir, todos los reconocimientos.
  • Nº de reconocimientos planificados y realizados
    Nº de reconocmientos agregados y realizados, es decir, aquellos con fecha de reconocimiento cumplimentada y con el check de renuncia sin marcar.

Seguridad (permisos necesarios del usuario autenticado)

  • Listado de contratos (gestión administrativa)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

fIni: String

Fecha de inicio del periodo a consultar (formato YYYYMMDD)

fFin: String

Fecha de fin del periodo a consultar (formato YYYYMMDD)

cif (opcional): String

Permite filtrar el listado de contratos para la empresa que cumpla con el CIF indicado en el parámetro

codE (opcional): String

Permite filtrar el listado de contratos para las empresas que cumplan con el código de empresa indicado en el parámetro

ref (opcional): String

Permite filtrar el listado de contratos para los contratos que cumplan con la referencia indicada en el parámetro.

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of contrato)

Array de contratos que cumplen con el filtro

Type: contrato

key: String

Identificador único del contrato en Prevengos

refContrato: String

Referencia del contrato

codContrato: String

Código del contrato

inicio: Date

Fecha de contrato

vencimiento: Date

Fecha de vencimiento del contrato

keyEmpresa: String

Identificador único de la empresa en Prevengos

codEmpresa: String

Código de cliente

sufijoEmpresa: String

Sufijo de la empresa

cif: String

Cif de la empresa

nombreEmpresa: String

Nombre de la empresa

numEvaluaciones: Integer

Nº de evaluciones de riesgos, independientemente de la especialidad

numPlanesPrev: Integer

Nº de planes de prevención

numPartesInspecVisita: Integer

Nº de partes de inspección tipo visita exclusivamente

numCursosExclArt19: Integer

Nº de cursos realizados de artículo 19 exclusivamente

numTrabsCursosExclArt19: Integer

Nº de trabajadores asistidos a cursos realizados de artículo 19 exclusivamente

numRecosPlanificados: Integer

Nº de reconocimientos planificados en campaña

numRecosRealizados: Integer

Nº de reconocimientos planificados y realizados

204 No content

La petición se ha realizado correctamente pero no existe ningún contrato que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/formacion/trabajadores?periodoCurso=20220201-20220228


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
[ { "key": "469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF15196310", "codEmpresa": "0000001-MU", "sufijoEmpresa": "MU", "cif": "B30744337", "empresa": "SERVICIO PREVENCION MURCIA", "dni": "12345678A", "identificador": "", "trabajador": "CAROLINA GUERRERO", "naf": "", "desactivado": false, "asiste": false, "fechaAsis": "/Date(-2208992400000+0100)/", "fechaValidez": "/Date(-2208992400000+0100)/", "certificado": false, "aprovechamiento": false, "subvencionado": false, "codCentro": "", "centro": "", "curso": "Curso básico de Prevención de Riesgos en Obras", "refCurso": "", "keyCurso": "469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10", "inicio": "/Date(1644879600000+0100)/", "fin": "/Date(1644879600000+0100)/", "tipoCurso": "On-line", "cursoTeorico": false, "cursoPresencial": false, "cursoADistancia": false, "cursoOnline": false, "cursoOtros": false, "art19": false, "rd39": false, "emergencias": false, "vs": false, "anexoReg": "", "cursoSubvencionado": false, "caducidadMeses": 0, "horasLectivas": 1.00, "horasPracticas": 30.00, "horasTotales": 31.00, "empConfAsistencia": false, "empAsiste": false, "cursoRealizado": false, "refContrato": "", "codContrato": "", "keyContrato": "", "iniContrato": "/Date(-2208992400000+0100)/", "vtoContrato": "/Date(-2208992400000+0100)/" }, { "key": "469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF1519631114", "codEmpresa": "0000001-MU", "sufijoEmpresa": "MU", "cif": "B30744337", "empresa": "SERVICIO PREVENCION MURCIA", "dni": "12345678B", "identificador": "", "trabajador": "NOMBRE DEL TRABAJADOR", "naf": "012345678912", "desactivado": false, "asiste": false, "fechaAsis": "/Date(-2208992400000+0100)/", "fechaValidez": "/Date(-2208992400000+0100)/", "certificado": false, "aprovechamiento": false, "subvencionado": false, "codCentro": "000001-C1", "centro": "Centro logístico de Málaga", "curso": "Curso básico de Prevención de Riesgos en Obras", "refCurso": "", "keyCurso": "469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10", "inicio": "/Date(1644879600000+0100)/", "fin": "/Date(1644879600000+0100)/", "tipoCurso": "On-line", "cursoTeorico": false, "cursoPresencial": false, "cursoADistancia": false, "cursoOnline": false, "cursoOtros": false, "art19": false, "rd39": false, "emergencias": false, "vs": false, "anexoReg": "", "cursoSubvencionado": false, "caducidadMeses": 0, "horasLectivas": 1.00, "horasPracticas": 30.00, "horasTotales": 31.00, "empConfAsistencia": false, "empAsiste": false, "cursoRealizado": false, "refContrato": "", "codContrato": "", "keyContrato": "", "iniContrato": "/Date(-2208992400000+0100)/", "vtoContrato": "/Date(-2208992400000+0100)/" } ]


application/xml
GET ... /api/xml/gestion/empresa/4690556A2D535624569D550C71171D741C/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<ArrayOfcontrato xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <contrato> <key>4690556C2F4D50334488495C63111C6214DF141F7212</key> <refContrato>00001/21</refContrato> <codContrato>00001/21</codContrato> <inicio>2021-10-22T00:00:00</inicio> <vencimiento>2022-10-21T00:00:00</vencimiento> <keyEmpresa>4690556A2D535624569D550C721B</keyEmpresa> <codEmpresa>000000031</codEmpresa> <sufijoEmpresa/> <cif>B06658900</cif> <nombreEmpresa>METODO PREVENCION S.L.</nombreEmpresa> <numEvaluaciones>0</numEvaluaciones> <numPlanesPrev>0</numPlanesPrev> <numPartesInspecVisita>0</numPartesInspecVisita> <numCursosExclArt19>0</numCursosExclArt19> <numTrabsCursosExclArt19>0</numTrabsCursosExclArt19> <numRecosPlanificados>2</numRecosPlanificados> <numRecosRealizados>2</numRecosRealizados> </contrato> <contrato> <key>4690556C2F4D50334488495C6310146214DF141F7211</key> <refContrato>00004/22</refContrato> <codContrato>00004/22</codContrato> <inicio>2022-02-15T00:00:00</inicio> <vencimiento>2023-02-14T00:00:00</vencimiento> <keyEmpresa>4690556A2D535624569D550C7313</keyEmpresa> <codEmpresa>000000033-MU</codEmpresa> <sufijoEmpresa>MU</sufijoEmpresa> <cif>CIF001</cif> <nombreEmpresa>EMPRESA PRUEBA</nombreEmpresa> <numEvaluaciones>0</numEvaluaciones> <numPlanesPrev>0</numPlanesPrev> <numPartesInspecVisita>0</numPartesInspecVisita> <numCursosExclArt19>0</numCursosExclArt19> <numTrabsCursosExclArt19>0</numTrabsCursosExclArt19> <numRecosPlanificados>0</numRecosPlanificados> <numRecosRealizados>0</numRecosRealizados> </contrato> </ArrayOfcontrato>

 

Formación. Trabajadores (listado)

GET

Media Type URI
URI application/json
/api/formacion/trabajadores?periodoCurso={periodoCurso}&estadoCurso={estadoCurso}&contratoRef={contratoRef}&contratoPeriodo={contratoPeriodo}&cif={cif}&codE={codE}&estadoTrabs={estadoTrabs}&estadoAsistenciaTrabs={estadoAsistenciaTrabs}&estadoFAsistenciaTrabs={estadoFAsistenciaTrabs}&periodoAsistenciaTrabs={periodoAsistenciaTrabs}
URI application/xml
/api/xml/formacion/trabajadores?periodoCurso={periodoCurso}&estadoCurso={estadoCurso}&contratoRef={contratoRef}&contratoPeriodo={contratoPeriodo}&cif={cif}&codE={codE}&estadoTrabs={estadoTrabs}&estadoAsistenciaTrabs={estadoAsistenciaTrabs}&estadoFAsistenciaTrabs={estadoFAsistenciaTrabs}&periodoAsistenciaTrabs={periodoAsistenciaTrabs}

Devuelve el listado de trabajadores en cursos de formación que cumplan con los parámetros de entrada.

Seguridad (permisos necesarios del usuario autenticado)

  • Listado de trabajadores (formación)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

periodoCurso (opcional): String

Periodo de impartición de los cursos a consultar (formato YYYYMMDD-YYYYMMDD)
Permite filtrar el listado para aquellos cursos cuya fecha de inicio y fin estén dentro del periodo indicado.

estadoCurso (opcional): Enum

Permite filtrar el listado de cursos según su realización, es decir, cursos cuyo check "curso o acción formativa realizada" se encuentra no marcado, marcado o todos

  • 0 – Sólo cursos que no están marcados
  • 1 – Sólo cursos que están marcados
  • 2 – Todos (valor por defecto)
contratoRef (opcional): String

Permite filtrar el listado de cursos según la referencia de contrato asociado. Se filtrarán sólo aquellos que cumplan con la referencia indicada en el parámetro.

contratoPeriodo (opcional): String

Permite filtrar el listado de cursos a aquellos que estén vinculados a contratos con vigencia total o parcial en el periodo indicado (formato YYYYMMDD-YYYYMMDD)

cif (opcional): String

Permite filtrar el listado para la empresa que cumpla con el CIF indicado en el parámetro

codE (opcional): String

Permite filtrar el listado para las empresas que cumplan con el código de empresa indicado en el parámetro.

estadoTrabs (opcional): Enum

Permite filtrar el listado de trabajadores según su estado actual en la empresa.

  • 0 – Sólo trabajadores de alta actualmente
  • 1 – Sólo trabajadores de baja actualmente
  • 2 – Todos (valor por defecto)
estadoAsistenciaTrabs (opcional): Enum

Permite filtrar el listado de trabajadores según su asistencia, es decir, trabajadores cuyo check "ha asistido al curso" se encuentra no marcado, marcado o todos.

  • 0 – Sólo trabajadores que no están marcados como que han asistido
  • 1 – Sólo trabajadores que están marcados como que han asistido
  • 2 – Todos (valor por defecto)
estadoFAsistenciaTrabs (opcional): Enum

Permite filtrar el listado de trabajadores según el estado de la fecha de asistencia al curso, es decir, trabajadores cuya fecha de asistencia se encuentra en blanco, o no.

  • 0 – Sólo trabajadores que no tienen fecha de asistencia
  • 1 – Sólo trabajadores que tienen fecha de asistencia
  • 2 – Todos (valor por defecto)

(implica que el filtro estadoAsistenciaTrabs será siempre 1, aunque no se indique)

periodoAsistenciaTrabs (opcional): String

Periodo de asistencia de los trabajadores formados (formato YYYYMMDD-YYYYMMDD)
Permite filtrar el listado para aquellos trabajadores cuya fecha de asistencia se encuentre dentro del periodo indicado.

(implica que el filtro estadoFAsistenciaTrabs será siempre 1, aunque no se indique)

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of trabForm)

Array de trabajadores en cursos de formación que cumplen con el filtro

Type: trabForm

key: String

Identificador único del trabajador en el curso de formación en Prevengos

codEmpresa: String

Código de empresa

sufijoEmpresa: String

Sufijo de la empresa/p>

cif: String

Cif de la empresa

empresa: String

Nombre de la empresa

dni: String

DNI del trabajador

identificador: String

Identificador del trabajador

trabajador: String

Nombre del trabajador

naf: String

Nº de la seguridad social

desactivado: Boolean

Indica si el trabajador está desactivado

asiste: Boolean

Indica si el trabajador ha asistido al curso

fechaAsis: Date

Indica la fecha de asistencia del trabajador al curso

fechaValidez: Date

Indica la fecha de validez del curso del trabajador

certificado: Boolean

Indica si el trabajador ha recibido su certificado de formación

aprovechamiento: Boolean

Indica si el trabajador ha aprovechado el curso de formación

subvencionado: Boolean

Indica si el trabajador en el curso está subvencionado

codCentro: String

Código del centro de trabajo del trabajador en el momento del curso

centro: String

Nombre del centro de trabajo del trabajador en el momento del curso

curso: String

Título del curso

refCurso: String

Referencia del curso

keyCurso: String

Identificador único del curso en Prevengos

inicio: Date

Periodo de fechas del curso

fin: Date

Periodo de fechas del curso

tipoCurso: String

Tipo de curso

cursoTeorico: Boolean

Indica la modalidad formativa del curso: Curso teórico

cursoPresencial: Boolean

Indica la modalidad formativa del curso: Curso presencial

cursoADistancia: Boolean

Indica la modalidad formativa del curso: Curso a distancia

cursoOnline: Boolean

Indica la modalidad formativa del curso: Curso online

cursoOtros: Boolean

Indica la modalidad formativa del curso: Otro tipo de modalidad formativa

art19: Boolean

Indica si es una formación de riesgos específicos del puesto (art. 19 LPRL)

rd39: Boolean

Indica si es una formación de nivel básico (anexo IV R.D. 39/1997)

emergencias: Boolean

Indica si es una formación para emergencias

vs: Boolean

Indica si es una formación de vigilancia de la salud

anexoReg: String

Anexo regulador del curso

cursoSubvencionado: Boolean

Indica si el curso está subvencionado

caducidadMeses: Integer

En el caso de que el curso tenga caducidad, se indicará los meses de validez

horasLectivas: Integer

Nº de horas lectivas

horasPracticas: Integer

Nº de horas prácticas

horasTotales: Integer

Nº de horas totales (horasLectivas + horasPracticas)

empConfAsistencia: Boolean

Indica si la empresa ha confirmado la asistencia al curso

empAsiste: Boolean

Indica si la empresa ha asistido al curso

cursoRealizado: Boolean

Indica si el curso se ha realizado

refContrato: String

Indica la referencia del contrato asociado al curso

codContrato: String

Indica el código del contrato asociado al curso

keyContrato: String

Identificador único del contrato en Prevengos

iniContrato: Date

Fecha de inicio del contrato asociado

vtoContrato: Date

Fecha de vencimiento del contrato asociado

204 No content

La petición se ha realizado correctamente pero no existen registros que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/formacion/trabajadores?periodoCurso=20220201-20220228


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
[ { "key": "469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF15196310", "codEmpresa": "0000001-MU", "sufijoEmpresa": "MU", "cif": "B30744337", "empresa": "SERVICIO PREVENCION MURCIA", "dni": "12345678A", "identificador": "", "trabajador": "CAROLINA GUERRERO", "naf": "", "desactivado": false, "asiste": false, "fechaAsis": "/Date(-2208992400000+0100)/", "fechaValidez": "/Date(-2208992400000+0100)/", "certificado": false, "aprovechamiento": false, "subvencionado": false, "codCentro": "", "centro": "", "curso": "Curso básico de Prevención de Riesgos en Obras", "refCurso": "", "keyCurso": "469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10", "inicio": "/Date(1644879600000+0100)/", "fin": "/Date(1644879600000+0100)/", "tipoCurso": "On-line", "cursoTeorico": false, "cursoPresencial": false, "cursoADistancia": false, "cursoOnline": false, "cursoOtros": false, "art19": false, "rd39": false, "emergencias": false, "vs": false, "anexoReg": "", "cursoSubvencionado": false, "caducidadMeses": 0, "horasLectivas": 1.00, "horasPracticas": 30.00, "horasTotales": 31.00, "empConfAsistencia": false, "empAsiste": false, "cursoRealizado": false, "refContrato": "", "codContrato": "", "keyContrato": "", "iniContrato": "/Date(-2208992400000+0100)/", "vtoContrato": "/Date(-2208992400000+0100)/" }, { "key": "469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF1519631114", "codEmpresa": "0000001-MU", "sufijoEmpresa": "MU", "cif": "B30744337", "empresa": "SERVICIO PREVENCION MURCIA", "dni": "12345678B", "identificador": "", "trabajador": "NOMBRE DEL TRABAJADOR", "naf": "012345678912", "desactivado": false, "asiste": false, "fechaAsis": "/Date(-2208992400000+0100)/", "fechaValidez": "/Date(-2208992400000+0100)/", "certificado": false, "aprovechamiento": false, "subvencionado": false, "codCentro": "000001-C1", "centro": "Centro logístico de Málaga", "curso": "Curso básico de Prevención de Riesgos en Obras", "refCurso": "", "keyCurso": "469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10", "inicio": "/Date(1644879600000+0100)/", "fin": "/Date(1644879600000+0100)/", "tipoCurso": "On-line", "cursoTeorico": false, "cursoPresencial": false, "cursoADistancia": false, "cursoOnline": false, "cursoOtros": false, "art19": false, "rd39": false, "emergencias": false, "vs": false, "anexoReg": "", "cursoSubvencionado": false, "caducidadMeses": 0, "horasLectivas": 1.00, "horasPracticas": 30.00, "horasTotales": 31.00, "empConfAsistencia": false, "empAsiste": false, "cursoRealizado": false, "refContrato": "", "codContrato": "", "keyContrato": "", "iniContrato": "/Date(-2208992400000+0100)/", "vtoContrato": "/Date(-2208992400000+0100)/" } ]


application/xml
GET ... /api/xml/formacion/trabajadores?periodoCurso=20220201-20220228


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<ArrayOftrabForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <trabForm> <key>469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF15196310</key> <codEmpresa>0000001-MU</codEmpresa> <sufijoEmpresa>MU</sufijoEmpresa> <cif>B30744337</cif> <empresa>SERVICIO PREVENCION MURCIA</empresa> <dni>12345678A</dni> <identificador/> <trabajador>CAROLINA GUERRERO</trabajador> <naf/> <desactivado>false</desactivado> <asiste>false</asiste> <fechaAsis>1900-01-01T00:00:00</fechaAsis> <fechaValidez>1900-01-01T00:00:00</fechaValidez> <certificado>false</certificado> <aprovechamiento>false</aprovechamiento> <subvencionado>false</subvencionado> <codCentro/> <centro/> <curso>Curso básico de Prevención de Riesgos en Obras</curso> <refCurso/> <keyCurso>469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10</keyCurso> <inicio>2022-02-15T00:00:00</inicio> <fin>2022-02-15T00:00:00</fin> <tipoCurso>On-line</tipoCurso> <cursoTeorico>false</cursoTeorico> <cursoPresencial>false</cursoPresencial> <cursoADistancia>false</cursoADistancia> <cursoOnline>false</cursoOnline> <cursoOtros>false</cursoOtros> <art19>false</art19> <rd39>false</rd39> <emergencias>false</emergencias> <vs>false</vs> <anexoReg/> <cursoSubvencionado>false</cursoSubvencionado> <caducidadMeses>0</caducidadMeses> <horasLectivas>1.00</horasLectivas> <horasPracticas>30.00</horasPracticas> <horasTotales>31.00</horasTotales> <empConfAsistencia>false</empConfAsistencia> <empAsiste>false</empAsiste> <cursoRealizado>false</cursoRealizado> <refContrato/> <codContrato/> <keyContrato/> <iniContrato>1900-01-01T00:00:00</iniContrato> <vtoContrato>1900-01-01T00:00:00</vtoContrato> </trabForm> <trabForm> <key>469055690F71691E649F45462F4D622E5791475B29554515579D444E2A42402E5799550C7100146215DF1519631114</key> <codEmpresa>0000001-MU</codEmpresa> <sufijoEmpresa>MU</sufijoEmpresa> <cif>B30744337</cif> <empresa>SERVICIO PREVENCION MURCIA</empresa> <dni>12345678B</dni> <identificador/> <trabajador>NOMBRE DEL TRABAJADOR</trabajador> <naf>012345678912</naf> <desactivado>false</desactivado> <asiste>false</asiste> <fechaAsis>1900-01-01T00:00:00</fechaAsis> <fechaValidez>1900-01-01T00:00:00</fechaValidez> <certificado>false</certificado> <aprovechamiento>false</aprovechamiento> <subvencionado>false</subvencionado> <codCentro>000001-C1</codCentro> <centro>Centro logístico de Málaga</centro> <curso>Curso básico de Prevención de Riesgos en Obras</curso> <refCurso/> <keyCurso>469055690F71691E649F45462F4D41326393544221574D37448F051E6313077106CF10</keyCurso> <inicio>2022-02-15T00:00:00</inicio> <fin>2022-02-15T00:00:00</fin> <tipoCurso>On-line</tipoCurso> <cursoTeorico>false</cursoTeorico> <cursoPresencial>false</cursoPresencial> <cursoADistancia>false</cursoADistancia> <cursoOnline>false</cursoOnline> <cursoOtros>false</cursoOtros> <art19>false</art19> <rd39>false</rd39> <emergencias>false</emergencias> <vs>false</vs> <anexoReg/> <cursoSubvencionado>false</cursoSubvencionado> <caducidadMeses>0</caducidadMeses> <horasLectivas>1.00</horasLectivas> <horasPracticas>30.00</horasPracticas> <horasTotales>31.00</horasTotales> <empConfAsistencia>false</empConfAsistencia> <empAsiste>false</empAsiste> <cursoRealizado>false</cursoRealizado> <refContrato/> <codContrato/> <keyContrato/> <iniContrato>1900-01-01T00:00:00</iniContrato> <vtoContrato>1900-01-01T00:00:00</vtoContrato> </trabForm> </ArrayOftrabForm>

 

Informes. Trabajadores vs últ. reconocimiento

POST

Media Type URI
URI application/json
/api/gestion/inf/trabajadores/ult-reconocimiento-medico
URI application/xml
/api/xml/gestion/inf/trabajadores/ult-reconocimiento-medico

Listado de trabajadores junto con su último reconocimiento médico (aptitud médica o renuncia al reconocimiento).
Se recomienda acotar el listado, puesto que por defecto, si no se envía ningún filtro, se listarán todos los que estén de alta en ese momento.

Nota: Se considerará como último reconocimiento aquel que esté renunciado, o cerrado y validado por el médico

Seguridad (permisos necesarios del usuario autenticado)

  • Listado de trabajadores vs último reconocimiento médico (consultas o informes)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará el trabajador que coincida con el key indicado
  • dni – buscará el trabajador que coincida con el dni indicado
  • ref – buscará el trabajador que coincida con el identificador indicado
  • nombre – buscará cualquier trabajador que contenga el texto en el nombre
  • estado – permitirá filtrar por el estado del trabajador:
    • 0 – todos (de alta y de baja)
    • 1 – sólo de alta (valor por defecto)
    • 2 – sólo de baja
  • keyemp – buscará trabajadores de la empresa que coincida con el key indicado
  • cif – buscará trabajadores de las empresas que coincidan con el cif indicado
  • empresa – buscará trabajadores de cualquier empresa que contenga el texto en el nombre
  • codemp – buscará trabajadores de cualquier empresa que contenga el texto en el código
  • estadoemp – permitirá filtrar por el estado de la empresa:
    • 0 – todas (de alta y de baja)
    • 1 – sólo de alta (valor por defecto)
    • 2 – sólo de baja
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of item)

Array de trabajadores que cumplen con el filtro

Type: item

key: String

Identificador único del trabajador en Prevengos

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

puesto: String

Puesto de trabajo del trabajador

empresa: datosEmpresa

Datos de la empresa propietaria del trabajador

reconocimiento (opcional): datosAptitud

Datos del último reconocimiento del trabajador (si lo tiene)

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

nombre: String

Nombre de la empresa

Type: datosAptitud

key: String

Identificador único del reconocimiento en Prevengos

fecha: Date

Fecha del reconocimiento

renuncia: Boolean

Indica si el trabajador ha renunciado al reconocimiento

valoracion: String

Valoración del reconocimiento (si no ha renunciado)

documento (opcional): datosDocumento

Datos del documento asociado (si lo tiene)

Type: datosDocumento

key: String

Identificador único del documento en Prevengos

tipo: Enum

Indica el tipo de documento

  • 12 – Certificado de aptitud del trabajador
  • 44 – Certificado de renuncia al reconocimiento
titulo: String

Título del documento

fichero: String

Nombre del fichero

204 No content

La petición se ha realizado correctamente pero no existen registros que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/gestion/inf/trabajadores/ult-reconocimiento-medico


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "dni","value": "12345678A"} ] }
Respuesta
{ "result": [ { "key": "4690557B324246204F9D42403246576214C4101B730015", "dni": "12345678A", "nombre": "TRABAJADOR 1", "puesto": "Administrativo", "empresa": { "key": "4690556A2D535624569D550C711B127516", "nombre": "EMPRESA PRUEBAS" }, }, { "key": "4690557B324246204F9D42403246576214C81F1A790015", "dni": "12345678A", "nombre": "TRABAJADOR 1", "puesto": "Administrativo", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "nombre": "EMPRESA SL" }, "reconocimiento": { "key": "4690557B3242461E779945402E4C472848DF171B79161D6214DF151D7717077315CE15", "fecha": "/Date(1703026800000+0100)/", "renuncia": false, "valoracion": "APTO", "documento": { "key": "4690556B0F607B054A9F5342254D502E56DF171D70131C7311", "tipo": 12, "titulo": "Certificado de aptitud TRABAJADOR 1 (20_12_2023) (A Solicitud del Trabajador) (12345678A)", "fichero": "Certificado de aptitud TRABAJADOR 1 (20_12_2023) (A Solicitud del Trabajador) (12345678A).doc" } } } ] }


application/xml
POST ... /api/xml/gestion/inf/trabajadores/ult-reconocimiento-medico


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_Informes_Trabajadores_vs_UltReconocimientoMedico> <filtros> <filtro> <field>dni</field> <value>12345678A</value> </filtro> </filtros> </GENERAL_Informes_Trabajadores_vs_UltReconocimientoMedico>
Respuesta
<GENERAL_Informes_Trabajadores_vs_UltReconocimientoMedicoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690557B324246204F9D42403246576214C4101B730015</key> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <puesto>Administrativo</puesto> <empresa> <key>4690556A2D535624569D550C711B127516</key> <nombre>EMPRESA PRUEBAS</nombre> </empresa> </item> <item> <key>4690557B324246204F9D42403246576214C81F1A790015</key> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <puesto>Administrativo</puesto> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <nombre>EMPRESA SL</nombre> </empresa> <reconocimiento> <key>4690557B3242461E779945402E4C472848DF171B79161D6214DF151D7717077315CE15</key> <fecha>2023-12-20T00:00:00</fecha> <renuncia>false</renuncia> <valoracion>APTO</valoracion> <documento> <key>4690556B0F607B054A9F5342254D502E56DF171D70131C7311</key> <tipo>12</tipo> <titulo>Certificado de aptitud TRABAJADOR 1 (20_12_2023) (A Solicitud del Trabajador) (12345678A)</titulo> <fichero>Certificado de aptitud TRABAJADOR 1 (20_12_2023) (A Solicitud del Trabajador) (12345678A).doc</fichero> </documento> </reconocimiento> </item> </result> </GENERAL_Informes_Trabajadores_vs_UltReconocimientoMedicoResponse>

 

Informes. Trabajadores vs últ. formación del art. 19

POST

Media Type URI
URI application/json
/api/gestion/inf/trabajadores/ult-form-art19
URI application/xml
/api/xml/gestion/inf/trabajadores/ult-form-art19

Listado de trabajadores junto con su última formación del artículo 19.
Se recomienda acotar el listado, puesto que por defecto, si no se envía ningún filtro, se listarán todos los que estén de alta en ese momento

Seguridad (permisos necesarios del usuario autenticado)

  • Listado de trabajadores vs última formación del art. 19 (consultas o informes)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará el trabajador que coincida con el key indicado
  • dni – buscará el trabajador que coincida con el dni indicado
  • ref – buscará el trabajador que coincida con el identificador indicado
  • nombre – buscará cualquier trabajador que contenga el texto en el nombre
  • estado – permitirá filtrar por el estado del trabajador:
    • 0 – todos (de alta y de baja)
    • 1 – sólo de alta (valor por defecto)
    • 2 – sólo de baja
  • keyemp – buscará trabajadores de la empresa que coincida con el key indicado
  • cif – buscará trabajadores de las empresas que coincidan con el cif indicado
  • empresa – buscará trabajadores de cualquier empresa que contenga el texto en el nombre
  • codemp – buscará trabajadores de cualquier empresa que contenga el texto en el código
  • estadoemp – permitirá filtrar por el estado de la empresa:
    • 0 – todas (de alta y de baja)
    • 1 – sólo de alta (valor por defecto)
    • 2 – sólo de baja
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of item)

Array de trabajadores que cumplen con el filtro

Type: item

key: String

Identificador único del trabajador en Prevengos

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

puesto: String

Puesto de trabajo del trabajador

curso: String

Título del curso

fecha: String

Fecha en la que realizó el curso

empresa: datosEmpresa

Datos de la empresa propietaria del trabajador

documento (opcional): datosDocumento

Datos del documento asociado (si lo tiene)

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

nombre: String

Nombre de la empresa

Type: datosDocumento

key: String

Identificador único del documento en Prevengos

tipo: Enum

Indica el tipo de documento

  • 28 – Certificado de formación del trabajador
titulo: String

Título del documento

fichero: String

Nombre del fichero

204 No content

La petición se ha realizado correctamente pero no existen registros que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/gestion/inf/trabajadores/ult-form-art19


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "dni","value": "12345678A"} ] }
Respuesta
{ "result": [ { "key": "4690557B324246204F9D42403246576214C4101B730015", "dni": "12345678A", "nombre": "TRABAJADOR 1", "puesto": "Administrativo", "curso": "Formación Básica según Art.19 Ley 31/95 de Prevención de Riesgos Laborales", "fecha": "/Date(1703026800000+0100)/", "empresa": { "key": "4690556A2D535624569D550C711B127516", "nombre": "EMPRESA PRUEBAS" }, "documento": { "key": "4690556B0F607B054A9F5342254D502E56DF171D70131C7310", "tipo": 28, "titulo": "Certificado de formación TRABAJADOR 1 (Formación Básica según Art.19 Ley 31/95 de Prevención de Riesgos Laborales) (20/12/2023) (12345678A)", "fichero": "Certificado de formación TRABAJADOR 1 (Formación Básica según Art.19 Ley 31_95 de Prevención de Riesgos Laborales) (20_12_2023) (12345678A).doc" } }, { "key": "4690557B324246204F9D42403246576214C81F1A790015", "dni": "12345678A", "nombre": "TRABAJADOR 1", "puesto": "Administrativo", "curso": "", "fecha": "/Date(-2208992400000+0100)/", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "nombre": "EMPRESA SL" } } ] }


application/xml
POST ... /api/xml/gestion/inf/trabajadores/ult-form-art19


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_Informes_Trabajadores_vs_UltFormArt19> <filtros> <filtro> <field>dni</field> <value>12345678A</value> </filtro> </filtros> </GENERAL_Informes_Trabajadores_vs_UltFormArt19>
Respuesta
<GENERAL_Informes_Trabajadores_vs_UltFormArt19Response> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <key>4690557B324246204F9D42403246576214C4101B730015</key> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <puesto>Administrativo</puesto> <curso>Formación Básica según Art.19 Ley 31/95 de Prevención de Riesgos Laborales</curso> <fecha>2023-12-20T00:00:00</fecha> <empresa> <key>4690556A2D535624569D550C711B127516</key> <nombre>EMPRESA PRUEBAS</nombre> </empresa> <documento> <key>4690556B0F607B054A9F5342254D502E56DF171D70131C7310</key> <tipo>28</tipo> <titulo>Certificado de formación TRABAJADOR 1 (Formación Básica según Art.19 Ley 31/95 de Prevención de Riesgos Laborales) (20/12/2023) (12345678A)</titulo> <fichero>Certificado de formación TRABAJADOR 1 (Formación Básica según Art.19 Ley 31_95 de Prevención de Riesgos Laborales) (20_12_2023) (12345678A).doc</fichero> </documento> </item> <item> <key>4690557B324246204F9D42403246576214C81F1A790015</key> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <puesto>Administrativo</puesto> <curso/> <fecha>1900-01-01T00:00:00</fecha> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <nombre>EMPRESA SL</nombre> </empresa> </item> </result> </GENERAL_Informes_Trabajadores_vs_UltFormArt19Response>

 

Informes. Datos registrados en un periodo

POST

Media Type URI
URI application/json
/api/gestion/inf/produccion
URI application/xml
/api/xml/gestion/inf/produccion

Devuelve el nº de datos registrados en Prevengos en un periodo de tiempo.
Se recomienda acotar el listado, puesto que por defecto, si no se envía ningún filtro, se obtendrá el nº de datos registrados de las empresas con permiso

Listado de datos que se pueden recuperar:

  • Nº de planes de prevención
  • Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • Nº de evaluaciones de seguridad
  • Nº de evaluaciones de higiene
  • Nº de evaluaciones de ergonomía
  • Nº de evaluaciones psicosociales
  • Nº de planes de emergencia
  • Nº de simulacros realizados
  • Nº de autorizaciones de trabajo
  • Nº de partes de inspección (de tipo visita)
  • Nº de partes de inspección (que no sean de tipo visita)
  • Nº de cursos de formación
  • Nº de trabajadores formados
  • Nº de reconocimientos abiertos
  • Nº de reconocimientos cerrados
  • Nº de reconocimientos renunciados
  • Nº de reconocimientos abiertos (iniciales)
  • Nº de reconocimientos cerrados (iniciales)
  • Nº de reconocimientos renunciados (iniciales)
  • Nº de reconocimientos abiertos (periódicos)
  • Nº de reconocimientos cerrados (periódicos)
  • Nº de reconocimientos renunciados (periódicos)
  • Nº de reconocimientos abiertos (tras ausencia prolongada)
  • Nº de reconocimientos cerrados (tras ausencia prolongada)
  • Nº de reconocimientos renunciados (tras ausencia prolongada)
  • Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • Nº de consultas médicas asistenciales
  • Nº de vacunas administradas (por tipo)
  • Nº de serologías administradas (por tipo)
  • Nº de accidentes cerrados
  • Nº de incidentes cerrados
  • Nº de accidentes biológicos cerrados
  • Nº de no conformidades cerradas
  • Nº de incidencias cerradas
  • Nº de actividades PAA médicas realizadas
  • Nº de actividades PAA técnicas realizadas
  • Nº de medidas de la acción preventiva implantadas

Seguridad (permisos necesarios del usuario autenticado)

  • Datos registrados en la aplicación en un periodo
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

ini (opcional): Date (aunque es opcional, con el fin de no saturar el servidor, se recomienda indicar un filtro acotado de máximo uno o dos años)

Fecha de inicio que quiere consultar (formato yyyy-MM-dd)

fin (opcional): Date (aunque es opcional, con el fin de no saturar el servidor, se recomienda indicar un filtro acotado de máximo uno o dos años)

Fecha de fin que quiere consultar (formato yyyy-MM-dd)

campos: String

Nombre de los campos que desea obtener (separados por comas)

  • numPlanPrev – Nº de planes de prevención
  • numEV – Nº total de evaluaciones de riesgo (sumando todas las especialidades)
  • numEV_Seg – Nº de evaluaciones de seguridad
  • numEV_Hig – Nº de evaluaciones de higiene
  • numEV_Erg – Nº de evaluaciones de ergonomía
  • numEV_Psi – Nº de evaluaciones psicosociales
  • numPlanEmer – Nº de planes de emergencia
  • numSimulacros – Nº de simulacros realizados
  • numAutorizaciones – Nº de autorizaciones de trabajo
  • numPartesInsVisita – Nº de partes de inspección (de tipo visita)
  • numPartesInsNoVisita – Nº de partes de inspección (que no sean de tipo visita)
  • numCursos – Nº de cursos de formación
  • numTrabsFormados – Nº de trabajadores formados
  • numRec_Abiertos – Nº de reconocimientos abiertos
  • numRec_Cerrados – Nº de reconocimientos cerrados
  • numRec_Renuncias – Nº de reconocimientos renunciados
  • numRecIni_Abiertos – Nº de reconocimientos abiertos (iniciales)
  • numRecIni_Cerrados – Nº de reconocimientos cerrados (iniciales)
  • numRecIni_Renuncias – Nº de reconocimientos renunciados (iniciales)
  • numRecPer_Abiertos – Nº de reconocimientos abiertos (periódicos)
  • numRecPer_Cerrados – Nº de reconocimientos cerrados (periódicos)
  • numRecPer_Renuncias – Nº de reconocimientos renunciados (periódicos)
  • numRecAus_Abiertos – Nº de reconocimientos abiertos (tras ausencia prolongada)
  • numRecAus_Cerrados – Nº de reconocimientos cerrados (tras ausencia prolongada)
  • numRecAus_Renuncias – Nº de reconocimientos renunciados (tras ausencia prolongada)
  • numRecTareas_Abiertos – Nº de reconocimientos abiertos (tras asignación de nuevas tareas)
  • numRecTareas_Cerrados – Nº de reconocimientos cerrados (tras asignación de nuevas tareas)
  • numRecTareas_Renuncias – Nº de reconocimientos renunciados (tras asignación de nuevas tareas)
  • numConsultasMed – Nº de consultas médicas asistenciales
  • numVacunas – Nº de vacunas administradas (por tipo) *
  • numSerologias – Nº de serologías administradas (por tipo) *
  • numAcc – Nº de accidentes cerrados
  • numInc – Nº de incidentes cerrados
  • numAccBio – Nº de accidentes biológicos cerrados
  • numNC – Nº de no conformidades cerradas
  • numIncidencias – Nº de incidencias cerradas
  • numPAAMed – Nº de actividades PAA médicas realizadas
  • numPAATec – Nº de actividades PAA técnicas realizadas
  • numMedidasImplantadas – Nº de medidas de la acción preventiva implantadas

* Los campos marcados con asterisco devolverán un array de valores en función del tipo

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • keyemp – buscará datos producidos de la empresa que coincida con el key indicado
  • cif – buscará datos producidos de las empresas que coincidan con el cif indicado
  • empresa – buscará datos producidos de cualquier empresa que contenga el texto en el nombre
  • codemp – buscará datos producidos de cualquier empresa que contenga el texto en el código
  • estado – permitirá filtrar por el estado de la empresa:
    • 0 – todas (de alta y de baja) (valor por defecto)
    • 1 – sólo de alta
    • 2 – sólo de baja
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

array (Of item)

Array de campos solicitados junto con el valor producido

Type: item (cualquier campo excepto numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

value: Integer

Nº de objetos registrados en el periodo solicitado

Type: item (sólo para numVacunas, numSerologias)

field: String

Nombre del campo que ha solicitado

values: array (Of item) – cualquier campo excepto numVacunas, numSerologias

Array de tipos obtenidos junto con el valor producido

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/gestion/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "ini": "2024-01-01", "fin": "2024-12-31", "campos": "numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAAMed,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas", "filtros": [ {"field": "estado","value": "0"} ] }
Respuesta
{ "result": [ { "field": "numPlanPrev", "value": "1" }, { "field": "numEV", "value": "90" }, { "field": "numEV_Seg", "value": "49" }, { "field": "numEV_Hig", "value": "31" }, { "field": "numEV_Erg", "value": "10" }, { "field": "numEV_Psi", "value": "0" }, { "field": "numPlanEmer", "value": "7" }, { "field": "numSimulacros", "value": "2" }, { "field": "numAutorizaciones", "value": "8" }, { "field": "numPartesInsVisita", "value": "3" }, { "field": "numPartesInsNoVisita", "value": "47" }, { "field": "numCursos", "value": "65" }, { "field": "numTrabsFormados", "value": "32" }, { "field": "numConsultasMed", "value": "7" }, { "field": "numVacunas", "values": [ { "field": "000002 - Antialérgica.", "value": "1" }, { "field": "000008 - Antineumocócica", "value": "1" } ] }, { "field": "numSerologias", "values": [ { "field": "001 - COVID19", "value": "2" }, { "field": "002 - GRIPE A", "value": "3" } ] }, { "field": "numAcc", "value": "2" }, { "field": "numInc", "value": "3" }, { "field": "numAccBio", "value": "2" }, { "field": "numNC", "value": "1" }, { "field": "numIncidencias", "value": "7" }, { "field": "numPAAMed", "value": "2" }, { "field": "numPAATec", "value": "2" }, { "field": "numRec_Abiertos", "value": "58" }, { "field": "numRec_Cerrados", "value": "17" }, { "field": "numRec_Renuncias", "value": "0" }, { "field": "numRecIni_Abiertos", "value": "6" }, { "field": "numRecIni_Cerrados", "value": "4" }, { "field": "numRecIni_Renuncias", "value": "0" }, { "field": "numRecPer_Abiertos", "value": "47" }, { "field": "numRecPer_Cerrados", "value": "12" }, { "field": "numRecPer_Renuncias", "value": "0" }, { "field": "numRecAus_Abiertos", "value": "2" }, { "field": "numRecAus_Cerrados", "value": "0" }, { "field": "numRecAus_Renuncias", "value": "0" }, { "field": "numRecTareas_Abiertos", "value": "1" }, { "field": "numRecTareas_Cerrados", "value": "0" }, { "field": "numRecTareas_Renuncias", "value": "0" }, { "field": "numMedidasImplantadas", "value": "37" } ] }


application/xml
POST ... /api/xml/gestion/inf/produccion


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<GENERAL_Listados_DatosProduccion_XML> <ini>2024-01-01</ini> <fin>2024-12-31</fin> <campos>numPlanPrev,numEV,numEV_Seg,numEV_Hig,numEV_Erg,numEV_Psi,numPlanEmer,numSimulacros,numAutorizaciones,numPartesInsVisita,numPartesInsNoVisita,numCursos,numTrabsFormados,numConsultasMed,numVacunas,numSerologias,numAcc,numInc, numAccBio,numNC,numIncidencias,numPAAMed,numPAATec,numRec_Abiertos,numRec_Cerrados,numRec_Renuncias,numRecIni_Abiertos,numRecIni_Cerrados,numRecIni_Renuncias,numRecPer_Abiertos,numRecPer_Cerrados,numRecPer_Renuncias,numRecAus_Abiertos,numRecAus_Cerrados,numRecAus_Renuncias,numRecTareas_Abiertos,numRecTareas_Cerrados,numRecTareas_Renuncias,numMedidasImplantadas</campos> <filtros> <filtro> <field>estado</field> <value>0</value> </filtro> </filtros> </GENERAL_Listados_DatosProduccion_XML>
Respuesta
<GENERAL_Listados_DatosProduccion_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <field>numPlanPrev</field> <value>1</value> </item> <item> <field>numEV</field> <value>90</value> </item> <item> <field>numEV_Seg</field> <value>49</value> </item> <item> <field>numEV_Hig</field> <value>31</value> </item> <item> <field>numEV_Erg</field> <value>10</value> </item> <item> <field>numEV_Psi</field> <value>0</value> </item> <item> <field>numPlanEmer</field> <value>7</value> </item> <item> <field>numSimulacros</field> <value>2</value> </item> <item> <field>numAutorizaciones</field> <value>8</value> </item> <item> <field>numPartesInsVisita</field> <value>3</value> </item> <item> <field>numPartesInsNoVisita</field> <value>47</value> </item> <item> <field>numCursos</field> <value>65</value> </item> <item> <field>numTrabsFormados</field> <value>32</value> </item> <item> <field>numConsultasMed</field> <value>7</value> </item> <item> <field>numVacunas</field> <values> <item> <field>000002 - Antialérgica.</field> <value>1</value> </item> <item> <field>000008 - Antineumocócica</field> <value>1</value> </item> </values> </item> <item> <field>numSerologias</field> <values> <item> <field>001 - COVID19</field> <value>2</value> </item> <item> <field>002 - GRIPE A</field> <value>3</value> </item> </values> </item> <item> <field>numAcc</field> <value>2</value> </item> <item> <field>numInc</field> <value>3</value> </item> <item> <field>numAccBio</field> <value>2</value> </item> <item> <field>numNC</field> <value>1</value> </item> <item> <field>numIncidencias</field> <value>7</value> </item> <item> <field>numPAAMed</field> <value>2</value> </item> <item> <field>numPAATec</field> <value>2</value> </item> <item> <field>numRec_Abiertos</field> <value>58</value> </item> <item> <field>numRec_Cerrados</field> <value>17</value> </item> <item> <field>numRec_Renuncias</field> <value>0</value> </item> <item> <field>numRecIni_Abiertos</field> <value>6</value> </item> <item> <field>numRecIni_Cerrados</field> <value>4</value> </item> <item> <field>numRecIni_Renuncias</field> <value>0</value> </item> <item> <field>numRecPer_Abiertos</field> <value>47</value> </item> <item> <field>numRecPer_Cerrados</field> <value>12</value> </item> <item> <field>numRecPer_Renuncias</field> <value>0</value> </item> <item> <field>numRecAus_Abiertos</field> <value>2</value> </item> <item> <field>numRecAus_Cerrados</field> <value>0</value> </item> <item> <field>numRecAus_Renuncias</field> <value>0</value> </item> <item> <field>numRecTareas_Abiertos</field> <value>1</value> </item> <item> <field>numRecTareas_Cerrados</field> <value>0</value> </item> <item> <field>numRecTareas_Renuncias</field> <value>0</value> </item> <item> <field>numMedidasImplantadas</field> <value>37</value> </item> </result> </GENERAL_Listados_DatosProduccion_XMLResponse>

 

Agenda médica. Listado citas (maestro-detalle)

GET

Media Type URI
URI application/json
/api/medicina/agendamedica/citas?i={inicio}&f={fin}
URI application/xml
/api/xml/medicina/agendamedica/citas?i={inicio}&f={fin}

Devuelve el listado de citas médicas que estén en el intervalo de fechas en formato maestro-detalle (cabecera + trabajadores citados)

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

inicio (opcional): Date

Fecha de inicio de las citas (formato yyyy-MM-dd)

fin (opcional): Date

Fecha de fin de las citas (formato yyyy-MM-dd)

Funcionalidad de los filtros:

  • No se indica filtro alguno

    Se filtrará por el mes en curso

  • Se indican ambas fechas

    Se filtrará por el intervalo de fechas indicadas

  • Se indica únicamente la fecha de inicio

    Se obtendrán todas las citas cuya fecha de la cita se encuentre en el intervalo de fechas desde la fecha pasada por parámetro hasta la misma fecha sumádole un año (es decir, un año completo)

  • Se indica únicamente la fecha de fin

    Se obtendrán todas las citas cuya fecha de la cita se encuentre en el intervalo de fechas desde la fecha pasada por parámetro (restándole un año) hasta la fecha pasada por parámetro (es decir, la operación inversa al punto anterior)

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: array (Of cabecera)

Array de citas médicas que cumplen con el filtro

Type: cabecera

key: String

Identificador único de la cabecera de la cita en Prevengos

fecha: Date

Fecha

hora: String

Hora de la cita (formato HH:mm)

empresa: datosEmpresa

Datos de la empresa propietaria de la cabecera

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

numCitados: Integer

Nº de trabajadores citados

numAsisten: Integer

Nº de trabajadores que han asistido

detalle: array (Of cita)

Array que contiene el detalle de los trabajadores citados

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

204 No content

La petición se ha realizado correctamente pero no existe ninguna cita médica que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/medicina/agendamedica/citas?i=2023-12-01&f=2023-12-31


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "46905579077C65264092424E6312177615C813", "fecha": "/Date(1702335600000+0100)/", "hora": "08:00", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "numCitados": 5, "numAsisten": 0, "detalle": [] }, { "key": "46905579077C65264092424E6312177615C811", "fecha": "/Date(1702422000000+0100)/", "hora": "07:30", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "numCitados": 10, "numAsisten": 0, "detalle": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] } ] }


application/xml
GET ... /api/xml/medicina/agendamedica/citas?i=2023-12-01&f=2023-12-31


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MEDICINA_AgendaMedica_Citas_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <cabecera> <key>46905579077C65264092424E6312177615C813</key> <fecha>2023-12-12T00:00:00</fecha> <hora>08:00</hora> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <numCitados>5</numCitados> <numAsisten>0</numAsisten> <detalle/> </cabecera> <cabecera> <key>46905579077C65264092424E6312177615C811</key> <fecha>2023-12-13T00:00:00</fecha> <hora>07:30</hora> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <numCitados>10</numCitados> <numAsisten>0</numAsisten> <detalle> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </detalle> </cabecera> </result> </MEDICINA_AgendaMedica_Citas_ListadoResponse>

 

Agenda médica. Buscar cita médica (maestro-detalle)

POST

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/buscar
URI application/xml
/api/xml/medicina/agendamedica/citas/buscar

Devuelve el listado de citas médicas que cumplen con el filtro indicado en formato maestro-detalle (cabecera + trabajadores citados)

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará la cita por el identificador único indicado
  • keyemp – buscará citas de la empresa con el identificador único indicado
  • keyclinica – buscará citas de la clínica o centro médico con el identificador único indicado
  • keymedico – buscará citas del médico con el identificador único indicado
  • inicio – buscará citas con fecha mayor o igual a la indicada (formato yyyy-MM-dd)
  • fin – buscará citas con fecha menor o igual a la indicada (formato yyyy-MM-dd)
  • cif – buscará citas de empresas cuyo CIF se parezca al indicado
  • codemp – buscará citas de empresas cuyo código se parezca al indicado
  • lugar – buscará citas cuyo lugar de la cita se parezca al indicado
  • clinica – buscará citas cuyo nombre de la clínica o centro médico asignado se parezca al indicado
  • medico – buscará citas cuyo nombre del médico asignado se parezca al indicado
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: array (Of cabecera)

Array de citas médicas que cumplen con el filtro

Type: cabecera

key: String

Identificador único de la cabecera de la cita en Prevengos

fecha: Date

Fecha

hora: String

Hora de la cita (formato HH:mm)

empresa: datosEmpresa

Datos de la empresa propietaria de la cabecera

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

numCitados: Integer

Nº de trabajadores citados

numAsisten: Integer

Nº de trabajadores que han asistido

detalle: array (Of cita)

Array que contiene el detalle de los trabajadores citados

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

204 No content

La petición se ha realizado correctamente pero no existe ninguna cita médica que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/medicina/agendamedica/citas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "lugar","value": "MURCIA"}, {"field": "keymedico","value": "4690556225474D224A8F051C79"}, {"field": "inicio","value": "2023-01-01"}, {"field": "fin","value": "2023-12-31"} ] }
Respuesta
{ "result": [ { "key": "46905579077C65264092424E6312177615C813", "fecha": "/Date(1702335600000+0100)/", "hora": "08:00", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "numCitados": 5, "numAsisten": 0, "detalle": [] }, { "key": "46905579077C65264092424E6312177615C811", "fecha": "/Date(1702422000000+0100)/", "hora": "07:30", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "numCitados": 10, "numAsisten": 0, "detalle": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] } ] }


application/xml
POST ... /api/xml/medicina/agendamedica/citas/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_Citas_Buscar> <filtros> <filtro> <field>lugar</field> <value>MURCIA</value> </filtro> <filtro> <field>keymedico</field> <value>4690556225474D224A8F051C79</value> </filtro> <filtro> <field>inicio</field> <value>2023-01-01</value> </filtro> <filtro> <field>fin</field> <value>2023-12-31</value> </filtro> </filtros> </MEDICINA_AgendaMedica_Citas_Buscar>
Respuesta
<MEDICINA_AgendaMedica_Citas_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <cabecera> <key>46905579077C65264092424E6312177615C813</key> <fecha>2023-12-12T00:00:00</fecha> <hora>08:00</hora> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <numCitados>5</numCitados> <numAsisten>0</numAsisten> <detalle/> </cabecera> <cabecera> <key>46905579077C65264092424E6312177615C811</key> <fecha>2023-12-13T00:00:00</fecha> <hora>07:30</hora> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <numCitados>10</numCitados> <numAsisten>0</numAsisten> <detalle> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </detalle> </cabecera> </result> </MEDICINA_AgendaMedica_Citas_BuscarResponse>

 

Agenda médica. Listado de trabajadores citados

GET

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/trabs?i={inicio}&f={fin}
URI application/xml
/api/xml/medicina/agendamedica/citas/trabs?i={inicio}&f={fin}

Devuelve el listado de trabajadores citados que estén en el intervalo de fechas

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

inicio (opcional): Date

Fecha de inicio de las citas (formato yyyy-MM-dd)

fin (opcional): Date

Fecha de fin de las citas (formato yyyy-MM-dd)

Funcionalidad de los filtros:

  • No se indica filtro alguno

    Se filtrará por el mes en curso

  • Se indican ambas fechas

    Se filtrará por el intervalo de fechas indicadas

  • Se indica únicamente la fecha de inicio

    Se obtendrán todas las citas cuya fecha de la cita se encuentre en el intervalo de fechas desde la fecha pasada por parámetro hasta la misma fecha sumádole un año (es decir, un año completo)

  • Se indica únicamente la fecha de fin

    Se obtendrán todas las citas cuya fecha de la cita se encuentre en el intervalo de fechas desde la fecha pasada por parámetro (restándole un año) hasta la fecha pasada por parámetro (es decir, la operación inversa al punto anterior)

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: array (Of cita)

Array de citas médicas que cumplen con el filtro

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyCab: String

Identificador único de la cabecera de la cita en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

fecha: Date

Fecha de la cita

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

empresa: datosEmpresa

Datos de la empresa propietaria de la cita

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

204 No content

La petición se ha realizado correctamente pero no existen registros que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
GET ... /api/medicina/agendamedica/citas/trabs?i=2023-12-01&f=2023-12-31


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyCab": "46905579077C65264092424E6312177615C811", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "fecha": "/Date(1702335600000+0100)/", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] }


application/xml
GET ... /api/xml/medicina/agendamedica/citas/trabs?i=2023-12-01&f=2023-12-31


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MEDICINA_AgendaMedica_CitasTrabs_ListadoResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyCab>46905579077C65264092424E6312177615C811</keyCab> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <fecha>2023-12-12T00:00:00</fecha> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </result> </MEDICINA_AgendaMedica_CitasTrabs_ListadoResponse>

 

Agenda médica. Buscar trabajadores citados

POST

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/trabs/buscar
URI application/xml
/api/xml/medicina/agendamedica/citas/trabs/buscar

Devuelve el listado de trabajadores citados que cumplen con el filtro indicado

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar

En el caso de enviar más de un filtro, se irán anidando para que se cumplan todas las condiciones (operador AND)

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • key – buscará la cita médica del trabajador por el identificador único indicado
  • keycita – buscará todos los trabajadores citados de la cita con el identificador único indicado
  • keyemp – buscará todos los trabajadores citados de la empresa con el identificador único indicado
  • keyclinica – buscará todos los trabajadores citados de la clínica o centro médico con el identificador único indicado
  • keymedico – buscará todos los trabajadores citados del médico con el identificador único indicado
  • keytrab – buscará todas las citas del trabajador con el identificador único indicado
  • inicio – buscará todos los trabajadores citados con fecha mayor o igual a la indicada (formato yyyy-MM-dd)
  • fin – buscará todos los trabajadores citados con fecha menor o igual a la indicada (formato yyyy-MM-dd)
  • cif – buscará todos los trabajadores citados de empresas cuyo CIF se parezca al indicado
  • codemp – buscará todos los trabajadores citados de empresas cuyo código se parezca al indicado
  • lugar – buscará todos los trabajadores citados cuyo lugar de la cita se parezca al indicado
  • clinica – buscará todos los trabajadores citados cuyo nombre de la clínica o centro médico asignado se parezca al indicado
  • medico – buscará todos los trabajadores citados cuyo nombre del médico asignado se parezca al indicado
  • dni – buscará todos los trabajadores citados cuyo dni se parezca al indicado
  • nombre – buscará todos los trabajadores citados cuyo nombre se parezca al indicado
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: array (Of cita)

Array de citas médicas que cumplen con el filtro

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyCab: String

Identificador único de la cabecera de la cita en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

fecha: Date

Fecha de la cita

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

empresa: datosEmpresa

Datos de la empresa propietaria de la cita

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

204 No content

La petición se ha realizado correctamente pero no existen registros que devolver

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/medicina/agendamedica/citas/trabs/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "filtros": [ {"field": "lugar","value": "MURCIA"}, {"field": "keymedico","value": "4690556225474D224A8F051C79"}, {"field": "inicio","value": "2023-01-01"}, {"field": "fin","value": "2023-12-31"}, {"field": "dni","value": "12345678A"} ] }
Respuesta
{ "result": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyCab": "46905579077C65264092424E6312177615C811", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "fecha": "/Date(1702335600000+0100)/", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] }


application/xml
POST ... /api/xml/medicina/agendamedica/citas/trabs/buscar


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_CitasTrabs_Buscar> <filtros> <filtro> <field>lugar</field> <value>MURCIA</value> </filtro> <filtro> <field>keymedico</field> <value>4690556225474D224A8F051C79</value> </filtro> <filtro> <field>inicio</field> <value>2023-01-01</value> </filtro> <filtro> <field>fin</field> <value>2023-12-31</value> </filtro> <filtro> <field>dni</field> <value>12345678A</value> </filtro> </filtros> </MEDICINA_AgendaMedica_CitasTrabs_Buscar>
Respuesta
<MEDICINA_AgendaMedica_CitasTrabs_BuscarResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyCab>46905579077C65264092424E6312177615C811</keyCab> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <fecha>2023-12-12T00:00:00</fecha> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </result> </MEDICINA_AgendaMedica_CitasTrabs_BuscarResponse>

 

Agenda médica. Ficha de la cita (maestro-detalle)

HEAD
GET

Media Type URI
URI application/json
/api/medicina/agendamedica/cita/{id}
URI application/xml
/api/xml/medicina/agendamedica/cita/{id}

Obtiene la ficha completa de la cita con el id indicado en formato maestro-detalle (cabecera + trabajadores citados)

Utilice el verbo HEAD si únicamente necesita comprobar si el id existe

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador de la cabecera de la cita médica

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: cabecera

Objeto que alberga los datos de la cita médica en formato maestro-detalle

Type: cabecera

key: String

Identificador único de la cabecera de la cita en Prevengos

fecha: Date

Fecha

hora: String

Hora de la cita (formato HH:mm)

empresa: datosEmpresa

Datos de la empresa propietaria de la cabecera

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

numCitados: Integer

Nº de trabajadores citados

numAsisten: Integer

Nº de trabajadores que han asistido

detalle: array (Of cita)

Array que contiene el detalle de los trabajadores citados

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La cita con el id indicado no existe.

 

Ejemplos

application/json
GET ... /api/medicina/agendamedica/cita/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": { "key": "46905579077C65264092424E6312177615C811", "fecha": "/Date(1702422000000+0100)/", "hora": "07:30", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "numCitados": 10, "numAsisten": 0, "detalle": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] } }


application/xml
GET ... /api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MEDICINA_AgendaMedica_Cita_ObtenerResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <key>46905579077C65264092424E6312177615C811</key> <fecha>2023-12-13T00:00:00</fecha> <hora>07:30</hora> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <numCitados>10</numCitados> <numAsisten>0</numAsisten> <detalle> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </detalle> </result> </MEDICINA_AgendaMedica_Cita_ObtenerResponse>

 

Agenda médica. Ficha de la cita (trabajadores)

GET

Media Type URI
URI application/json
/api/medicina/agendamedica/cita/{id}/trabs
URI application/xml
/api/xml/medicina/agendamedica/cita/{id}/trabs

Devuelve el listado de trabajadores citados de la cita con el id indicado

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador de la cabecera de la cita médica

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: array (Of cita)

Array de trabajadores citados

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

fecha: Date

Fecha de la cita

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

204 No Content

La petición se ha realizado correctamente, pero no existen trabajadores asociadados a la cita

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La cita con el id indicado no existe.

 

Ejemplos

application/json
GET ... /api/medicina/agendamedica/cita/46905579077C65264092424E6312177615C811/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": [ { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "fecha": "/Date(1702335600000+0100)/", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } ] }


application/xml
GET ... /api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312177615C811/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MEDICINA_AgendaMedica_Cita_ObtenerTrabajadoresResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <cita> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <fecha>2023-12-12T00:00:00</fecha> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </cita> </result> </MEDICINA_AgendaMedica_Cita_ObtenerTrabajadoresResponse>

 

Agenda médica. Ficha del trabajador citado

HEAD
GET

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/trabs/{id}
URI application/xml
/api/xml/medicina/agendamedica/citas/trabs/{id}

Obtiene la ficha completa del trabajador citado con el id indicado

Utilice el verbo HEAD si únicamente necesita comprobar si el id existe

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cita del trabajador en Prevengos

Cuerpo (body)

<Vacío>
Respuesta (response)

200 OK

La petición se ha ejecutado correctamente.

Body

result: cita

Objeto que contiene los datos de la cita del trabajador

Type: cita

key: String

Identificador único de la cita del trabajador en Prevengos

keyCab: String

Identificador único de la cabecera de la cita en Prevengos

keyTrab: String

Identificador único del trabajador en Prevengos

fecha: Date

Fecha de la cita

hora: String

Hora asignada a la cita del trabajador

dni: String

Dni del trabajador

nombre: String

Nombre del trabajador

empresa: datosEmpresa

Datos de la empresa propietaria de la cita

localidad: datosLocalidad

Datos del lugar de la cita

clinica: datosClinica

Datos de la clinica o centro médico

medico: datosMedico

Datos del médico asignado

keyTipo: String

Identificador único del tipo de cita en Prevengos

tipo: String

Tipo de cita

keyEstado: String

Identificador único del estado de la cita en Prevengos

estado: String

Estado de la cita

contrato: datosContrato

Datos del contrato asociado al reconocimiento médico asignado a la cita

asiste: Boolean

Indica si el trabajador ha asistido a la cita

cancelada: Boolean

Indica si la cita está cancelada

Type: datosEmpresa

key: String

Identificador único de la empresa en Prevengos

cif: String

CIF de la empresa

nombre: String

Nombre de la empresa

Type: datosLocalidad

key: String

Identificador único de la localidad en Prevengos

nombre: String

Nombre de la localidad

Type: datosClinica

key: String

Identificador único de la clínica en Prevengos

cif: String

CIF de la clínica o centro médico

nombre: String

Nombre de la clínica o centro médico

Type: datosMedico

key: String

Identificador único del médico en Prevengos

numCol: String

Nº de colegiado

nombre: String

Nombre del médico

Type: datosContrato

key: String

Identificador único del contrato en Prevengos

cod: String

Códico único del contrato asignado en Prevengos

ref: String

Referencia del contrato

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La cita del trabajador con el id indicado no existe.

 

Ejemplos

application/json
GET ... /api/medicina/agendamedica/citas/trabs/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
{ "result": { "key": "46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770", "keyCab": "46905579077C65264092424E6312177615C811", "keyTrab": "4690557B324246204F9D42403246576214C81F1A790015", "fecha": "/Date(1702335600000+0100)/", "hora": "07:30", "dni": "12345678A", "nombre": "TRABAJADOR 1", "empresa": { "key": "4690556A2D535624569D550C71171D741C", "cif": "B12345678", "nombre": "EMPRESA SL" }, "localidad": { "key": "469055632F40452D4C98474B2550077012CE", "nombre": "MURCIA" }, "clinica": { "key": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "cif": "B12345679", "nombre": "CLÍNICA MURCIA" }, "medico": { "key": "4690556225474D224A8F051C79", "numCol": "123456", "nombre": "MEDICO1 APELLIDO APELLIDO2" }, "keyTipo": "", "tipo": "", "keyEstado": "", "estado": "", "contrato": { "key": "4690556C2F4D50334488495C6311077506CE161D74", "cod": "00028/24", "ref": "REF0008" }, "asiste": false, "cancelada": false } }


application/xml
GET ... /api/xml/medicina/agendamedica/citas/trabs/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>
Respuesta
<MEDICINA_AgendaMedica_CitaTrabajador_ObtenerResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <key>46905579077C65264092424E1451452356DF171C7713107606CD1216751A0770</key> <keyCab>46905579077C65264092424E6312177615C811</keyCab> <keyTrab>4690557B324246204F9D42403246576214C81F1A790015</keyTrab> <fecha>2023-12-12T00:00:00</fecha> <hora>07:30</hora> <dni>12345678A</dni> <nombre>TRABAJADOR 1</nombre> <empresa> <key>4690556A2D535624569D550C71171D741C</key> <cif>B12345678</cif> <nombre>EMPRESA SL</nombre> </empresa> <localidad> <key>469055632F40452D4C98474B2550077012CE</key> <nombre>MURCIA</nombre> </localidad> <clinica> <key>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</key> <cif>B12345679</cif> <nombre>CLÍNICA MURCIA</nombre> </clinica> <medico> <key>4690556225474D224A8F051C79</key> <numCol>123456</numCol> <nombre>MEDICO1 APELLIDO APELLIDO2</nombre> </medico> <keyTipo/> <tipo/> <keyEstado/> <estado/> <contrato> <key>4690556C2F4D50334488495C6311077506CE161D74</key> <cod>00028/24</cod> <ref>REF0008</ref> </contrato> <asiste>false</asiste> <cancelada>false</cancelada> </result> </MEDICINA_AgendaMedica_CitaTrabajador_ObtenerResponse>

 

Agenda médica. Añadir cita médica

POST

Media Type URI
URI application/json
/api/medicina/agendamedica/cita
URI application/xml
/api/xml/medicina/agendamedica/cita

Crea la cita médica en la agenda médica de Prevengos con los datos necesarios que exige el aplicativo. En caso de éxito, devolverá el identificador de la cita en la respuesta.

No se realizará comprobación alguna en cuanto a disponibilidad, duplicidad de citas o cualquier otra comprobación. Será responsabilidad de quien consume la API quien deberá saber si puede o no ocupar la cita en la agenda o si la hora de la cita ya esá asociada a otra empresa y/o trabajador.

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

fecha: String

Fecha de la cita (formato yyyy-MM-dd)

hora: String

Hora de la cita (formato HH:mm)

keyempresa: String

Identificador único de la empresa

keylocalidad: String

Identificador único de la localidad o lugar de la cita

keyclinica: String

Identificador único de la clínica o centro médico

keymedico: String

Identificador único del médico

numtrabs: Integer

Número de trabajadores citados (valor mínimo: 1)

observaciones (opcional): String

Observaciones de la cita (máximo 1000 caracteres)

Respuesta (response)

201 Created

La cita médica se ha creado correctamente.

Header

Location: URI

Contiene la URI del objeto que acabamos de crear

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

message: String

Identificador único de la cita médica que se acaba de crear

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

422 Unprocesable Entity

La solicitud está bien formada, pero la cita médica no se ha creado.

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 101 – El identificador único no es válido
  • 102 – El identificador único no existe
  • 103 – Está intentando dar de alta una cita asociándolo a un objeto de baja (por ejemplo, el médico o la clínica están desactivados, etc)
  • 104 – La empresa no está de alta en vigilancia de la salud
  • 200 – La hora de la cita no existe según la configuración de la agenda médica de Prevengos
  • 300 – La petición no se ajusta a los requisitos descritos en este manual (falta un dato, o un dato no cumple con los requisitos, etc)
  • 9999 – Error no definido
message: String

Texto descriptivo del error

 

Ejemplos

application/json
POST ... /api/medicina/agendamedica/cita


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "fecha": "2023-12-31", "hora": "09:45", "keyempresa": "4690556A2D535624569D550C711B127516", "keylocalidad": "469055632F40452D4C98474B255007701DCE", "keyclinica": "4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC", "keymedico": "4690556225474D224A8F051C79", "numtrabs": 1 }
Respuesta

Header

Location: ~/api/medicina/agendamedica/cita/46905579077C65264092424E6312177615C910

Body

{ "result": { "message": "46905579077C65264092424E6312177615C910" } }


application/xml
POST ... /api/xml/medicina/agendamedica/cita


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_Cita_Add> <fecha>2023-12-31</fecha> <hora>09:45</hora> <keyempresa>4690556A2D535624569D550C711B127516</keyempresa> <keylocalidad>469055632F40452D4C98474B255007701DCE</keylocalidad> <keyclinica>4690556C2C4A4A28469D556C2F4D47245788474B2150077014CC</keyclinica> <keymedico>4690556225474D224A8F051C79</keymedico> <numtrabs>1</numtrabs> </MEDICINA_AgendaMedica_Cita_Add>
Respuesta

Header

Location: ~/api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312177615C911

Body

<MEDICINA_AgendaMedica_Cita_AddResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <message>46905579077C65264092424E6312177615C911</message> </result> </MEDICINA_AgendaMedica_Cita_AddResponse>

 

Agenda médica. Editar cita médica

PATCH

Media Type URI
URI application/json
/api/medicina/agendamedica/cita/{id}
URI application/xml
/api/xml/medicina/agendamedica/cita/{id}

Actualiza los datos de la cita médica que se indiquen en el cuerpo del mensaje

Únicamente se reemplazarán los datos enviados en el cuerpo (no toda la cita, sino únicamente los datos que se indiquen).

No se realizará comprobación alguna en cuanto a disponibilidad, duplicidad de citas o cualquier otra comprobación. Será responsabilidad de quien consume la API quien deberá saber si puede o no ocupar la cita en la agenda o si la hora de la cita ya esá asociada a otra empresa y/o trabajador.

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cabecera de la cita médica

Cuerpo (body)

fecha (opcional): String

Fecha de la cita (formato yyyy-MM-dd)

hora (opcional): String

Hora de la cita (formato HH:mm)

keylocalidad (opcional): String

Identificador único de la localidad o lugar de la cita

keyclinica (opcional): String

Identificador único de la clínica o centro médico

keymedico (opcional): String

Identificador único del médico

numtrabs (opcional): Integer

Número de trabajadores citados (valor mínimo: 1)

observaciones (opcional): String

Observaciones de la cita (máximo 1000 caracteres)

Respuesta (response)

204 No Content

La cita médica se ha modificado correctamente.

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

422 Unprocesable Entity

La solicitud está bien formada, pero la cita médica no se ha modificado por algún dato no válido.

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 101 – El identificador único no es válido
  • 102 – El identificador único no existe
  • 103 – Está intentando modificar una cita asociándolo a un objeto de baja (por ejemplo, el médico o la clínica están desactivados, etc)
  • 200 – La hora de la cita no existe según la configuración de la agenda médica de Prevengos
  • 300 – La petición no se ajusta a los requisitos descritos en este manual (falta un dato, o un dato no cumple con los requisitos, etc)
  • 9999 – Error no definido
message: String

Texto descriptivo del error

423 Locked

La cita mé está bloqueada o en sólo lectura

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 103 – Está intentando modificar una cita de una empresa de cancelada o de baja
  • 423 – La cita está en uso por otro usuario
message: String

Texto descriptivo del error

 

Ejemplos

application/json
PATCH ... /api/medicina/agendamedica/cita/46905579077C65264092424E6312177615C910


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "numtrabs": 10, "observaciones": "Se actualiza el nº de trabajadores citados" }

application/xml
PATCH ... /api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312177615C910


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_Cita_Edit> <numtrabs>10</numtrabs> <observaciones>Se actualiza el nº de trabajadores citados</observaciones> </MEDICINA_AgendaMedica_Cita_Edit>

 

Agenda médica. Eliminar cita médica

DELETE

Media Type URI
URI application/json
/api/medicina/agendamedica/cita/{id}
URI application/xml
/api/xml/medicina/agendamedica/cita/{id}

Elimina la cita médica junto con todos los trabajadores asociados a ella

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cabecera de la cita médica

Cuerpo (body)

<Vacío>
Respuesta (response)

204 No Content

La cita médica ha sido eliminada con éxito

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La cita médica con el id indicado no existe.

423 Locked

La cita médica está en uso por otro usuario. No puede eliminarla en este momento

 

Ejemplos

application/json
DELETE ... /api/medicina/agendamedica/cita/46905579077C65264092424E6312


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>

application/xml
DELETE ... /api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>

 

Agenda médica. Añadir trabajador a la cita médica

POST

Media Type URI
URI application/json
/api/medicina/agendamedica/cita/{id}/trabs
URI application/xml
/api/xml/medicina/agendamedica/cita/{id}/trabs

Añade el trabajador a la cita médica pasada por parámetro. En caso de éxito, devolverá el identificador único de la cita del trabajador en la respuesta.

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cabecera de la cita médica

Cuerpo (body)

keytrab: String

Identificador único del trabajador en Prevengos

hora (opcional): String

Hora de la cita (formato HH:mm)

Si no se indica una hora concreta, se le asignará la misma que la indicada en la cita médica

keytipo (opcional): String

Identificador único del tipo de cita médica

keyestado (opcional): String

Identificador único del estado de la cita médica

observaciones (opcional): String

Observaciones de la cita (máximo 2000 caracteres)

Respuesta (response)

201 Created

El trabajador ha sido añadido a la cita con éxito.

Header

Location: URI

Contiene la URI del objeto que acabamos de crear

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

message: String

Identificador único de la cita médica del trabajador

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

409 Conflict

El trabajador ya existe en la cita médica.

422 Unprocesable Entity

La solicitud está bien formada, pero no se ha podido añadir el trabajador en la cita médica por algún error.

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 101 – El identificador único no es válido
  • 102 – El identificador único no existe
  • 103 – Está intentando añadir un trabajador a la cita y existe algún objeto de baja (por ejemplo, la empresa o el trabajador están desactivados, etc)
  • 200 – La hora de la cita no existe según la configuración de la agenda médica de Prevengos
  • 300 – La petición no se ajusta a los requisitos descritos en este manual (falta un dato, o un dato no cumple con los requisitos, etc)
  • 9999 – Error no definido
message: String

Texto descriptivo del error

 

Ejemplos

application/json
POST ... /api/medicina/agendamedica/cita/46905579077C65264092424E6312177615C813/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "keytrab": "4690557B324246204F9D42403246576214C81F1A790015" }
Respuesta

Header

Location: ~/api/medicina/agendamedica/citas/trabs/46905579077C65264092424E1451452356DF171C7713107406CD1216751A0770

Body

{ "result": { "message": "46905579077C65264092424E1451452356DF171C7713107406CD1216751A0770" } }


application/xml
POST ... /api/xml/medicina/agendamedica/cita/46905579077C65264092424E6312177615C813/trabs


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_Cita_AddTrab> <keytrab>4690557B324246204F9D42403246576214C81F1A790015</keytrab> </MEDICINA_AgendaMedica_Cita_AddTrab>
Respuesta

Header

Location: ~/api/xml/medicina/agendamedica/citas/trabs/46905579077C65264092424E1451452356DF171C7713107406CD1216751A0770

Body

<MEDICINA_AgendaMedica_Cita_AddTrabResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <message>46905579077C65264092424E1451452356DF171C7713107406CD1216751A0770</message> </result> </MEDICINA_AgendaMedica_Cita_AddTrabResponse>

 

Agenda médica. Editar ficha de la cita del trabajador

PATCH

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/trabs/{id}
URI application/xml
/api/xml/medicina/agendamedica/citas/trabs/{id}

Actualiza los datos de la ficha de datos de la cita del trabajador que se indiquen en el cuerpo del mensaje

Únicamente se reemplazarán los datos enviados en el cuerpo (no toda la cita del trabajador, sino únicamente los datos que se indiquen).

No se realizará comprobación alguna de lógica de datos. Será responsabilidad de quien consume la API quien deberá saber si puede o no ocupar la cita en la agenda o si la hora de la cita ya esá asociada a otra empresa y/o trabajador.

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cita médica del trabajador

Cuerpo (body)

hora (opcional): String

Hora de la cita (formato HH:mm)

Si no se indica una hora concreta, se le asignará la misma que la indicada en la cita médica

keytipo (opcional): String

Identificador único del tipo de cita médica

keyestado (opcional): String

Identificador único del estado de la cita médica

asiste (opcional): Enum
  • 0 – marca la cita como que "El trabajador no ha asistido a la cita"
  • 1 – marca la cita como que "El trabajador ha asistido a la cita"
hora_entrada_centro (opcional): String

Indica la hora a la que el trabajador ha entrado al centro médico (formato HH:mm)

hora_entrada_consulta (opcional): String

Indica la hora a la que el trabajador ha entrado en consulta (formato HH:mm)

hora_salida_consulta (opcional): String

Indica la hora a la que el trabajador ha salido de la consulta (formato HH:mm)

hora_salida_centro (opcional): String

Indica la hora a la que el trabajador ha salido del centro médico (formato HH:mm)

observaciones (opcional): String

Observaciones de la cita del trabajador (máximo 2000 caracteres)

cancelada (opcional): Enum
  • 0 – establece la cita como activa
  • 1 – marca la cita como que ha sido cancelada
Respuesta (response)

204 No Content

La cita médica del trabajador se ha modificado correctamente.

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

422 Unprocesable Entity

La solicitud está bien formada, pero la cita médica no se ha modificado por algún dato no válido.

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 101 – El identificador único no es válido
  • 102 – El identificador único no existe
  • 200 – La hora de la cita no existe según la configuración de la agenda médica de Prevengos
  • 300 – La petición no se ajusta a los requisitos descritos en este manual (falta un dato, o un dato no cumple con los requisitos, etc)
  • 9999 – Error no definido
message: String

Texto descriptivo del error

423 Locked

La cita mé está bloqueada o en sólo lectura

Body

result: resultado

Objeto que contiene el resultado de la operación

Type: resultado

errorCode: Integer

Código de error asociado al mensaje

  • 103 – Está intentando modificar una cita de una empresa de cancelada o de baja, o de un trabajador desactivado
  • 423 – La cita está en uso por otro usuario
message: String

Texto descriptivo del error

 

Ejemplos

application/json
PATCH ... /api/medicina/agendamedica/citas/trabs/46905579077C65264092424E1451452356DF150C71171D741CDF17


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

{ "asiste": "1", "observaciones": "Se actualizan las observaciones y se pone como que ha asistido" }

application/xml
PATCH ... /api/xml/medicina/agendamedica/citas/trabs/46905579077C65264092424E1451452356DF150C71171D741CDF17


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<MEDICINA_AgendaMedica_Cita_EditTrab> <asiste>1</asiste> <observaciones>Se actualizan las observaciones y se pone como que ha asistido</observaciones> </MEDICINA_AgendaMedica_Cita_EditTrab>

 

Agenda médica. Eliminar trabajador de la cita médica

DELETE

Media Type URI
URI application/json
/api/medicina/agendamedica/citas/trabs/{id}
URI application/xml
/api/xml/medicina/agendamedica/citas/trabs/{id}

Elimina la cita médica del trabajador

Seguridad (permisos necesarios del usuario autenticado)

  • Gestión de la agenda médica (medicina)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Parámetros (query parameters)

id: String

Identificador único de la cita del trabajador en Prevengos

Cuerpo (body)

<Vacío>
Respuesta (response)

204 No Content

La cita médica del trabajador ha sido eliminada con éxito

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

404 Not Found

La cita del trabajador con el id indicado no existe.

423 Locked

La cita del trabajador está en uso por otro usuario. No puede eliminarla en este momento

 

Ejemplos

application/json
DELETE ... /api/medicina/agendamedica/citas/trabs/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>

application/xml
DELETE ... /api/xml/medicina/agendamedica/citas/trabs/46905579077C65264092424E6312177615C813


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

<Vacío>

 

Control de accesos. Estado de la documentación requerida a nivel general (contratas)

POST

Media Type URI
URI application/json
/api/cae/accesos/estado/doc/contratas/general
URI application/xml
/api/xml/cae/accesos/estado/doc/contratas/general

Devuelve el estado de la documentación requerida a nivel general de las contratas que coincidan con los CIFs/Códigos de contrata especificados.

Podrá devolver:

  • OK: La documentación a nivel general está validada y no caducada (teniendo en cuenta tolerancia)
  • KO: Uno/varios documentos no son válidos
  • ERROR: La contrata no ha podido ser identificada (ver errores en la especificación de la respuesta)
Consideraciones a tener cuenta para catalogar un documento como válido
  • Estar validado y no caducado en la fecha que se consulta (teniendo en cuenta la tolerancia)
  • No estar con errores en la cola de sincronización de datos (SSDP)

Consideraciones a tener cuenta para localizar las contratas

Si el usuario que consume esta función no tiene limitación de empresas podrá consultar cualquier contrata que esté en el mantenimiento.
En el caso de que está limitado a poder consultar únicamente un conjunto de empresas, las contratas que podrá consultar serán aquellas que estén especificadas en sus proyectos de coordinación (calculándose el estado de la misma en función de cómo esté en el conjunto de sus proyectos: activa o desactivada).

Seguridad (permisos necesarios del usuario autenticado)

  • Estado de la documentación requerida a nivel general para control de accesos (contratas)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

obj: String

Identificadores de las contratas que se quiere consultar (separados por comas)

Los caracteres permitidos para este parámetro son: "A-Z", "0-9" y "," (sin comillas)
Tanto el CIF como el código de la contrata deberán estar debidamente mecanizadas en el servidor de Prevengos (teniendo en cuenta la limitación de caracteres)

t (opcional): Enum
  • cif – establece que se buscarán las contratas por CIF (valor por defecto)
  • cod – establece que se buscarán las contratas por código de contrata
filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar para obtener el estado de la documentación

Por defecto, si no se indica lo contrario, se obtendrá el estado de toda la documentación requerida (obligatoria o no) a fecha actual

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • fecha – fecha a tener en cuenta para conocer el estado de la documentación (formato yyyy-MM-dd)
  • tipo – permite filtrar si queremos obtener el estado de:
    • 0 – todos los documentos requeridos a nivel general (obligatorios y no obligatorios) (valor por defecto)
    • 1 – sólo documentos obligatorios requeridos a nivel general
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de resultados

Type: item

emp: String

CIF o Código de la contrata

doc: Enum

Estado de la documentación requerida a nivel general

  • OK: La documentación a nivel general está validada y no caducada
  • KO: Uno/varios documentos no son válidos
  • ERROR: La contrata no ha podido ser identificada (ver código de error específico en el campo errorCode)

errorCode (opcional): Integer

Código de error que indica por qué no se ha podido obtener el estado de la documentación

  • 101 – No existe ninguna contrata con el identificador indicado
  • 102 – Se ha encontrado la contrata pero está desactivada
  • 103 – Se han encontrado dos o más contratas con el mismo identificador activas (cif o código)

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/cae/accesos/estado/doc/contratas/general


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

En este ejemplo queremos obtener el estado de estas 5 contratas teniendo en cuenta sólo la documentación obligatoria

{ "obj": "6868745SH,14587269A,B1245789,12345678A,B78548254", "t": "cif", "filtros": [ {"field": "tipo","value": "1"} ] }
Respuesta
{ "result": [ { "emp": "6868745SH", "doc": "OK" }, { "emp": "14587269A", "doc": "ERROR", "errorCode": "101" }, { "emp": "B1245789", "doc": "ERROR", "errorCode": "101" }, { "emp": "12345678A", "doc": "ERROR", "errorCode": "102" }, { "emp": "B78548254", "doc": "KO" } ] }


application/xml
POST ... /api/xml/cae/accesos/estado/doc/contratas/general


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

En este ejemplo queremos obtener el estado de estas 5 contratas teniendo en cuenta sólo la documentación obligatoria

<CAE_CtrlAcc_EstadoDocReq_Contratas_General_XML> <obj>6868745SH,14587269A,B1245789,12345678A,B78548254</obj> <t>cif</t> <filtros> <filtro> <field>tipo</field> <value>1</value> </filtro> </filtros> </CAE_CtrlAcc_EstadoDocReq_Contratas_General_XML>
Respuesta
<CAE_CtrlAcc_EstadoDocReq_Contratas_General_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <emp>6868745SH</emp> <doc>OK</doc> </item> <item> <emp>14587269A</emp> <doc>ERROR</doc> <errorCode>101</errorCode> </item> <item> <emp>B1245789</emp> <doc>ERROR</doc> <errorCode>101</errorCode> </item> <item> <emp>12345678A</emp> <doc>ERROR</doc> <errorCode>102</errorCode> </item> <item> <emp>B78548254</emp> <doc>KO</doc> </item> </result> </CAE_CtrlAcc_EstadoDocReq_Contratas_General_XMLResponse>

 

Control de accesos. Estado de la documentación requerida a nivel general (trabajadores)

POST

Media Type URI
URI application/json
/api/cae/accesos/estado/doc/trabs/general
URI application/xml
/api/xml/cae/accesos/estado/doc/trabs/general

Devuelve el estado de la documentación requerida a nivel general de los trabajadores que coincidan con los identificadores consultados.

Podrá devolver:

  • OK: La documentación de la contrata y el trabajador a nivel general está validada y no caducada (teniendo en cuenta tolerancia)
  • KO: Uno/varios documentos del trabajador no son válidos
  • CONTRATA_KO: Uno/varios documentos de la contrata no son válidos
  • DNI_BLOQUEADO: El DNI se encuentra en la "lista de DNIs con acceso bloqueado"
  • ERROR: La contrata y/o el trabajador no han podido ser identificados (ver errores en la especificación de la respuesta)
Consideraciones a tener cuenta para catalogar un documento como válido
  • Estar validado y no caducado en la fecha que se consulta (teniendo en cuenta la tolerancia)
  • No estar con errores en la cola de sincronización de datos (SSDP)

Consideraciones a tener cuenta para localizar las contratas

Si el usuario que consume esta función no tiene limitación de empresas podrá consultar cualquier contrata que esté en el mantenimiento.
En el caso de que está limitado a poder consultar únicamente un conjunto de empresas, las contratas que podrá consultar serán aquellas que estén especificadas en sus proyectos de coordinación (calculándose el estado de la misma en función de cómo esté en el conjunto de sus proyectos: activa o desactivada).

Consideraciones a tener cuenta a la hora de encontrar al trabajador

Para localizar y obtener el estado documental del trabajador primero se obtiene el estado documental de la contrata. Si se localiza la contrata y la documentación de la contrata es válida, se buscará al trabajador en ella (obteniendo el estado documental del trabajador). En el caso de que el dni no existiera en la contrata (o estuviera desactivado) el sistema intentará localizar al trabajador en la lista de contratas por su dni (entendiendo que puede ser un autónomo), devolviendo el estado de la documentación de la ficha del autónomo en su caso (en este caso, siempre se buscará al autónomo buscando por CIF en el mantenimiento de contratas).

Seguridad (permisos necesarios del usuario autenticado)

  • Estado de la documentación requerida a nivel general para control de accesos (trabajadores)
Petición (request)

Cabecera (header)

Authorizacion

Credenciales de acceso a la API según el esquema de autenticación requerido

Cuerpo (body)

obj: String

Identificadores de los trabajadores (CODIGO-DNI) que se quieren consultar (separados por comas) donde:

  • CODIGO – Identificador de la contrata (cif o código)
  • DNI – DNI del trabajador que se quiere consultar

Los caracteres permitidos para este parámetro son: "A-Z", "0-9", "-" y "," (sin comillas)
Tanto el cif, código de la contrata y/o dni del trabajador deberán estar debidamente mecanizados en el servidor de Prevengos (teniendo en cuenta la limitación de caracteres)

t (opcional): Enum
  • cif – establece que se buscarán las contratas por CIF (valor por defecto)
  • cod – establece que se buscarán las contratas por código de contrata
filtros: array (Of filtro)

Array de parámetros o filtros que se quieren aplicar para obtener el estado de la documentación

Por defecto, si no se indica lo contrario, se obtendrá el estado de toda la documentación requerida (obligatoria o no) a fecha actual

Type: filtro

field: Enum

Campo por el que se va a filtrar

  • fecha – fecha a tener en cuenta para conocer el estado de la documentación (formato yyyy-MM-dd)
  • tipo – permite filtrar si queremos obtener el estado de:
    • 0 – todos los documentos requeridos a nivel general (obligatorios y no obligatorios) (valor por defecto)
    • 1 – sólo documentos obligatorios requeridos a nivel general
value: String

Valor (o filtro) que se está aplicando sobre el campo indicado

Respuesta (response)

200 OK

La petición se ha realizado correctamente.

Cuerpo (body)

result: array (Of item)

Array de resultados

Type: item

emp: String

Cif o código de la contrata

dni: String

Dni del trabajador

doc: Enum

Estado de la documentación requerida a nivel general

  • OK: La documentación de la contrata y el trabajador a nivel general está validada y no caducada (teniendo en cuenta tolerancia)
  • KO: Uno/varios documentos del trabajador no son válidos
  • CONTRATA_KO: Uno/varios documentos de la contrata no son válidos
  • DNI_BLOQUEADO: El DNI se encuentra en la "lista de DNIs con acceso bloqueado"
  • ERROR: La contrata y/o el trabajador no han podido ser identificados (ver código de error específico en el campo errorCode)

errorCode (opcional): Integer

Código de error que indica por qué no se ha podido obtener el estado de la documentación

  • 101 – No existe ninguna contrata con el identificador indicado
  • 102 – Se ha encontrado la contrata pero está desactivada
  • 103 – Se han encontrado dos o más contratas con el mismo identificador activas (cif o código)
  • 104 – No se ha encontrado un trabajador con el dni indicado en la contrata identificada
  • 105 – Se ha encontrado el trabajador pero está desactivado
  • 106 – Se han encontrado dos o más trabajadores con el mismo identificador activos

400 Bad Request

La solicitud no se ajusta con los datos que se solicitan. Compruebe que está enviando los datos tal y como se indican en este manual

401 Unauthorized

Usuario no autenticado

403 Forbidden

No posee los permisos necesarios para realizar la petición.

 

Ejemplos

application/json
POST ... /api/cae/accesos/estado/doc/trabs/general


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

En este ejemplo queremos obtener el estado de estos 4 trabajadores teniendo en cuenta sólo la documentación obligatoria

{ "obj": "6868745SH-124525,6868745SH-12345678A,12345678A-B78548254,B78548254-12345678A", "t": "cif", "filtros": [ {"field": "tipo","value": "1"} ] }
Respuesta
{ "result": [ { "emp": "12345678A", "dni": "B78548254", "doc": "ERROR", "errorCode": "102" }, { "emp": "6868745SH", "dni": "12345678A", "doc": "KO" }, { "emp": "6868745SH", "dni": "124525", "doc": "ERROR", "errorCode": "104" }, { "emp": "B78548254", "dni": "12345678A", "doc": "CONTRATA_KO" } ] }


application/xml
POST ... /api/xml/cae/accesos/estado/doc/trabs/general


Header

Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==

Body

En este ejemplo queremos obtener el estado de estos 4 trabajadores teniendo en cuenta sólo la documentación obligatoria

<CAE_CtrlAcc_EstadoDocReq_Trabajadores_General_XML> <obj>6868745SH-124525,6868745SH-12345678A,12345678A-B78548254,B78548254-12345678A</obj> <t>cif</t> <filtros> <filtro> <field>tipo</field> <value>1</value> </filtro> </filtros> </CAE_CtrlAcc_EstadoDocReq_Trabajadores_General_XML>
Respuesta
<CAE_CtrlAcc_EstadoDocReq_Trabajadores_General_XMLResponse> <result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <item> <emp>12345678A</emp> <dni>B78548254</dni> <doc>ERROR</doc> <errorCode>102</errorCode> </item> <item> <emp>6868745SH</emp> <dni>12345678A</dni> <doc>KO</doc> </item> <item> <emp>6868745SH</emp> <dni>124525</dni> <doc>ERROR</doc> <errorCode>104</errorCode> </item> <item> <emp>B78548254</emp> <dni>12345678A</dni> <doc>CONTRATA_KO</doc> </item> </result> </CAE_CtrlAcc_EstadoDocReq_Trabajadores_General_XMLResponse>