Hércules

Árbol de páginas

  • Creado por Usuario desconocido (lorena.alvarez), modificado por última vez por Usuario desconocido (alicia.alvarez) el mar 15, 2021

Estás viendo una versión antigua de esta página. Ve a la versión actual.

Comparar con el actual Ver el historial de la página

« Anterior Versión 5 Siguiente »

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, ...).
TipoEmpresaListado con los tipos de empresa (PYME, AAPP, ...).

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.
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".
Empresa 
{
    "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

NombreTipoDescripción
idStringIdentificador de la entidad TipoIdentificador
nombreStringNombre (Posibles valores: CIF, VAT, ...)
TipoIdentificador 
{ 
    "id":"tp-1",
    "nombre": "CIF"   
}

DatosEntidad

NombreTipoDescripción
tipoEntidadStringUn 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".
DatosEntidad 
{ 
	"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ón
direccionContactoStringDirección de contacto de la empresa
DatosContacto 
{
    "direccionContacto": "C/ Uria número 4, puerta A"
}

DatosTipoEmpresa

NombreTipoDescripción
tipoEmpresaTipoEmpresaTipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos.
DatosTipoEmpresa 
{ 
    "tipoEmpresa": {
    	"id": "tem-002",
    	"nombre": "PYME"
	}
}

TipoEmpresa

NombreTipoDescripción
idStringIdentificador de la entidad TipoEmpresa.
nombreStringNombre (Posibles valores: PYME, AAPP, ...)
TipoEmpresa 
{ 
    "id":"tem-001",
    "nombre": "AAPP"   
}

Servicios

Método

URL

Parámetros

Respuesta

Permisos

Descripción

GET/personas

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.

GET/personas/{personaRef}personaRefPersona
Detalle de los datos generales de una persona
GET/personas/formly/create 
Formly

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

POST/personasJSON

Recibe como parámetro la respuesta del usuario del formulario de datos básicos (formly) con los campos necesarios para crear una persona

GET/datos-personales/persona/{personaRef}personaRef

DatosPersonales


Detalle de los datos personales de una persona (datos de dirección, nacimiento, etc)
GET

/datos-personales/formly/create


Formly
Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona, pestaña "Datos personales". Ver  IU-ESB-0010-003 - Solicitar alta de persona
POST/datos-personalesJSON

Recibe como parámetro la respuesta del usuario del formulario de datos personales (formly) con los campos necesarios para crear la entidad de datos personales de una persona. En el formulario se deben de incluir el campo personaRef para saber de quien se trata (campo oculto)

GET/datos-contacto/persona/{personaRef}personaRefDatosContacto
Contiene la lista de email y/o de teléfonos de una persona
GET

/datos-contacto/formly/create


Formly
Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona, pestaña "Datos contacto". Ver IU-ESB-0010-003 - Solicitar alta de persona
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 persona. En el formulario se deben de incluir el campo personaRef para saber de quien se trata (campo oculto)

GET/vinculaciones/persona/{personaRef}personaRefVinculacion
Detalle de los datos de vinculación de una persona
GET

/vinculaciones/formly/create


Formly
Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona, pestaña "Datos vinculación". Ver IU-ESB-0010-003 - Solicitar alta de persona
POST/vinculacionesJSON

Recibe como parámetro la respuesta del usuario del formulario de vinculación (formly) con los campos necesarios para crear la vinculación de la universidad de la persona. En el formulario se deben de incluir el campo personaRef para saber de quien se trata (campo oculto)

GET/datos-academicos/persona/{personaRef}personaRefDatosContacto
Contiene el nivel académico de la persona
GET

/datos-academicos/formly/create


Formly
Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona, pestaña "Datos académicos". Ver IU-ESB-0010-003 - Solicitar alta de persona
POST/datos-academicosJSON

Recibe como parámetro la respuesta del usuario del formulario de datos académicos (formly) con los campos necesarios para crear los datos académicos de una persona. En el formulario se deben de incluir el campo personaRef para saber de quien se trata (campo oculto)






GET/colectivos
Lista[Colectivo]

Listado de colectivos ordenados alfabéticamente de forma ascendente







GET/tipo-documentos
Lista[TipoDocumento]
Listado de tipos de documento de identificación personal ordenados alfabéticamente de forma ascendente

GET/categoria-profesionales
Lista[CategoriaProfesional]
Listado de categorías profesionales ordenados alfabéticamente de forma ascendente

GET/subcategoria-profesionales/{idCategoria}idCategoriaLista[SubcateroriaProfesional]
Listado de subcategorías profesionales vinculadas a la categoría pasado por parámetro ordenados alfabéticamente de forma ascendente

GET/nivel-academicos
Lista[NivelAcademico]
Listado de niveles académicos ordenados alfabéticamente de forma ascendente

GET/personas/{personaRef}/fotografia
Fotografia
Detalle de la fotografía digital de la persona

Documentación API

http://gitlab.treelogic.local/operaciones/hercules/sgi/sgi-esb/external-services/sgp-service/-/blob/master/src/main/resources/sgp-openapi.yaml

  • Sin etiquetas