Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 14

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

comparado con

Nueva versión 15

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

Tabla de contenidos

Sistema de gestión de empresas

Entidades

EntidadDescripción
EmpresaContiene los datos básicos de una empresa.
DatosContactoContiene los datos de contacto de la empresa.
DatosTipoEmpresaContiene 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), como puede ser por ejemplo su tamaño.
TipoIdentificadorListado con los tipos de identificador fiscal (CIF, VAT, ...).
TipoEmpresaListado con los tipos de empresa (necesario para las empresas con datos económicos).
EmpresaClasificacion

Listado de relaciones entre empresas y clasificaciones. Las empresas se relacionarán únicamente con las clasificaciones del tipo "Sector Industrial". Ver definición de clasificaciones en SGI - ESB - SGO.

Info
titleIMPORTANTE

La relación entre empresas y clasificaciones de tipo "Sector industrial" se considera algo que puede generalizarse a cualquier empresa y no algo específico de las empresas con las que se relaciona UM, es por ello que se ha modelado a nivel lógico en el diagrama.

Al no haberse identificado por el momento necesidad de gestionar en ningún punto del SGI como producto, sino solamente en los formularios específicos de UM, la clasificación de una empresa no se ha modelado a nivel de objetos de transferencia del API ni tiene servicios específicos para su gestión.

Modelo lógico

API

Características generales que todas las API REST deben de cumplir:

Definición de los objetos

Empresa


NombreTipoDescripción
idStringIdentificador de la empresa.
nombreStringNombre de la empresa.
tipoIdentificadorTipoIdentificadorTipo de identificador fiscal de la empresa. Se devuelve la entidad TipoIdentificador con todos sus campos.
numeroIdentificacionStringNúmero de identificación fiscal de la empresa del tipo indicado en "tipoIdentificador".
razonSocialStringRazón social de la empresa.
datosEconomicosBooleanIndicador de si se trata de una empresa con datos económicos (está dada de alta en GENTE y en JUSTO) o sin datos económicos (está dada de alta solo en GENTE).
padreIdStringIdentificador de la empresa padre o entidad principal. Estará informado en el caso de empresas que son subentidad de otra.
Bloque de código
languagejava
themeRDark
titleEmpresa
collapsetrue
{
    "id": "ent-002",
    "nombre": "Empresa de Prueba",
    "tipoIdentificador": {
          "id":"tp-1",
          "nombre":"CIF"
     },
    "numeroIdentificacion": "H11111111",
    "razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
	"datosEconomicos": false,
    "padreId": "ent-001"
}

TipoIdentificador

NombreTipoDescripción
idStringIdentificador de la entidad TipoIdentificador.
nombreStringNombre (Posibles valores: CIF, VAT, ...).
Bloque de código
languagejava
themeRDark
titleTipoIdentificador
collapsetrue
{ 
    "id":"tp-1",
    "nombre": "CIF"   
}


DatosTipoEmpresa

NombreTipoDescripción
tipoEmpresaTipoEmpresaTipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos.
Bloque de código
languagejava
themeRDark
titleTipoTercero
collapsetrue
TipoEmpresa
NombreTipoDescripción
idStringIdentificador de la entidad TipoEmpresa.
nombreStringNombre.
DatosContacto
NombreTipoDescripción
direccionContactoStringDirección de contacto de la empresa.
 Bloque de código
languagejava
themeRDark
titleDatosContacto
collapsetrue
{
	"direccion": "C/ Uría, número 4, puerta A, 33002, Oviedo, Asturias, España"
}

Servicios
Método
URL
Parámetros
Respuesta
Descripción
GET/empresas
q+s (query + sort)
La query estará formada por:
  • id
  • nombre
  • razonSocial
  • numeroIdentificacion
Lista[Empresa]
Listado de Empresa.
Ejemplo:
nombre=like=(Tree);(razonSocial=like=SL)
GET/empresas/{id}idEmpresaDetalle de los datos generales de una empresa.
GET/empresas/formly/create 
Formly
Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos generales". Ver IU-GEN-0081 - Solicitar alta de empresa.
POST/empresasJSON
Recibe como parámetro la respuesta del usuario del formulario de datos de alta (formly) con los campos necesarios para crear una empresa.
PUT/empresasJSON
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}
JSONDevuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly).

GET/datos-contacto/empresa/{id}idDatosContactoContiene los datos de contacto de una empresa.
GET
/datos-contacto/formly/create

FormlyDevuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos contacto". Ver IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de contacto
POST/datos-contactoJSON
Recibe como parámetro la respuesta del usuario del formulario de datos contacto (formly) con los campos necesarios para crear los datos de contacto de una empresa. En el formulario se deben de incluir el campo id de Empresa para saber de qué empresa se trata (campo oculto).

GET/datos-tipo-empresa/empresa/{id}idDatosTipoEmpresaDetalle de los datos de tipo de empresa de una empresa.
GET
/datos-tipo-empresa/formly/create

FormlyDevuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos de tipo de empresa". Ver IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de tipo de empresa
POST/datos-tipo-empresaJSON
Recibe como parámetro la respuesta del usuario del formulario de vinculación (formly) con los campos necesarios para los datos de tipo de empresa de la empresa. En el formulario se deben de incluir el campo id de Empresa para saber de qué empresa se trata (campo oculto).





GET/tipos-identificador
Lista[TipoIdentificador]Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente.

GET/tipos-empresa
Lista[TipoEmpresa]Listado de tipos de empresa ordenados alfabéticamente de forma ascendente.
Documentación API
http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml