Como utilizar API do Programa de Metas

Introdução

Ainda estamos apenas consultando os dados, todas as requisições relacionadas as informações das metas e projetos são feitas por GET.

O endereço para as requisições serem feitas é: http://planejasampa.prefeitura.sp.gov.br/metas/api/

Metas

• /goals -> lista de todas as metas
• /goals?axis=1 -> lista de todas as metas do eixo_id 1
• /goals?articulation=1 -> lista de todas as metas da articulação #1
• /goals?objective=1 -> lista de todas as metas do objetivo #1
• /goals?secretary=1 -> lista de todas as metas da secretary #1
• /goals?prefecture=1 -> lista de todas as metas do prefecture #1

Todas as requisições acima, retornarão o json no seguinte formato:

[
	{
		id: "1",
		objective_id: "1",
		axis_id: "1",
		articulation_id: "6",
		name: "Inserir aproximadamente 280 mil famílias com renda de até meio salário mínimo no Cadastro Único para atingir 773 mil famílias cadastradas",
		will_be_delivered: "280 mil famílias inscritas no Cadastro Único",
		total_cost: "103305927.00",
		schedule_2013_2014: "228.000 famílias cadastradas",
		schedule_2015_2016: "52.000 famílias cadastradas",
		observation: "Prioridade para implementação das ações nas Subprefeituras com maior concentração de famílias em situação de extrema pobreza e pobreza. Busca Ativa apoiada pelas áreas de interface e sociedade civil. Disponibilização de espaços públicos e equipamentos municipais para ações cadastrais.",
		technically: "Cadastro Único para Programas Sociais do Governo Federal (Cadastro Único): é um instrumento que identifica e caracteriza as famílias de baixa renda (renda mensal de até meio salário mínimo por pessoa ou renda mensal total de até três salários mínimos). Ele é utilizado por mais de 15 programas sociais do Governo Federal, como o Bolsa Família, Minha Casa Minha Vida, PRONATEC, Tarifa Social de Energia Elétrica, Brasil Carinhoso, etc. Busca Ativa: estratégia do Plano Brasil Sem Miséria que tem como objetivo levar o Estado ao cidadão, sem esperar que as pessoas mais pobres cheguem até o poder público. Um dos grandes desafios do Brasil Sem Miséria é alcançar aqueles que não acessam os serviços públicos e vivem fora de qualquer rede de proteção social.",
		status: "em andamento com benefícios à população",
		transversalidade: "juventude-viva",
		qualitative_progress_1: "138 mil famílias inseridas no Cadastro Único apenas em 2013, o que equivale a quase 50% da meta definida até 2016.",
		qualitative_progress_2: "Esse número equivale a aproximadamente 455 mil pessoas, um número maior que a população de Florianópolis.",
		qualitative_progress_3: "O número de famílias cadastradas em janeiro de 2013 era de 572.426. Em julho de 2013, data da última atualização do CadÚnico, este número passou para 709.595. Isso indica que foram cadastradas 137.169 famílias apenas no primeiro semestre de 2013, o que equivale a quase 50% da meta definida até 2016. A próxima atualização deste número está prevista para abril de 2014 com dados referente a dezembro de 2013",
		qualitative_progress_4: "350 entrevistadores contratados em novembro de 2013 para a realização de novos cadastros",
		qualitative_progress_5: "200 Agentes de Saúde e 22 Agentes de Gestão de Politicas Públicas de Unidades Básicas de Saúde (UBS) capacitados como entrevistadores para a realização de novos cadastros",
		qualitative_progress_6: null,
		created_at: "0000-00-00 00:00:00",
		updated_at: "2014-04-03 12:37:19",
		porcentagem: {
			concluido: 48.988928571429,
			restante: 51.011071428571
		},
		secretaries: [
		{
			id: "2",
			name: "Secretaria Municipal de Assistência Social",
			acronym: "SMADS",
			created_at: "0000-00-00 00:00:00",
			updated_at: "0000-00-00 00:00:00",
			pivot: {
				goal_id: "1",
				secretary_id: "2"
			}
		},
		...],
		projects: [
		{
			id: "1119",
			name: "Famílias inseridas no Cadastro Único",
			goal_id: "1",
			project_type: "8",
			district: null,
			address: null,
			gps_lat: "0",
			gps_long: "0",
			weight_about_goal: "100.00",
			budget_executed: "9421876.53",
			qualitative_progress_1: null,
			qualitative_progress_2: null,
			qualitative_progress_3: null,
			qualitative_progress_4: null,
			qualitative_progress_5: null,
			qualitative_progress_6: null,
			created_at: "2014-04-03 12:38:12",
			updated_at: "2014-04-03 12:38:12",
			prefectures: [
			{
				id: "1",
				name: "Aricanduva/Formosa/Carrão",
				acronym: "AF",
				created_at: "0000-00-00 00:00:00",
				updated_at: "0000-00-00 00:00:00",
				pivot: {
				project_id: "1119",
				prefecture_id: "1"
			},
			{
				id: "33",
				name: "Supra-regional",
				acronym: "SR",
				created_at: "0000-00-00 00:00:00",
				updated_at: "0000-00-00 00:00:00",
				pivot: {
					project_id: "1119",
					prefecture_id: "33"
				}
			},
			...]
		}]
	},

• /goal/1 -> detalhes da meta 1
• /goal/1/status -> retorna a porcentagem total da meta
• /goal/1/progress -> retorna progresso por grupo de etapas e/ou por mês
• /goal/1/follow -> seguir meta #1 POST { email: "lucaspirola@gmail.com", nome: "Lucas Pirola", goal_id: 1 }
• /goal/1/projects -> lista de projetos da meta 1

Projetos

• /project/1 -> detalhes do projeto 1

{
	id: "1",
	name: "Ecoponto Água Rasa",
	goal_id: "91",
	project_type: "1",
	district: "Água Rasa",
	address: "Av. Salim Farah Maluf, 1500",
	gps_lat: "-23.556476",
	gps_long: "-46.577297",
	weight_about_goal: "1.19",
	budget_executed: "157992.35",
	qualitative_progress_1: null,
	qualitative_progress_2: null,
	qualitative_progress_3: null,
	qualitative_progress_4: null,
	qualitative_progress_5: null,
	qualitative_progress_6: null,
	created_at: "2014-04-03 12:37:32",
	updated_at: "2014-04-03 12:37:32",
	goal: {
		id: "91",
		objective_id: "15",
		axis_id: "2",
		articulation_id: "1",
		name: "Implantar 84 novos Ecopontos",
		will_be_delivered: "84 Ecopontos implantados",
		total_cost: "57443426.00",
		schedule_2013_2014: "39 ecopontos",
		schedule_2015_2016: "45 ecopontos",
		observation: "A concepção do ecoponto é oferecer ao munícipe uma opção para a entrega voluntária de resíduos, sobretudo os provenientes de pequenas reformas e materiais inservíveis, como sofás, colchões, eletrodomésticos. O equipamento é entregue devidamente cercado e com portão de acesso e totem de identificação, equipado com baias para o recebimento de resíduos volumosos, caçambas para resíduos da construção civil e containers para o acondicionamento de material reciclável, em uma área impermeabilizada, com iluminação e vigilância (horário de operação: 2a.feira a sábado das 6h às 22h e aos domingos e feriados das 6h às 18h). As áreas onde serão implantadas os novos ecopontos priorizam os distritos que ainda não dispõem desse equipamento.",
		technically: "Ecoponto: Equipamento com aproximadamente 800 m², com acesso para veículos e caminhões, localizado próximo a áreas com histórico de descarte irregular de resíduos para a recepção voluntária de pequenos volumes de resíduos da construção civil e demolição (até 1m³), resíduos volumosos (móveis inservíveis, colchões, restos de poda) e materiais recicláveis, cuja operação é realizada pelas empresas contratadas para a realização dos serviços de limpeza indivisíveis (varrição, lavagem de vias, remoção de objetos volumosos e outros).",
		status: "3",
		transversalidade: "agenda-pop-rua",
		qualitative_progress_1: "18 Ecopontos implantados.",
		qualitative_progress_2: "Subprefeituras beneficiadas: Butantã, Campo Limpo, Freguesia/Brasilândia, Itaquera, Lapa, Mooca, Penha, Perus, Pinheiros, Santana/Tucuruvi, São Miguel e Vila Maria/Vila Guilherme.",
		qualitative_progress_3: null,
		qualitative_progress_4: null,
		qualitative_progress_5: null,
		qualitative_progress_6: null,
		created_at: "0000-00-00 00:00:00",
		updated_at: "2014-04-03 12:37:20"
	},
	prefectures: [
		{
			id: "18",
			name: "Mooca",
			acronym: "MO",
			created_at: "0000-00-00 00:00:00",
			updated_at: "0000-00-00 00:00:00",
			pivot: {
				project_id: "1",
				prefecture_id: "18"
			}
		}]
}

• /projects/types -> lista tipos de projetos disponíveis (9 ao todo)
• /projects/type/{id}/milestones -> retorna as fases do tipo de projeto passado por parâmetro
• /project/{id}/progress -> retorna progresso do projeto; diferentes estruturas de dados, dependendo do tipo do projeto

Auxiliares

• /axes -> lista eixos diponíveis
• /articulations -> lista articulações diponíveis
• /objectives -> lista objetivos diponíveis
• /secretaries -> lista secretarias diponíveis
• /prefectures -> lista sub-prefeitura diponíveis
• /prefectures/findByCoordinates/{lat}/{long} -> procura sub-prefeitura por coordenadas