...
Entidad | Descripción |
---|---|
Empresa (EmpresaUM) | Contiene los datos básicos de una empresa. |
DatosContacto (DatosContactoUM) | Contiene los datos de contacto de la empresa. |
DatosTipoEmpresa | Contiene los datos relativos a la tipología de la empresa, estando esta tipología basada en criterios diversos (los que se establezcan por parte de la universidad o sistema externo). |
TipoIdentificador | Listado con los tipos de identificador fiscal (CIF, VAT, ...). |
TipoTercero | Listado con los tipos de tercero (necesario para las empresas con datos económicos). |
TipoEmpresa | Listado con los tipos de empresa (necesario para las empresas con datos económicos). |
TipoEmpresaContabilidad | Listado con los tipos de empresa para contabilidad (necesario para las empresas con datos económicos). |
TipoTerceroReinoUnido | Listado con los tipos de tercero para Reino Unido (necesario para las empresas con datos económicos cuyo país es el Reino Unido). |
EmpresaClasificacion (EmpresaUMClasificacion) | Listado de relaciones entre empresas y clasificaciones. En principio, únicamente con las del tipo "Código CNAE" también llamado "Sector Industrial". Ver definición de clasificaciones en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO). |
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
Definición de los objetos
...
Nombre | Tipo | Descripción |
---|---|---|
paisContacto | Pais | Se devuelve la entidad Pais con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO). |
comAutonomaContacto | ComunidadAutonoma | Se devuelve la entidad ComunidadAutonoma con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO). |
provinciaContacto | Provincia | Se devuelve la entidad Provincia con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO). |
ciudadContacto | String | Ciudad de contacto de la empresa. |
codigoPostal | String | Código postal de la empresa. |
tipoVia | TipoVia | Tipo de vía de la dirección de contacto de la empersa. Se devuelve la entidad TipoVia con todos sus campos. Ver definición en Sistema Gestión de Organizaciones (UM - SGI - ESB - SGO). |
nombreVia | String | Nombre de la vía de la dirección de contacto de la empresa. |
numero | String | Número de la vía de la dirección de contacto de la empresa. |
ampliacion | String | Campo para ampliar la informaicón de la dirección de contacto de la empresa. |
String | Email de contacto de la empresa. | |
fax | String | Fax de contacto de la empresa. |
telefono | String | Teléfono de contacto de la empresa. |
direccionWeb | String | Dirección web de la empresa. |
...
Método | URL | Parámetros | Respuesta | Descripción | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /empresas | q+s (query + sort) La query estará formada por:
| Lista[Empresa] | Listado de Empresa. Ejemplo: nombre=like=SL, razonSocial=like=SL | ||||||||||||||||
GET | /empresas/{id} | Empresa | Detalle de los datos generales de una empresa. | |||||||||||||||||
POST | /empresas/formly | JSON | id Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona. | Recibe como parámetro la respuesta del usuario del formulario de datos de alta (formly) con los campos necesarios para crear una empresa.
| ||||||||||||||||
PUT | /empresas/formly/{id} | JSON | Recibe como parámetro la respuesta del usuario del formulario de datos de modificación (formly) con los campos necesarios para actualizar una empresa.
| |||||||||||||||||
GET | /empresas/formly/{id} | JSON | Devuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly). Se recibirá el mismo json que en la solicitud de modificación de empresa (/empresas PUT) | |||||||||||||||||
GET | /datos-contacto/empresa/{id} | DatosContacto | Contiene los datos de contacto de una empresa. Ver UM - SGI - ESB - SGEMP - Adaptaciones integración para su implementación en el SGI. | |||||||||||||||||
GET | /empresas-clasificaciones/empresa/{id} | EmpresaClasificacion | Listado de las clasificaciones de tipo códigos CNAE o sectores industriales asociados a una empresa. | |||||||||||||||||
GET | /datos-tipo-empresa/empresa/{id} | DatosTipoEmpresa | Detalle de los datos de tipo de empresa de una empresa. | |||||||||||||||||
GET | /tipos-identificador | Lista[TipoIdentificador] | Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente. | |||||||||||||||||
GET | /tipos-tercero | Lista[TipoTercero] | Listado de tipos de tercero ordenados alfabéticamente de forma ascendente. | |||||||||||||||||
GET | /tipos-empresa | Lista[TipoEmpresa] | Listado de tipos de empresa ordenados alfabéticamente de forma ascendente. | |||||||||||||||||
GET | /tipos-empresa-contabilidad | Lista[TipoEmpresaContabilidad] | Listado de tipos de empresa para contabilidad ordenados alfabéticamente de forma ascendente. | |||||||||||||||||
GET | /tipos-tercero-reino-unido | Lista[TipoTerceroReinoUnido] | Listado de tipos de tercero, en caso de que el país sea Reino Unido, ordenados alfabéticamente de forma ascendente. | |||||||||||||||||
Métodos donde el SGI solo hace de pasarela entre Universidad y CVN | ||||||||||||||||||||
GET | /empresas/modificadas-ids | q+s La query estará formada por:
| Lista[String] | Listado de los identificadores de empresas que han sufrido cambios en los datos de identificativos de la empresa o en sus datos de contacto (entidad Empresa y entidad DatosContacto) |
...