Mudanças entre as edições de "API-GUIA-SERVICOS"
(→Apresentação) |
(→Sintaxe de chamada) |
||
Linha 235: | Linha 235: | ||
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
− | curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/ | + | curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/offset=0/limit=10" |
ou | ou | ||
− | curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/ | + | curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/{id}" |
=== Retorno JSON === | === Retorno JSON === |
Edição das 12h44min de 26 de abril de 2016
Índice |
Apresentação
A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações que tornem possível a visualização de informações dos serviços públicos em outros sítios, ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações sempre atualizadas do Guia de Serviços. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.
URI
http://api-guiaserv.seade.gov.br/v1
Código HTTP de Retorno
- Sucesso: 200.
- Erro: 404.
Recursos Disponíveis
Órgãos
GET
- Path: /orgao/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/{id}"
Retorno JSON
Exemplo:
{ "orgao": [ { "Nome": "Procuradoria Geral do Estado", "ID_Orgao": "35", "Condicao": "1" } ] }
Obs.: Condicao = 1 (órgao ativo) e Condicao = 0 (órgão inativo)
Prestadores
GET
- Path: /prestador/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/prestador/all"
ou
curl -X GET http://api-guiaserv.seade.gov.br/v1/prestador/{id}"
Retorno JSON
Exemplo:
{ "prestador": [ { "ID_Prestador": "310", "Nome": "Procuradoria Geral do Estado - Sede", "ID_Orgao": "35", "Nome_Secretaria": "Procuradoria Geral do Estado", "Endereco": "Rua Pamplona", "EndNumero": "227", "EndComplemento": "6º andar", "CEP": "01405902", "Municipio_IBGE": "3550308", "Nome_Municipio": "São Paulo", "Telefone": "11-3372-6438", "Ramal": null, "Fax": "11-3372-6498", "HomePage": "www.pge.sp.gov.br", "Email": "arinaldi@sp.gov.br", "Condicao": "1" } ] }
Obs.: Condicao = 1 (prestador ativo) e Condicao = 0 (prestador inativo)
Municípios
GET
- Path: /municipio/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/{id}"
Retorno JSON
Exemplo:
{ "muncipio": [ { "Municipio_IBGE": "3550308", "Nome": "São Paulo" } ] }
Ouvidorias
GET
- Path: /ouvidoria/
- Parâmetros: id
É obrigatório informar o "id" (código do prestador) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidoria/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidoria/{id}"
Retorno JSON
Exemplo:
{ "ouvidoria": [ { "ID_Prestador": "310", "ID_Informante": "38", "Nome": "Maria Rita Vaz de Arruda Corsini", "Telefone": "11-3372-6405", "Ramal": null, "Email": "ouvidoria@sp.gov.br", "Fax": "11-3372-6406", "HomePage": "http://www.ouvidoria.sp.gov.br/RegistraManifestacao.aspx?cod_prestador=310", "Endereco": "Rua Pamplona", "EndNumero": "227", "EndComplemento": "1º andar", "CEP": "01405902", "Municipio_IBGE": "3550308", "Nome_Municipio": "São Paulo", "AtendInicio": "10:00", "AtendFim": "16:00", "Condicao": "2" } ] }
Obs.: Condicao = 2 (ouvidor ativo) e Condicao = 1 (ouvidor inativo)
Ouvidores
GET
- Path: /ouvidor/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidor/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidor/{id}"
Retorno JSON
Exemplo:
{ "ouvidor": [ { "ID_Informante": "38", "ID_Usuario": "235", "Nome": "Maria Rita Vaz de Arruda Corsini", "Cargo": "Ouvidora", "Gerencia": "Ouvidoria", "Telefone": "11-3372-6493", "Ramal": "", "Fax": "11-3372-6406", "Email": "mcorsini@sp.gov.br,tari@uol.com.br" } ] }
Serviços
GET
Use o formato abaixo para buscar uma variável por requisição.
- Path: /servico/
- Parâmetros: id
Para buscar todos os serviços, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo:
- Path: /servico/offset={inicial}/limit={limite}
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/offset=0/limit=10"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/{id}"
Retorno JSON
Exemplo:
{ "servico": [ { "Nome": "Indenização Administrativa de Danos Causados por Agentes do Estado - Procuradoria Geral do Estado", "ID_Servico": "1302", "ID_Orgao": "35", "Nome_Secretaria": "Procuradoria Geral do Estado", "ID_Prestador": "310", "Nome_Orgao": "Procuradoria Geral do Estado - Sede", "Descricao": "Indenização administrativa de danos causados por agentes do Estado. Avalia-se a possibilidade de acordo administrativo sobre indenização de danos, desde que o pretendente não tenha ação judicial veiculando a mesma pretensão indenizatória.", "Condicao": "1" } ] }
Obs.: "Sempre será listado o serviço de Condicao = 1 (registro da última atualização)