Webservices CITSmart Docs

This section is intended to describe the communication structure REST, established between applications and the back-end server.

CITSMART_URL: URL unalterable prefix, so that you can access the services made available to the mobile applications. ALL API THAT REQUIRES A “sessionID” WILL NEED TO BE IN A SESSION PROVIDED BY THE “Login” API.

User Authentication Service

	Request:
	   username: alphanumeric not empty and not null;
	   password :alphanumeric not empty and not null;
	Response:
	   id: numeric not empty and not null;
	   dateEdition: timestamp not empty and not null;
	   dateCreation: timestamp not empty and not null;
	   username: alphanumeric not empty and not null;
	   token: alphanumeric not empty and not null;
	   name: alphanumeric not empty and not null;
	   version: numeric not empty and not null;

LIST DEPARTMENT

Service list of departments to be used.

	Request:
	   name: alphanumeric not empty and not null
	   token: alphanumeric not empty and not null
	Response:
	   units: List empty and not null;
	   id: numeric not empty and not null
	   name: alphanumeric not empty and not null
	   code: alphanumeric not empty and not null

LIST LEVEL ACCESS TYPE PROCESS

The subject listing service of a process and / or document, to be used.

	Request:
 	   idTypeProcess: numeric not empty and not null
	   token: alphanumeric not empty and not null
	Response:
	  levelAccessTypeProcess: list not empty and not null;
	  idLevelAccess: numeric not empty and not null
	  idLevelAccessTypeProcess: numeric not empty and not null
 	  name: alphanumeric not empty and not null

LIST LEVEL ACCESS TYPE DOCUMENT

The subject listing service of a process and / or document, to be used.

	Request:
	  idTypeDocument: numeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  levelAccesTypeDocument: list not empty and not null;
	  idLevelAccess: numeric not empty and not null
	  idLevelAccessTypeDocument: numeric not empty and not null
  	  name: alphanumeric not empty and not null

LIST SUBJECT

The subject listing service of a process and / or document, to be used.

	Request:
	  name: alphanumeric not empty and not null
	  code: alphanumeric not empty and not null
	  token: alfanumeric not empty and not null
 	Response:
	  subjects: List empty and not null;
	  id: numeric not empty and not null
	  code: alphanumeric not empty and not null
	  name: alphanumeric not empty and not null
	  subject: alphanumeric not empty and not null

LIST LEGAL HYPOTHESES

List of legal hypotheses of a process or document, to be used.

	Request:
	  idLevelAccess: numeric not empty and not null
	  name: alphanumeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  hypoteseLegal: List empty and not null;
	  id: numeric not empty and not null
   	  description: alphanumeric not empty and not null
	  name: alphanumeric not empty and not null

LIST PEOPLE

List of interested persons of a process or document, to be used:

	Request:
	  name: alphanumeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  people: List empty and not null;
	  id: numeric not empty and not null
  	  name: alphanumeric not empty and not null

LIST FORM OF CONFERENCE

List of the conference forms of a process and / or document, to be used

	Request:
	  name: alphanumeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  formaConference: List empty and not null;
	  id: numeric not empty and not null
	  name: alphanumeric not empty and not null

LIST MEDIA TYPES

List of media types for a document to be used

	Request:
	  name: alphanumeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  typeSupport: List empty and not null;
	  id: numeric not empty and not null
	  name: alphanumeric not empty and not null

LIST DOCUMENT TYPES

Listing service of document types of a document, to be used.

	Request:
	  name: alphanumeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  typeDocument: List empty and not null;
	  id: numeric not empty and not null
	  name: alphanumeric not empty and not null

CREATE PROCESS

Service creating a process.

	Request:
 	  subjectComplementary: alphanumeric not empty and not null
	  observationGeneral: alphanumeric not empty and not null
	  unit: not empty and not null;
	  id: not empty and not null ;
	  typeProcess: not empty and not null;
	     id: not empty and not null ;
	  levelAccess: not empty and not null
	     idLevelAccessTypeProcess: not empty and not null ;
	  hypoteseLegal: not empty and not null if the access level differs from Public.
	     id: numeric not empty and not null
	  subject: not empty and not null ;
  	     id: not empty and not null ;
	  interested: can be empty and null;
	    personal
	  token: alphanumeric not empty and not null
	Response:
	  id: numeric not empty and not null
	  nup: alphanumérico not empty and not null;

CREATE DOCUMENT

Document creation service

	Request:
	  numero: alphanumeric not empty and not null;
	  assuntoComplementar: alphanumeric not empty and not null
	  localização: alphanumeric may be empty or null;
	  conteudo: not empty and not null;
	     The content of the document should be sent in base64
	  dataReferencia: timestamp not empty and not null;
	  unidade: not empty and not null;
	     id: numeric not empty and not null
	  processo: not empty and not null;
	     id: numeric not empty and not null
	  tipoDocumento: not empty and not null;
	     id: numeric not empty and not null
	  nivelAcesso: not empty and not null;
	     idNivelAcessoTipoProcesso: numeric not empty and not null
	  hipoteseLegal: not empty and not null, if the nível de acesso differs from Público;
	     id: numeric not empty and not null
	  assunto: not empty and not null;
	     id: numeric not empty and not null
	  destinatario: not empty and not null;
	     pessoa: not empty and not null;
	        id: numeric not empty and not null;
	  tipoSuporteDocumento: not empty and not null;
	  interessados: can be empty and null;
	     pessoa: not empty and not null;
	        id: numeric not empty and not null;
	  tipoConferencia: boolean not empty and not null;
	  localização: alphanumeric not null and non-empty, if the tipoConferencia attribute is true;
	  token: alfanumeric not empty and not null
	Response:
	  id: numeric not empty and not null
	  numero: not empty and not null

UPLOAD DOCUMENT

Document creation service

	Request:
 	  idDocumento: numeric not empty and not null
	  file: not empty and not null
	  token: alphanumeric not empty and not null

GET BY ID PROCESS

Service that retrieves details of a process, according to its identifier.

	Request:
 	  id: numeric not empty and not null
	  token: alphanumeric not empty and not null
	Response:
	  assuntoComplementar: alphanumeric not empty and not null
	  observacaoGeral: alphanumeric not empty and not null
	  dataReferencia:
	  unidade: not empty and not null;
	     id: numeric not empty and not null
	  nome: alfphanumeric not empty and not null
	  tipoProcesso: not empty and not null;
	     id: numeric not empty and not null
	  nome: alphanumeric not empty and not null
	     nivelAcesso: not empty and not null
	     idNivelAcessoTipoProcesso: numeric not empty and not null
	     descricao: alphanumeric not empty and not null
	  hipoteseLegal: not empty and not null, if the access level differs from Public.
	     id: numeric not empty and not null
	     nome: alphanumeric not empty and not null
	assunto: not empty and not null;
	     id: numeric not empty and not null
	     assunto: alphanumeric not empty and not null
	interessados: can be empty and null;
	     pessoa: not empty and not null;
	        id: numeric not empty and not null;
	        nome: : alphanumeric not empty and not null

LIST PROCESS

Listing of processes to be used by a document

	Request:
 	  nup: alphanumeric may be empty or null;
	  token: alphanumeric not empty and not null
	Response:
	  id: numeric not empty and not null
	  assuntoComplementar: alphanumeric not empty and not null
	  status: alphanumeric not empty and not null
  	     CONCLUIDO: "Completed";
	     EM_ANDAMENTO: "In progress";
	     AGUARDANDO_VALIDACAO: "Waiting for Validation"
	     VALIDADO: "Validated";
	     ANEXADO: "Attached";
	  tipoProcesso: not empty and not null;
	     id: numeric not empty and not null
	     nome: alphanumeric not empty and not null
	  nivelAcesso: not empty and not null
	     idNivelAcessoTipoProcesso: numeric not empty and not null
	     descricao: alphanumeric not empty and not null
	  hipoteseLegal: not empty and not null, if the accessLevel differs from Public.
	     id: numeric not empty and not null
	     nome: alphanumeric not empty and not null
	  assunto: not empty and not null ;
	     id: numeric not empty and not null
	     assunto: alphanumeric not empty and not null
	  hipoteseLegal: not empty and not null, if the levelAccess differs from Public.
	     id: numeric not empty and not null
	     name: alphanumeric not empty and not null