...
| Tabla de contenidos |
|---|
...
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. |
| 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". |
| razonSocial | String | Razón social de la empresa. |
| datosEconomicos | 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 | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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
| 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
| Nombre | Tipo | Descripción |
|---|---|---|
| direccion | 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 | ||||
|---|---|---|---|---|
|
Objeto EmpresaEconomica (es una PersonaJuridica):
- personaRef
- personaRefPadre
- tipo (se evalúa en el front, si personaRefPadre es null tipo = Entidad, y sino tipo = Subentidad)
- razonSocial
- tipoDocumento (si es una entidad hija en este campo se pone "Código subentidad")
- numeroDocumento (Número de documento existirá para las Entidades padres, para las entidades hijas no tienen número de documento, pero tienen otro código de identificación. Utilizaremos este campo para guardar los dos tipos de identificadores, será la concatenación del numeroDocumento de la entidad padre_codigo entidad hija)
- direccion (se concatenarán el dato de nombreVia, número, codigoPostal del Domicilio)
- tipoEmpresa
API
...
|
...
|
EmpresaEconomica
...
Método
...
URL
...
Parámetros
...
Respuesta
...
Permisos
...
Descripción
...
Colectivo
...
Método
...
URL
...
Parámetros
...
Respuesta
...
Permisos
...
Descripción
...
Documentación API
http://192.168.3.127:8280/API-SGP:v1.0.0?swaggertryit