Webservices CITSmart Docs
Esta seção destina-se a descrever a estrutura de comunicação REST, estabelecida entre aplicativos e o servidor back-end.
Atenção CITSMART_URL: prefixo de URL inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos de mobile TODO API QUE NECESSITA DE “sessionID” PRECISARÁ ESTAR NA SEÇÃO FORNECIDA PELO “Login” DA API.
LOGIN
Serviço de autentificação do usuário
Solicitação:
username: alfanumérico não vazio nem nulo;
password: alfanumérico não vazio nem nulo;
Resposta:
id: numérico não vazio nem nulo;
dateEdition: timestamp não vazio nem nulo;
dateCreation: timestamp não vazio nem nulo;
username: alfanumérico não vazio nem nulo;
token: alfanumérico não vazio nem nulo;
name: alfanumérico não vazio nem nulo;
version: numérico não vazio nem nulo;LISTA DEPARTMENTO
Lista de serviços dos departamentos a serem usados.
Solicitação:
name: alfanumérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
units: Lista vazia e não nula;
id: numérico não vazio nem nulo
name: alfanumérico não vazio nem nulo
code: alfanumérico não vazio nem nuloLISTA TIPO DE PROCESSO
Serviço de listagem do tipo de processo de um processo, a ser usado
{
"typeProcess":[
{
"id":6967,
"name":"Pattern process",
"description":"Pattern process detailing"
}
]
}LISTA NÍVEL DE ACESSO DO TIPO DE PROCESSO
O serviço de listagem de assunto de um processo e / ou documento, a ser usado.
Solicitação:
idTypeProcess: numérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
levelAccessTypeProcess: lista não vazia nem nula;
idLevelAccess: numérico não vazio nem nulo
idLevelAccessTypeProcess: numérico não vazio nem nulo
name: alfanumérico não vazio nem nuloLISTA NÍVEL DE ACESSO DO TIPO DE DOCUMENTO
O serviço de listagem de assunto de um processo e / ou documento, a ser usado.
Solicitação:
idTypeDocument: numérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
levelAccesTypeDocument: lista não vazia nem nula;
idLevelAccess: numérico não vazio nem nulo
idLevelAccessTypeDocument: numérico não vazio nem nulo
name: alfanumérico não vazio nem nuloLISTA DE ASSUNTO
O serviço de listagem de assunto de um processo e / ou documento, a ser usado.
{
"subjects":[
{
"id":6982,
"code":"010.3",
"name":"HEARING.MEETINGS",
"subject":"010.3 – ADMINISTRATION.GENERAL "
}
]
}LISTA DE HIPÓTESES LEGAIS
Lista de hipóteses legais de um processo ou documento a ser utilizado.
{
"hypoteseLegal":[
{
"id":7340,
"description":"Law description",
"name":"Information name"
}
]
}LISTA DE PESSOAS
Lista de pessoas interessadas em um processo ou documento a ser utilizado.
Solicitação:
name: alfanumérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
people: Lista vazia e não nula;
id: numérico não vazio nem nulo
name: alfanumérico não vazio nem nuloLISTA DA FORMA DE CONFERÊNCIA
Lista dos formulários de conferência de um processo e/ou documento, a ser usado
Solicitação:
name: alfanumérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
formaConference: Lista vazia e não nula;
id: numérico não vazio nem nulo
name: alfanumérico não vazio nem nuloLISTA DE TIPOS DE MÍDIA
Lista de tipos de mídia para um documento a ser utilizado.
Solicitação:
name: alfanumérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
typeSupport: Lista vazia e não nula;
id: numérico não vazio nem nulo
name: alfanumérico não vazio nem nulo LISTA TIPOS DE DOCUMENTO
Serviço de listagem de tipos de documentos de um documento a ser utilizado
Solicitação:
name: alfanumérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
typeDocument: Lista vazia e não nula;
id: numérico não vazio nem nulo
name: alfanumérico não vazio nem nulo CRIAR PROCESSO
Serviço de criação de um processo
Solicitação:
subjectComplementary: alfanumérico não vazio nem nulo
observationGeneral: alfanumérico não vazio nem nulo
unit: não vazio nem nulo;
id: não vazio nem nulo;
typeProcess: não vazio nem nulo;
id: não vazio nem nulo;
levelAccess: não vazio nem nulo;
idLevelAccessTypeProcess: não vazio nem nulo;
hypoteseLegal: não vazio nem nulo se o nível de acesso difere de Público.
id: númerico não vazio nem nulo
subject: não vazio nem nulo;
id: não vazio nem nulo;
interested: pode ser vazio e nulo;
pessoal
token: alfanumérico não vazio nem nulo
Resposta:
id: numérico não vazio nem nulo
nup: alfanumérico não vazio nem nulo CRIAR DOCUMENTO
Serviço de ciração de documento
Solicitação:
numero: alfanumérico não vazio nem nulo;
assuntoComplementar: alfanumérico não vazio nem nulo;
localização: alfanumérico não vazio nem nulo;
conteudo: não vazio nem nulo;
O conteúdo do documento deve ser enviado em base64
dataReferencia: timestamp não vazio nem nulo;
unidade: não vazio nem nulo;
id: numérico não vazio nem nulo
processo: não vazio nem nulo;
id: numérico não vazio nem nulo
tipoDocumento: não vazio nem nulo;
id: numérico não vazio nem nulo
nivelAcesso: não vazio nem nulo;
idNivelAcessoTipoProcesso: numérico não vazio nem nulo
hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público;
id: numérico não vazio nem nulo
assunto: não vazio nem nulo;
id: numérico não vazio nem nulo
destinatario: não vazio nem nulo;
pessoa: não vazio nem nulo;
id: numérico não vazio nem nulo
tipoSuporteDocumento: não vazio nem nulo;
interessados: pode ser vazio e nulo;
pessoa: não vazio nem nulo;
id: numérico não vazio nem nulo
tipoConferencia: Boolean não vazio nem nulo;
localização: alfanumérico não vazio nem nulo, se o atributo tipoConferencia for true;
token: alfanumérico não vazio nem nulo;
Resposta:
id: numérico não vazio nem nulo;
numero: não vazio nem nulo;DOCUMENTO UPLOAD
Serviço de criação de documento.
Solicitação:
idDocumento: numérico não vazio nem nulo
file: não vazio nem nulo
token: alfanumérico não vazio nem nuloGET BY ID PROCESS
Serviço que recupera detalhes de um processo, de acordo com seu identificador.
Solicitação:
id: numérico não vazio nem nulo
token: alfanumérico não vazio nem nulo
Resposta:
assuntoComplementar: alfanumérico não vazio nem nulo
observacaoGeral: alfanumérico não vazio nem nulo
dataReferencia:
unidade: não vazio nem nulo;
id: numérico não vazio nem nulo
nome: alfanumérico não vazio nem nulo
tipoProcesso: não vazio nem nulo;
id: numérico não vazio nem nulo
nome: alfanumérico não vazio nem nulo
nivelAcesso: não vazio nem nulo;
idNivelAcessoTipoProcesso: numérico não vazio nem nulo
descricao: alfanumérico não vazio nem nulo
hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
id: numérico não vazio nem nulo
nome: alfanumérico não vazio nem nulo
assunto: não vazio nem nulo;
id: numérico não vazio nem nulo
assunto: alfanumérico não vazio nem nulo
interessados: pode ser vazio e nulo;
pessoa: não vazio nem nulo;
id: numérico não vazio nem nulo
nome: : alfanumérico não vazio nem nulo LISTA DE PROCESSO
Listagem de processos a serem usados por um documento
Solicitação:
nup: alfanumérico podendo ser vazio ou nulo;
token: alfanumérico podendo ser vazio ou nulo
Resposta:
id: numérico não vazio nem nulo
assuntoComplementar: alfanumérico podendo ser vazio ou nulo
status: alfanumérico podendo ser vazio ou nulo
CONCLUIDO: "Concluído";
EM_ANDAMENTO: "Em andamento";
AGUARDANDO_VALIDACAO: "Aguardando validação "
VALIDADO: "Válido";
ANEXADO: "Anexado";
tipoProcesso: não vazio nem nulo;
id: numérico não vazio nem nulo
nome: alfanumérico podendo ser vazio ou nulo
nivelAcesso: não vazio nem nulo
idNivelAcessoTipoProcesso: numérico não vazio nem nulo
descricao: alfanumérico podendo ser vazio ou nulo
hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
id: numérico não vazio nem nulo
nome: alfanumérico podendo ser vazio ou nulo
assunto: não vazio nem nulo;
id: numérico não vazio nem nulo
assunto: alfanumérico podendo ser vazio ou nulo
hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
id: numérico não vazio nem nulo
name: alfanumérico podendo ser vazio ou nulo