Agenda Institucional

Versão: 1.6

Apresentamos as principais características do webservice Agenda Institucional, componente do sistema de webservices da ALMG, cuja sigla é ws.

Este conjunto de webservices cuida dos itens de agenda institucional.

Os itens de agenda são:

Outros tipos de itens de agenda devem ser cadastrados em sistema próprio da ALMG.

Recursos

Os recursos que podem ser acessados são listados a seguir.

Nome Versão
Lista de Categorias por Seção do Portal 1.0
Lista de Seções 1.0
Lista de Itens da Agenda Diária por Seção do Portal 1.0
Lista de Itens da Agenda Diária por Seção do Portal, por período, por expressão e por categoria 1.0
Lista de Categorias 1.0
Ajuda 1.0

Quando o XML de resposta do recurso é maior que 20000 (vinte mil) caracteres, ele é truncado para 10000 (dez mil) caracteres para não tornar este documento muito extenso.

Lista de Categorias por Seção do Portal

Versão: 1.0

Lista as categorias de item de agenda de uma seção do Portal, ordenadas pelo nome.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/categorias/{secao}
Método GET
Tipos de Consumo N.I.
Tipos de Retorno application/xml
Resultados 200 OK & XML

Parâmetros

Nome Descrição Tipo Valor Default
{secao} Seção do Portal. String N.I.
?aliasComissaoParticipanteConcreto= Alias de Comissão Participante vai ser referente a classe abstrata ou às classes concretas Boolean true

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Lista das categorias da seção comissoes do Portal
GET https://dadosabertos.almg.gov.br/ws/agenda/categorias/comissoes

Erro: ClientHandlerException

Lista de Seções

Versão: 1.0

Lista as seções de categoria de item de agenda, ordenadas pelo nome.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/secoes
Método GET
Tipos de Consumo N.I.
Tipos de Retorno application/xml
Resultados 200 OK & XML

Parâmetros

Nome Descrição Tipo Valor Default
Sem parâmetros.

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Lista geral
GET https://dadosabertos.almg.gov.br/ws/agenda/secoes

Erro: ClientHandlerException

Lista de Itens da Agenda Diária por Seção do Portal

Versão: 1.0

Lista os itens da agenda diária de uma seção do Portal, ordenados pela hora de início.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/diaria/{secao}/{ano}/{mes}/{dia}
Método GET
Tipos de Consumo N.I.
Tipos de Retorno application/xml
Resultados 200 OK & XML

Parâmetros

Nome Descrição Tipo Valor Default
{secao} Seção do Portal. String N.I.
{ano} Ano de referência (2005..). Integer N.I.
{mes} Mês de referência (1..12). Byte N.I.
{dia} Dia de referência (1..31, conforme mês/ano). Byte N.I.
?cat= Lista de identificadores de categorias de itens de agenda separados por vírgula. Exemplo: cat=0,1,2
Se não informado, traz itens de todas as categorias da seção.
String N.I.
?aliasComissaoParticipanteConcreto= Alias de Comissão Participante vai ser referente a classe abstrata ou às classes concretas Boolean true

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Agenda diária de uma seção do Portal
GET https://dadosabertos.almg.gov.br/ws/agenda/diaria/home/2010/06/11

Erro: ClientHandlerException
Agenda diária de uma seção por uma categoria
GET https://dadosabertos.almg.gov.br/ws/agenda/diaria/home/2010/06/05?cat=0

Erro: ClientHandlerException

Lista de Itens da Agenda Diária por Seção do Portal, por período, por expressão e por categoria

Versão: 1.0

Lista os ítens da Agenda Diária por Seção do Portal, por período, por expressão e por categoria.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/diaria/{secao}/pesquisa
Método GET
Tipos de Consumo N.I.
Tipos de Retorno application/xml
Resultados 200 OK & XML

Parâmetros

Nome Descrição Tipo Valor Default
{secao} Seção do Portal. String N.I.
?expr= Expressão de pesquisa para o comando SQL like. String
?ini= Data inicial do período de pesquisa, no formato 'AAAAMMDD'.
Exemplo: ini=19841201
String N.I.
?fim= Data final do período de pesquisa, no formato 'AAAAMMDD'.
Exemplo: fim=19851202
String N.I.
?cat= Lista de identificadores de categorias de itens de agenda separados por vírgula. Exemplo: cat=0,1,2
Se não informado, traz itens de todas as categorias da seção.
String N.I.
?aliasComissaoParticipanteConcreto= Alias de Comissão Participante vai ser referente a classe abstrata ou às classes concretas Boolean true

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Lista os ítens da Agenda Diária da seção TV do dia 01/12/2011 a 07/12/2011 que sejam da categoria Programação TV e com a expressão 'reprise'
GET https://dadosabertos.almg.gov.br/ws/agenda/diaria/tv/pesquisa?ini=20111201&fim=20111207&cat=29&expr=reprise

Erro: ClientHandlerException

Lista de Categorias

Versão: 1.0

Lista as categorias de item de agenda, ordenadas pelo nome.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/categorias
Método GET
Tipos de Consumo N.I.
Tipos de Retorno application/xml
Resultados 200 OK & XML

Parâmetros

Nome Descrição Tipo Valor Default
Sem parâmetros.

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Lista geral
GET https://dadosabertos.almg.gov.br/ws/agenda/categorias

Erro: ClientHandlerException

Ajuda

Versão: 1.0

Retorna ajuda.

URLhttps://dadosabertos.almg.gov.br/ws/agenda/ajuda
Método GET
Tipos de Consumo N.I.
Tipos de Retorno text/html
Resultados 200 OK & HTML

Parâmetros

Nome Descrição Tipo Valor Default
Sem parâmetros.

Headers

Nome Descrição Tipo Valor Default
Sem headers.

Exemplos

Sem exemplos.