...
Sistema de gestión de empresas
Entidades
Entidad | Descripción |
---|---|
Empresa | Contiene los datos básicos de una empresa. |
DatosContacto | Contiene los datos de contacto de la empresa |
. |
TipoIdentificador | Listado 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.
|
Modelo lógico
API
Características generales que todas las API REST deben de cumplir:
Definición de los objetos
Empresa
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la empresa. |
nombre | String | Nombre de la empresa. |
razonSocial | String | Razón social de la empresa. |
tipoIdentificador | TipoIdentificador | Tipo de identificador fiscal de la empresa. Se devuelve la entidad TipoIdentificador con todos sus campos. |
numeroIdentificacion | String | Número de identificación fiscal de la empresa del tipo indicado en "tipoIdentificador". |
language | java |
---|---|
theme | RDark |
title | Empresa |
collapse | true |
razonSocial |
TipoIdentificador
String |
Razón social de la |
empresa. |
datosEconomicos |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id":"tp-1",
"nombre": "CIF"
} |
DatosEntidad
Boolean | Indicador 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). | |
padreId | String | Identificador de la empresa padre o entidad principal. Estará informado en el caso de empresas que son subentidad de otra |
. |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ , "direccionContactorazonSocial": "C/Empresa Uriaque númeroes 4, puerta A" } |
DatosTipoEmpresa
...
language | java |
---|---|
theme | RDark |
title | DatosTipoEmpresa |
collapse | true |
...
mayoritariamente de prueba del SGI", "datosEconomicos": false, |
...
" |
...
padreId": " |
...
ent-001" |
...
} |
...
...
TipoIdentificador
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad |
...
TipoIdentificador. | ||
nombre | String | Nombre (Posibles valores: |
...
CIF, |
...
VAT, ...). |
Bloque de código | |||||
---|---|---|---|---|---|
|
...
| |||
{
"id":" |
...
tp- |
...
1", "nombre": " |
...
CIF" } |
...
DatosContacto
...
Método
...
URL
...
Parámetros
...
Respuesta
...
Permisos
Nombre | Tipo | Descripción |
---|
...
direccion |
...
q+s (query + sort)
La query estará formada por:
- nombre
- razonSocial
- numeroIdentificacion
- empresaRef
...
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.
...
DatosEntidad
...
/datos-entidad/formly/create
...
/datos-contacto/formly/create
...
String | Dirección de contacto de la empresa. |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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 | ||||
---|---|---|---|---|
|
Incluir página | ||||
---|---|---|---|---|
|
Incluir página | ||||
---|---|---|---|---|
|
...
/datos-tipo-empresa/formly/create
...