Hércules

Árbol de páginas

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.
TipoIdentificadorListado con los tipos de identificador fiscal (CIF, VAT, ...).
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.

IMPORTANTE

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.
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",
	"datosEconomicos": false,
    "padreId": "ent-001"
}

TipoIdentificador

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



DatosContacto


NombreTipoDescripción
direccionStringDirección de contacto de la empresa.
DatosContacto 
{
	"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

id

Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona.

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/tipos-identificador
Lista[TipoIdentificador]Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente.

Métodos donde el SGI solo hace de pasarela entre Universidad y CVN (No son necesarios para el funcionamiento del SGI)
GET/empresas/modificadas-ids

q+s

La query estará formada por:

  • fechaModificacion
Lista[String]Listado de los identificadores de empresas que han sufrido cambios en los datos de identificativos de la empresa o en sus datos de contacto.

  • Sin etiquetas