Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 4

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.
DatosEntidadContiene los datos que identifican si la empresa es una entidad o una subentidad (sede, sucursal, ...) de otra entidad principal y de cuál concretamente.
DatosContactoContiene los datos de contacto de la empresa
, a priori, únicamente la dirección postal
.
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, ...).
TipoEmpresa
EmpresaClasificacion

Listado

con los tipos de empresa (PYME, AAPP, ...)

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

Image Modified

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.razonSocialStringRazón social 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".
Bloque de códigolanguage
javathemeRDarktitleEmpresacollapsetrue{ "id": "ent-002", "nombre": "Empresa de Prueba", "
razonSocial
": "Empresa que es mayoritariamente de prueba del SGI", "tipoIdentificador": { "id":"tp-1", "nombre":"CIF" }, "numeroIdentificacion": "H11111111" }

TipoIdentificador

Nombreid
TipoDescripción
String
Identificador
Razón social de la
entidad TipoIdentificador
empresa.
nombre
datosEconomicos
StringNombre (Posibles valores: CIF, VAT, ...)
Bloque de código
languagejava
themeRDark
titleTipoIdentificador
collapsetrue
{ 
    "id":"tp-1",
    "nombre": "CIF"   
}

DatosEntidad

BooleanIndicador 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
NombreTipoDescripcióntipoEntidadStringUn valor dentro de los definidos en enumerado interno del SGI "TipoEntidad".entidadPrincipalEmpresaEntidad de tipo Empresa únicamente con los datos generales de la empresa principal de la que la empresa es subentidad. Solo estará informada si el valor de "tipoEntidad" se corresponde con el tipo "Subentidad"
.
Bloque de código
languagejava
themeRDark
titleDatosEntidadEmpresa
collapsetrue
{ 
	"tipoEntidad":"Subentidad",
    "entidadPrincipal": {
    	"id": "ent-002",
    	"nombre": "Empresa de Prueba",
    	"razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
    	"tipoIdentificador": {
          	"id":"tp-1",
          	"nombre":"CIF"
     	},
    	"numeroIdentificacion": "H11111111"
	}
}

DatosContacto

NombreTipoDescripcióndireccionContactoStringDirección de contacto de la empresa
Bloque de código
languagejava
themeRDark
titleDatosContacto
collapsetrue
{,
    "direccionContactorazonSocial": "C/Empresa Uriaque númeroes 4, puerta A"
}

DatosTipoEmpresa

...

languagejava
themeRDark
titleDatosTipoEmpresa
collapsetrue

...

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
title

...

TipoIdentificador
collapsetrue
{ 
    "id":"

...

tp-

...

1",
    "nombre": "

...

CIF"   
}

...


DatosContacto

...

Método

...

URL

...

Parámetros

...

Respuesta

...


NombreTipoDescripción

...

direccion

...

q+s (query + sort)

La query estará formada por:

  • tipoColectivo
  • colectivoRef
  • nombre
  • apellidos
  • numeroDocumento
  • personaRef

...

Lista[Persona]

...

Listado de Persona.

Ejemplo:

colectivoRef=in=(refPAS,refPDI);(nombre=like=11111111H,apellidos=like=11111111H,numeroDocumento=like=11111111H)

Nota: tipoColetivo y colectivoRef son mutuamente excluyentes. En el caso se recibir un tipoColectivo se traducirá a los colectivos que lo formen.

StringDirecció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

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

...

Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona, pestaña "Datos básicos". Ver  IU-GEN-0061- Solicitar alta de persona

...

DatosPersonales

...

/datos-personales/formly/create

...

/datos-contacto/formly/create

...

/vinculaciones/formly/create

...

/datos-academicos/formly/create

...

Listado de colectivos 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