4Biz Docs

26 min

Esta sección pretende describir el marco de comunicación REST, establecido entre las aplicaciones y el servidor backend.

⚠️Atención!

4biz_URL: prefijo de URL inmutable, para que pueda acceder a los servicios disponibles para las aplicaciones móviles CADA API QUE NECESITE UN "ID de sesión" DEBE ESTAR EN LA SECCIÓN PROPORCIONADA POR LA API "Iniciar sesión".

Servicio de autenticación de usuarios.

GET

	{
	"id":25080,
	"dateEdition":"2017-09-12T11:06:28.907-0300",
	"dateCreation":"2017-08-10T10:00:51.274-0300",
	"username":"rogerio.cassimiro",
	"token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074",
	"name":"rogerio.cassimiro",
	"version":":59"
	}

LISTA DE DEPARTAMENTOS

Lista de servicios departamentales a utilizar.

GET

	{
	"units":[
	{
	"id":93794,
	"name":"Department 1",
	"code":"000001"
	}
	]
	}

LISTA DE TIPOS DE PROCESO

Servicio de listado de tipos de proceso de un proceso a utilizar.

GET

Solicitación:
    name: alfanumérico no vacío, no nulo
    token: alfanumérico no vacío, no nulo
Respuesta:
    typeProcess: Lista vacía, no nula;
    id: numérico no vacío ni nulo
    name: alfanumérico no vacío, no nulo
    description: alfanumérico no vacío, no nulo

LISTA DE NIVELES DE ACCESO POR TIPO DE PROCESO

El servicio de listado de materias de un proceso y/o documento, a ser utilizado.

GET

	{
	"levelAccessTypeProcess":[
	{
	"idLevelAccessTypeProcess":97942,
	"idLevelAccess:":"23121",
	"name":"PUBLIC"
	},
	{
	"idLevelAccessTypeProcess":97947,
	" idLevelAccess":91426,
	"name":"RESTRICT"
	}
	]
	}

LISTA DE NIVELES DE ACCESO DEL TIPO DE DOCUMENTO

El servicio de listado de materias de un proceso y/o documento, a ser utilizado.

GET

	{
	"levelAccessTypeDocument":[
	{
	"idLevelAccessTypeDocument":97942,
	" idLevelAccess:":"23121",
	"name":"PUBLIC"
	},
	{
	"idLevelAccessTypeDocument ":97947,
	"idLevelAccess":91426,
	"name":"RESTRICTED"
	}
	]
	}

LISTA DE MATERIA

El servicio de listado de materias de un proceso y/o documento, a ser utilizado.

GET

	{
	"subjects":[
	{
	"id":6982,
	"code":"010.3",
	"name":"HEARING.MEETINGS",
	"subject":"010.3 – ADMINISTRATION.GENERAL "
	}
	]
	}

LISTA DE HIPÓTESIS JURÍDICAS

Relación de hipótesis jurídicas de un proceso o documento a utilizar.

GET

	{
	"hypoteseLegal":[
	{
	"id":7340,
	"description":"Law description",
	"name":"Information name"
	}
	]
	}

LISTA DE PERSONAS

Lista de personas interesadas en un proceso o documento a utilizar.

GET

	{
	"people":[
	{
	"id":98064,
	"name":"Maycon"
	}
	]
	}

FORMULARIO DE LISTA DE CONFERENCIA

Lista de formularios de conferencia de un proceso y/o documento, a utilizar.

GET

	{
	"typeSupport":[
	{
	"id":97975,
	"name":"Name type media"
	}
	]
	}

LISTA DE TIPOS DE MEDIOS

Lista de tipos de medios para que se utilice un documento.

GET

	{
	"typeSupport":[
	{
	"id":97975,
	"name":"Name type media"
	}
	]
	}

LISTA DE TIPOS DE DOCUMENTOS

Servicio para enumerar los tipos de documentos de un documento que se utilizará.

GET

	{
	"typeDocument":[
	{
	"id":97949,
	"name":"Document type name"
	}
	]
	}

PROCESO DE CREACIÓN

Servicio de creación de procesos.

GET

	Solicitación:
 	  subjectComplementary: alfanumérico no vacío ni nulo
	  observationGeneral: alfanumérico no vacío ni nulo
	  unit: no vacío ni nulo;
	  id: no vacío ni nulo;
	  typeProcess: no vacío ni nulo;
	     id: no vacío ni nulo;
	  levelAccess: no vacío ni nulo;
	     idLevelAccessTypeProcess: no vacío ni nulo;
	  hypoteseLegal: no vacío o nulo si el nivel de acceso difiere de Público.
	     id: númerico no vacío ni nulo
	  subject: no vacío ni nulo;
  	     id:  no vacío ni nulo;
	  interested: puede ser vacio o no;
	    personal
	  token: alfanumérico  no vacío ni nulo
	Respuesta:
	  id: numérico  no vacío ni nulo
	  nup: alfanumérico  no vacío ni nulo

CREAR DOCUMENTO

Servicio de creación de documentos.

GET

Solicitación:
    número: alfanumérico no vacío, no nulo;
    AsuntoComplementario: no vacío, no nulo alfanumérico;
    ubicación: alfanumérico no vacío, no nulo;
    contenido: no vacío o nulo;
     El contenido del documento debe enviarse en base64
    dataReferencia: sello de tiempo no vacío y no nulo;
    unidad: ni vacía ni nula;
     id: numérico no vacío ni nulo
    proceso: ni vacío ni nulo;
     id: numérico no vacío ni nulo
    documentType: ni vacío ni nulo;
     id: numérico no vacío ni nulo
    AccessLevel: ni vacío ni nulo;
     idLevelAccessTypeProcess: numérico no vacío ni nulo
    Hipótesis legal: no vacío o nulo, si el nivel de acceso es diferente de Público;
     id: numérico no vacío ni nulo
    sujeto: no vacío ni nulo;
     id: numérico no vacío ni nulo
    destinatario: no vacío o nulo;
     persona: no vacío o nulo;
        id: numérico no vacío ni nulo
    documentSupportType: ni vacío ni nulo;
    interesado: puede ser vacío y nulo;
     persona: no vacío o nulo;
        id: numérico no vacío ni nulo
    tipoConferencia: booleano no vacío o nulo;
    ubicación: alfanumérico no vacío o nulo, si el atributo ConferenceType es verdadero;
    token: alfanumérico no vacío, no nulo;
Respuesta:
    id: numérico ni vacío ni nulo;
    número: no vacío o nulo;

CARGA DE DOCUMENTOS

Servicio de creación de documentos.

GET

N/A

GET BY ID PROCESS

Servicio que recupera detalles de un proceso, según su identificador.

GET

Solicitación:
	id: numérico no vacío ni nulo
	token: alfanumérico no vacío, no nulo
Respuesta:
	Sujeto complementario: alfanumérico no vacío, no nulo
	GeneralNote: Alfanumérico no vacío, no nulo
	fechaReferencia:
	unidad: ni vacía ni nula;
	 id: numérico no vacío ni nulo
	nombre: alfanumérico no vacío, no nulo
	ProcessType: ni vacío ni nulo;
	 id: numérico no vacío ni nulo
	nombre: alfanumérico no vacío, no nulo
	 AccessLevel: ni vacío ni nulo;
	 idLevelAccessTypeProcess: numérico no vacío ni nulo
	 descripción: alfanumérico no vacío, no nulo
	Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público.
	 id: numérico no vacío ni nulo
	 nombre: alfanumérico no vacío, no nulo
	sujeto: no vacío ni nulo;
	 id: numérico no vacío ni nulo
	 asunto: alfanumérico no vacío, no nulo
	interesados: puede ser vacío y nulo;
	 persona: no vacío o nulo;
	 	id: numérico no vacío ni nulo
		nombre: : alfanumérico no vacío, no nulo

LISTA DE PROCESOS

Listado de procesos a utilizar por un documento.

GET

    Solicitación:
      nup: alfanumérico puede estar vacío o nulo;
      token: alfanumérico puede estar vacío o nulo
    Respuesta:
      id: numérico no vacío ni nulo
      Asunto complementario: alfanumérico puede estar vacío o nulo
      estado: alfanumérico puede estar vacío o nulo
      Hecho "hecho";
         IN_PROGRESS: "En curso";
         AGUARDANDO_VALIDACAO: "Esperando validación"
         VALIDADO: "Válido";
         ADJUNTO: "Adjunto";
      ProcessType: ni vacío ni nulo;
         id: numérico no vacío ni nulo
         nombre: alfanumérico puede estar vacío o nulo
      AccessLevel: no vacío o nulo
         idLevelAccessTypeProcess: numérico no vacío ni nulo
         descripción: alfanumérico puede estar vacío o nulo
      Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público.
         id: numérico no vacío ni nulo
         nombre: alfanumérico puede estar vacío o nulo
      sujeto: no vacío ni nulo;
         id: numérico no vacío ni nulo
         asunto: alfanumérico puede estar vacío o nulo
      Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público.
         id: numérico no vacío ni nulo
         nombre: alfanumérico puede estar vacío o nulo

4Biz Docs

LOGIN

LISTA DE DEPARTAMENTOS

LISTA DE TIPOS DE PROCESO

LISTA DE NIVELES DE ACCESO POR TIPO DE PROCESO

LISTA DE NIVELES DE ACCESO DEL TIPO DE DOCUMENTO

LISTA DE MATERIA

LISTA DE HIPÓTESIS JURÍDICAS

LISTA DE PERSONAS

FORMULARIO DE LISTA DE CONFERENCIA

LISTA DE TIPOS DE MEDIOS

LISTA DE TIPOS DE DOCUMENTOS

PROCESO DE CREACIÓN

CREAR DOCUMENTO

CARGA DE DOCUMENTOS

GET BY ID PROCESS

LISTA DE PROCESOS