...
Sistema de gestión de empresas
Entidades
Entidad | Descripción |
---|---|
Empresa | Contiene los datos básicos de una empresa. |
DatosEntidad | Contiene los datos que identifican si la empresa es una entidad o una subentidad (sede, sucursal, ...) de otra entidad principal y de cuál concretamente. |
DatosContacto | Contiene los datos de contacto de la empresa, a priori, únicamente la dirección postal. |
DatosTipoEmpresa | Contiene 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. |
TipoIdentificador | Listado con los tipos de identificador fiscal (CIF, VAT, ...). |
TipoEmpresa | Listado 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
Persona
...
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". |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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
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"
} |
DatosEntidad
Nombre | Tipo | Descripción |
---|---|---|
tipoEntidad | String | Un valor dentro de los definidos en enumerado interno del SGI "TipoEntidad". |
entidadPrincipal | Empresa | Entidad 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". |
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
Nombre | Tipo | Descripción |
---|---|---|
direccionContacto | String | Dirección de contacto de la empresa |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"direccionContacto": "C/ Uria número 4, puerta A"
} |
DatosTipoEmpresa
Nombre | Tipo | Descripción |
---|---|---|
tipoEmpresa | TipoEmpresa | Tipo de empresa. Se devuelve la entidad TipoEmpresa con todos sus campos. |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"tipoEmpresa": {
"id": "tem-002",
"nombre": "PYME"
}
} |
TipoEmpresa
Nombre | Tipo | Descripción |
---|---|---|
id | String | Identificador de la entidad TipoEmpresa. |
nombre | String | Nombre (Posibles valores: PYME, AAPP, ...) |
Bloque de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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:
| Lista[ |
Colectivo
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} | personaRef | Persona | 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 | /personas | JSON | 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-personales | JSON | 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} | personaRef | DatosContacto | 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-contacto | JSON | 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} | personaRef | Vinculacion | 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 | /vinculaciones | JSON | 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} | personaRef | DatosContacto | 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-academicos | JSON | 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} | idCategoria | Lista[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.yamlhttp://192.168.3.127:8280/API-SGP:v1.0.0?swaggertryit