Hércules

Árbol de páginas

  • Creado por Usuario desconocido (lorena.alvarez), modificado por última vez por Usuario desconocido (alicia.alvarez) el mar 24, 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 7 Siguiente »

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

TipoIdentificador

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

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, Microempresa, ...)
TipoEmpresa 
{ 
    "id":"tem-001",
    "nombre": "PYME"   
}

Servicios

Método

URL

Parámetros

Respuesta

Permisos

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}idEmpresa
Detalle 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 básicos (formly) con los campos necesarios para crear una empresa.

GET/datos-contacto/empresa/{id}idDatosContacto
Contiene los datos de contacto de una empresa. En principio, únicamente la dirección de contacto.
GET

/datos-contacto/formly/create


Formly
Devuelve 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}idDatosTipoEmpresa
Detalle de los datos de tipo de empresa de una empresa.
GET

/datos-tipo-empresa/formly/create


Formly
Devuelve 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

  • Sin etiquetas