Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 6

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

comparado con

Nueva versión 7

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

EntidadDescripción
EmpresaContiene los datos básicos de una empresa.
DatosEntidadContiene los datos que identifican si la empresa es una entidad o una subentidad (sede, sucursal, ...) de otra entidad principal y de cuál concretamente.
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

Image Modified

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.razonSocialStringRazón social 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.
Bloque de código
languagejava
themeRDark
titleEmpresa
collapsetrue
{
    "id": "ent-002",
    "nombre": "Empresa de Prueba",
    "razonSocial": "Empresa que es mayoritariamente de prueba del SGI",
    "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, ...).
Bloque de código
languagejava
themeRDark
titleTipoIdentificador
collapsetrue
{ 
    "id":"tp-1",
    "nombre": "CIF"   
}

DatosEntidad

NombreTipoDescripcióntipoEntidadStringUn valor dentro de los definidos en enumerado interno del SGI "TipoEntidad".entidadPrincipal
EmpresaEntidad 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
languagejava
themeRDark
titleDatosEntidad
collapsetrue
{ 
	"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
NombreTipoDescripción
direccionContactoStringDirección de contacto de la empresa.

 Bloque de código
languagejava
themeRDark
titleDatosContacto
collapsetrue
{
    "direccionContacto": "C/ Uria número 4, puerta A"
}
DatosTipoEmpresa
...
NombreTipoDescripción
idStringIdentificador de la entidad TipoEmpresa.
nombreStringNombre (Posibles valores: PYME, AAPPMicroempresa, ...)
 Bloque de código
languagejava
themeRDark
titleTipoEmpresa
collapsetrue
{ 
    "id":"tem-001",
    "nombre": "AAPPPYME"   
}
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
  • empresaRef
Lista[Empresa]

Listado de Empresa.
Ejemplo:
nombre=like=(Tree);(razonSocial=like=SL)
GET/empresas/{empresaRefid}empresaRefidEmpresa
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-entidadcontacto/empresa/{empresaRefid}empresaRefidDatosEntidadDatosContacto
Detalle de Contiene los datos de entidad contacto de una empresa (tipo de entidad, entidad principal en caso de ser una subentidad, etc).GET
/datos-entidad/formly/create
FormlyDevuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos empresa". Ver  IU-ESB-0020-003 - Solicitar alta de empresa - Formulario de datos de entidad.POST/datos-entidadJSONRecibe como parámetro la respuesta del usuario del formulario de datos de entidad (formly) con los campos necesarios para crear la entidad de datos de entidad de una empresa. En el formulario se deben de incluir el campo empresaRef para saber de qué empresa se trata (campo oculto).GET/datos-contacto/empresa/{empresaRef}empresaRefDatosContactoContiene . En principio, únicamente la dirección de contacto de una empresa.
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 empresaRef campo id de Empresa para saber de qué empresa se trata (campo oculto).

GET/datos-tipo-empresa/empresa/{empresaRefid}empresaRefidDatosTipoEmpresa
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 empresaRef campo id de Empresa para saber de qué empresa se trata (campo oculto).






GET/tipotipos-identificadoresidentificador
Lista[TipoIdentificador]
Listado de tipos de identificadores fiscales identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente.

GET/tipotipos-empresasempresa
Lista[TipoEmpresa]
Listado de tipos de empresas empresa ordenados alfabéticamente de forma ascendente.
...