API para criao/atualizao de ocorrncias

Documento de Especificao do Webservice

Verso 1.0

Histrico de Reviso
Data
07/10/2016

Verso
1.0

Descrio
Criao do Documento

Autor
Bruno Silva

Sumrio
1. Introduo..........................................................................4
2. Formato Padro de Requisio..............................................4
2.1. Exemplo de Requisio de Sucesso.....................................4
2.2. Exemplo de Requisio de Erro...........................................4
2.3. Autorizao de Envio.........................................................4
3. Detalhamento dos Servios..................................................4
3.1. Criao de Ocorrncia........................................................4
3.1.1. Detalhamento dos Campos..............................................5
3.1.2. Retorno de Sucesso.........................................................5
3.2. Atualizao de Situao da Ocorrncia................................5
3.2.1. Detalhamento dos Campos..............................................6
3.2.2. Retorno de Sucesso.........................................................6

Webservice
1

INTRODUO

O objetivo deste documento descrever o processo utilizao do webservice para envio e consumo
das informaes relativas as ocorrncias.

FORMATO PADRO DE REQUISIO

O processo de consumo da API para gerao de eventos trabalha utilizando um padro de

comunicao REST, sendo resultado padro de todas as requisies os seguintes campos:
CAMPO
error
details
data

DESCRIO
Informa se a requisio ocorreu ou no com sucesso, sendo seus valores
possveis: true/false
Texto com informaes detalhadas da requisio
Utilizado para retornar dados, esse lao vir vazio em requisies onde h
somente o envio de dados.

2.1. EXEMPLO DE REQUISIO DE SUCESSO

{
"error": false,
"details": "Lista de Ocorrncias geradas com sucesso",
"data":[{
"nome":"Nome da ocorrencia",
"exemplo_dado_1":"Exemplo de Dado"
},
{
"nome":"Nome da ocorrencia",
"exemplo_dado_1":"Exemplo de Dado"
}
]
}

2.2. EXEMPLO DE REQUISIO DE ERRO

{

"error": true,
"details": "Dados Invlidos",
"data":[]

2.3. AUTORIZAO DE ENVIO

Para identificao do usurio que est efetuando a ao, deve-se adicionar no HEADER da
requisio o parmetro ID_USUARIO, esse campo obrigatrio.

DETALHAMENTO DOS SERVIOS

3.1. CRIAO DE OCORRNCIA
Servio que possibilita a criao de uma ocorrncia, e disponibiliza para triagem.
Endereo da Requisio

http://painel.gestaoderiscos.inep.gov.br/api/ocorrencia

Tipo de Requisio
Exemplo de Requisio

POST
{
"municipio":"DF - BRASILIA",
"uf":"DF",
"coordenacao":"9091 Centro Universit\u00e1rio de
Bras\u00edlia - UniCEUB",
"categoria":"Aplicao",
"subcategoria":"Atendimento especializado",
"impacto_aplicacao":"Sim",
"descricao":"Descri\u00e7\u00e3o",
"anexo":null
}

3.1.1. DETALHAMENTO DOS CAMPOS

Campo
municpio
uf
coordenacao
categoria
subcategoria
nro_processo
impacta_aplicac
ao

descricao

Descrio
Nome do municpio concatenado com a UF, EX: DF
BRASILIA
UF
Nome da coordenao concatenado com o cdigo
Categoria da ocorrncia
Subcategoria da ocorrncia
Nmero do processo, obrigatrio caso o tipo de categoria seja
aplicao e a subcategoria seja Demanda Judicial
Informa se a ocorrncia pode impactar na aplicao, valores
possveis: Sim/No, esse campo obrigatrio caso a categoria
seja aplicao. Com exceo quando selecionado as seguintes
subcategorias: Emergncia Mdicas e Eliminao de
Participantes.
Descrio da ocorrncia

Obrigatrio
Sim
Sim
No
Sim
No
Depende
Sim

Sim

3.1.2. RETORNO DE SUCESSO

Quando executado com sucesso o processamento, ser retornado o cdigo da ocorrncia
registada, conforme exemplo abaixo:
{
"error": false,
"details": "Ocorrncia cadastrada com sucesso",
"data":[{"id":"1024"}]
]
}

3.2. ATUALIZAO DE SITUAO DA OCORRNCIA

Servio que possibilita a atualizao da situao de uma ocorrncia
Endereo da Requisio
Tipo de Requisio
Exemplo de Retorno

http://painel.gestaoderiscos.inep.gov.br/api/ocorrencia
PUT
{
"id": "1024",
"situacao": "Tratada"
}

3.2.1. DETALHAMENTO DOS CAMPOS

Campo
id
Situao

Descrio
ID da ocorrncia criada
Situao atual da ocorrncia, campo texto aberto

Obrigatrio
Sim
Sim

3.2.2. RETORNO DE SUCESSO

Quando executado com sucesso o processamento, ser retornado o cdigo da ocorrncia
atualizada, conforme exemplo abaixo:
{
"error": false,
"details": "Ocorrncia atualizada com sucesso",
"data":[{"id":"1024"}]
]
}