Você está na página 1de 11

Sistema Eletrnico do Servio de Informaes ao Cidado e-Sic

Definio dos Webservices


Verso 1.4

Histrico de Reviso
Autor

Data

Descrio

Verso

Marcio Otta

16/ago/12

Verso Inicial

1.0

Michael Melo

12/03/2013

Insero de novos campos pedidos em email de 28/02/2013

1.1

Michael Melo

26/03/2013

Insero de dados cadastrais de solicitante

1.2

Michael Melo

23/05/2014

Insero de novo campo Data do ltimo Reencaminhamento no pedido

1.3

Michael Melo

26/08/2013

Insero de novo campo Resumo da Solicitao no pedido

1.4

e-Sic Webservices

Pgina 1

1 - Webservices disponveis no e-Sic


Atualmente so fornecidos os webservices que permitem consultar todos os dados de pedidos e de recursos do prprio rgo e dos rgos
subordinados, atravs de diversos parmetros.

2 - Acesso aos webservices


O acesso aos webservices do e-Sic deve ser solicitado ao gestor do sistema e-Sic pelo seguinte e-mail:
suporte.sistacesso@cgu.gov.br
Ser fornecido uma credencial para o rgo poder acessar os servios.
Os webservices so acessveis atravs dos seguintes endereos, onde podero ser consultados os mtodos e o wsdl:
www.acessoainformacao.gov.br/sistema/Servicos/ServicoConsultaPedido.asmx
www.acessoainformacao.gov.br/sistema/Servicos/ServicoConsultaRecurso.asmx

3 - Webservices de Pedido
3.1 - ObterPedidos

Parmetros da requisio
Nome
Usuario
e-Sic Webservices

Tipo
String

Contedo
Usurio cadastrado pela CGU

Regras
Deve ser um usurio do tipo WebService.
Pgina 2

Senha
RetornarOrgaosVincul
ados

String
Boolean

Senha do usurio.
Se deve retornar dados dos SICs vinculados
(inferiores).

Orgao

Int

Cdigo do rgo SIORG

Protocolo
DtAberturaInicio

String
DateTime

Nmero do protocolo de um pedido


Data inicial da abertura dos pedidos

DtAberturaFim
DtPrazoAtendimentoI
nicio
DtPrazoAtendimentoF
im
SituacaoPedido

DateTime
DateTime

Data final da abertura dos pedidos


Data inicial do prazo de atendimento dos
pedidos
Data final do prazo de atendimento dos
pedidos
Cdigo da situao dos pedidos

DateTime
Int

Obrigatrio.
Campo obrigatrio.
Se Verdadeiro, ir retornar os dados dos sics inferiores
(caso o SIC do usurio seja de ministrio). Se Falso, ir
retornar apenas os dados do prprio SIC.
Default=Falso.
Pode ser solicitado o prprio rgo ou algum rgo
inferior que esteja cadastrado no e-Sic. Se for
informado algum cdigo diferente destes ou no for
informado, ser considerado apenas o rgo do
usurio.
Pode ser utilizada em conjunto com o campo
DtAberturaFim
Pode ser utilizada em conjunto com o campo
DtPrazoAtendimentoFim

1 = Em tramitao
2= Respondido

Dados de retorno
Nome
CodigoExecucao

Tipo
Int

Contedo
Cdigo da execuo da consulta

DataProcessamento

DateTime

Informa a data/hora em que foi feito o


processamento da consulta (para informar a
data do servidor)

e-Sic Webservices

Regras
0=Sucesso
1=Usurio no autenticado
2=Resultado limitado a 1000 registros

Pgina 3

Para cada pedido


Dados do pedido
Data do registro do pedido
Contedo do pedido
Como deseja receber a resposta

DataRegistro
DescricaoPedido
FormaRecebimento

DateTime
String (2048)
String (40)

CodSiorgOrgaoSuperior
OrgaoSuperior
OrgaoVinculado

String(20)
String (250)
String(20)
String (250)

PrazoAtendimento
Protocolo

DateTime
String (20)

Situacao

String (40)

Cdigo Siorg do rgo superior


Nome do rgo superior
Cdigo Siorg do rgo vinculado
Nome do rgo inferior (se o pedido for
direcionado para um rgo inferior)
Prazo de atendimento do pedido
Nmero do protocolo
Nmero de anexos
Situao do Pedido

SituacaoStatus

String (200)

Detalhamento da situao

EmAtendimento

String(1)

DataUltimoReencaminhamento

DateTime

ResumoSolicitacao

String (255)

Informa se o pedido est ou no em


atendimento
Informa a data do ltimo
reencaminhamento realizado no pedido
Informa o resumo da solicitao feita no
pedido
Dados do Solicitante

CodSiorgOrgaoVinculado

TipoPessoa

String (1)

Fsica ou Jurdica

Nome
CPFouCNPJ

String (200)
String (14)

Nome ou razo social


CPF (se pessoa Fsica) ou CNPJ (se pessoa
jurdica)

e-Sic Webservices

Buscar/Consultar pessoalmente
Correspondncia fsica (com custo)
Pelo sistema (com avisos por email)

Em Tramitao
Respondido
Ex: Acesso negado documento sigiloso (lei
12.527/2011), Resposta disponvel no sistema, etc.
S = Sim
N = No
pode ser NULO
Novo campo, no pode ser NULO (s para os pedidos
abertos antes da sua implantao)
F = Fsica
J = Jurdica

Pgina 4

DocumentoIdentificaca
o
Sexo

String (20)

Numero do documento de identificao

String (1)

Sexo do solicitante

Profisso
Email
DDD
Telefone
Endereco
UF
Pas
Cidade
CEP

String (200)
String (200)
String(2)
String (20)
String (500)
String (2)
String (200)
String (200)
String (9)

Profisso do solicitante

M = Masculino
F = Feminino

Sigla da UF
Descrio do Pas

3.2 - ObterAnexosPedidos

Parmetros da Requisio
Nome
Usuario

Tipo
String

Contedo
Usurio cadastrado pela CGU

Senha
Protocolo

String
String

Senha do usurio.
Nmero do protocolo de um pedido

Tipo

Contedo

Regras
Deve ser um usurio do tipo WebService.
Obrigatrio.
Campo obrigatrio.

Dados de retorno
Nome
e-Sic Webservices

Regras
Pgina 5

CodigoExecucao

Int

Cdigo da execuo

0=Sucesso
1=Usurio no autenticado
3=No tem permisso de consultar o pedido
9=Falha no envio de um dos arquivos

DescricaoExecucao
QuantidadeDeArquivo

String (200)
Int

Mensagem referente ao cdigo de execuo


Quantidade de arquivos anexos ao pedido
Para cada arquivo

NomeArquivo
ArquivoZipAndBase64

String (200)
String (sem
limite)

Nome original do arquivo (com extenso)


Arquivo zipado no formato GZip e codificado
em Base-64

Ver informaes adicionais.

4 - WSs de Recursos
4.1 - ObterRecursos

Parmetros da requisio
Nome
Usuario

Tipo
String

Contedo
Usurio cadastrado pela CGU

Senha
Protocolo
DtAberturaInicio

String
String
DateTime

Senha do usurio.
Nmero do protocolo
Data inicial da abertura dos recursos

e-Sic Webservices

Regras
Deve ser um usurio do tipo WebService.
Obrigatrio.
Campo obrigatrio.
Pode ser utilizada em conjunto com o campo
Pgina 6

DtAberturaFim
DtAberturaFim
DtPrazoAtendimentoInici
o
DtPrazoAtendimentoFim

DateTime
DateTime

Instancia

Int

Data final da abertura dos recursos


Data inicial do prazo de atendimento dos
recursos
Data final do prazo de atendimento dos
recursos
Instncia dos recursos

OrigemTerceiraInstancia

Int

Especifica a origem do recurso de 3a instncia

SituacaoRecurso

Int

Filtra os recursos por situao.

RetornarOrgaosVinculad
os

Boolean

Se deve retornar dados dos SICs vinculados


(inferiores).

Orgao

Int

Cdigo do rgo SIORG

DateTime

Pode ser utilizada em conjunto com o campo


DtPrazoAtendimentoFim

1=primeira instncia
2=segunda instncia
3=instncia CGU
4=reclamao
5=CMRI
0=todos os recursos
2=com origem em segunda instncia
4=com origem em reclamao
1=Em Tramitao
2=Respondido
3=Em Anlise
4=Deferido
Se Verdadeiro, ir retornar os dados dos sics inferiores
Se Falso, ir retornar apenas os dados do prprio SIC.
Default=Falso.
Pode ser solicitado o prprio rgo ou algum rgo
inferior que esteja cadastrado no e-Sic. Se for
informado algum cdigo diferente destes, ou no for
informado, ser considerado apenas o rgo do
usurio.

Dados de retorno
Nome
CodigoExecucao

e-Sic Webservices

Tipo
Int

Contedo
Cdigo da execuo da consulta

Regras
0=Sucesso
1=Usurio no autenticado
Pgina 7

2=Resultado limitado a 1000 registros


Para cada recurso

ProtocoloPedido
Instncia

String (20)
String (40)

Dados do recurso
Nmero do protocolo do pedido
Descrio da Instncia do Recurso

TipoRecurso

String (80)

Descrio do tipo de recurso

DataAbertura
PrazoAtendimento
Situacao

DateTime
DateTime
String (40)

Data de abertura do recurso


Prazo de atendimento do recurso
Descrio da situao do recurso

Justificativa

String (8000)

Descrio do texto do recurso impetrado pelo


solicitante

QtdAnexos

Int

primeira instncia
segunda instncia
CGU
Reclamao por atraso
Ex.: Informao incompleta, Autoridade classificadora
no informada, Grau de sigilo no informado, etc.

Em Tramitao
Respondido
Deferido

Dados do Solicitante
TipoPessoa

String (1)

Fsica ou Jurdica

Nome
CPFouCNPJ

String (200)
String (14)

DocumentoIdentificac
ao
Sexo

String (20)

Nome ou razo social


CPF (se pessoa Fsica) ou CNPJ (se pessoa
jurdica)
Numero do documento de identificao

String (1)

Sexo do solicitante

Profisso
Email

String (200)
String (200)

Profisso do solicitante

e-Sic Webservices

F = Fsica
J = Jurdica

M = Masculino
F = Feminino

Pgina 8

DDD
Telefone
Endereco
UF
Pas
Cidade
CEP
DataProcessamento

String(2)
String (20)
String (500)
String (2)
String (200)
String (200)
String (9)
DateTime

Sigla da UF
Descrio do Pas

Data/Hora do processamento
Informa a data/hora em que foi feito o
processamento da consulta (para informar a
data do servidor)

4.2 - ObterAnexosRecursos

Parmetros da Requisio
Nome
Usuario

Tipo
String

Contedo
Usurio cadastrado pela CGU

Senha
Protocolo
Instancia

String
String
Int

Senha do usurio.
Nmero do protocolo
Instncia do Recurso

OrigemTerceiraInstan
cia

Int

Especifica a origem do recurso de 3a instncia

e-Sic Webservices

Regras
Deve ser um usurio do tipo WebService.
Obrigatrio.
Campo obrigatrio.
1 = primeira instncia
2 = segunda instncia
3 = CGU
4 = Reclamao por atraso
5 = CMRI
0=todos os recursos
2=com origem em segunda instncia
4=com origem em reclamao

Pgina 9

Dados de retorno
Nome
CodigoExecucao

Tipo
Int

Contedo
Cdigo da execuo

Regras
0=Sucesso
1=Usurio no autenticado
3=No tem permisso de consultar o recurso
9=Falha no envio de um dos arquivos

DescricaoExecucao
QuantidadeDeArquivo

String (200)
Int

Mensagem referente ao cdigo de execuo


Quantidade de arquivos anexos
Para cada arquivo

NomeArquivo
ArquivoZipAndBase64

String (200)
String
(ilimitado)

Nome original do arquivo (com extenso)


Arquivo zipado no formato GZip e codificado
em Base-64

Ver informaes adicionais.

5 Informaes adicionais
5.1 Arquivos anexos

Os arquvos anexos so primeiramente zipados no formato gZip e posteriormente codificados em base-64 para a transferncia. Portanto devem ser
decodifidados para binrios e, aps isso, descompactados usando alguma api do gZip.
Atualmente o tamanho mximo dos arquivos, aps a descompactao, de 2 MB.
Atualmente so aceitas no e-Sic todas as extenses de documentos e imagens.

e-Sic Webservices

Pgina 10

e-Sic Webservices

Pgina 11

Você também pode gostar