Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 10

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

Guardado el

comparado con

Nueva versión Actual

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.

...

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, ...).
TipoTercero
EmpresaClasificacion

Listado

con los tipos de tercero (necesario para las empresas con datos económicos).TipoEmpresaListado con los tipos de empresa (necesario para las empresas con datos económicos).TipoEmpresaContabilidad

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

Listado con los tipos de empresa para contabilidad (necesario para las empresas con datos económicos)

.

Modelo lógico

Image Modified

API

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

...


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
...

 Bloque de código
languagejava
themeRDark
titleDatosTipoEmpresa
collapsetrue
{
    "tipoTercero": {
        "id":"tt-1",
        "nombre": "Personas jurídicas españolas"  
    },
    "tipoEmpresa": {
        "id":"te-1",
        "nombre": "Empr. extranjeras"  
    }, 
    "tipoEmpresaContabilidad": {
        "id":"tec-1",
        "nombre": "Otros entes del sector público, empresa o institución privada"  
    }
}
TipoTercero
...
 Bloque de código
languagejava
themeRDark
titleTipoTercero
collapsetrue
{ 
    "id":"tt-1",
    "nombre": "Personas jurídicas españolas"   
}
TipoEmpresa
...
 Bloque de código
languagejava
themeRDark
titleTipoEmpresa
collapsetrue
{ 
    "id":"te-1",
    "nombre": "Empr. extranjeras"   
}
TipoEmpresaContabilidad
NombreTipoDescripciónidStringIdentificador de la entidad TipoEmpresaContabilidad.nombreStringNombre.
 Bloque de código
languagejava
themeRDark
titleTipoEmpresaContabilidad
collapsetrue
{ 
    "id":"tec-1",
    "nombre": "Otros entes del sector público, empresa o institución privada"   
}
DatosContacto

direccionContacto
NombreTipoDescripción
paisContactoPais
Se devuelve la entidad Pais con todos sus campos. Ver definición en SGI - ESB - SGO.
comAuntonomaContactoComunidadAutonoma
Se devuelve la entidad ComunidadAutonoma con todos sus campos. Ver definición en SGI - ESB - SGO.
provinciaContactoProvincia
Se devuelve la entidad Provincia con todos sus campos. Ver definición en SGI - ESB - SGO.
ciudadContactoStringCiudad de contacto de la empresa.
direccion
StringDirección de contacto 
 de la empresa.direccionWebStringDirección web 
 de la empresa.
 Bloque de código
languagejava
themeRDark
titleDatosContacto
collapsetrue
{
	"paisContactodireccion": {
       "id":"33",
       "nombre":"España"
     },
    "comAuntonomaContacto": {
       "id":"ca-3",
       "nombre":"Asturias"
     }, 
    "provinciaContacto": {
       "id":"pro-1",
       "nombre":"Asturias"
     }, 
	"ciudadContacto": "Oviedo",
    "direccionContacto": "C/ Uría número 4, puerta A",
	"direccionWeb": "www.empresadeprueba.es"
}
Servicios
...
Método
...
URL
...
Parámetros
...
Respuesta
...
Permisos
...
Descripción
...
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)
...
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.
"C/ Uría, número 4, puerta A, 33002, Oviedo, Asturias, España"
}

Servicios
 Info
Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sgemp, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso.
 Incluir página
SGI - ESB - SGEMP - Servicios Básicos
SGI - ESB - SGEMP - Servicios Básicos
 Incluir página
SGI - ESB - SGEMP - Servicios Formly
SGI - ESB - SGEMP - Servicios Formly
 Incluir página
SGI - ESB - SGEMP - Servicios Pasarela
SGI - ESB - SGEMP - Servicios Pasarela
...
/datos-contacto/formly/create
...
/datos-tipo-empresa/formly/create
...
Documentación API
http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml