POST api/Farol/Farol

Retorna o Farol de um Indicador

Request Information

URI Parameters

None.

Body Parameters

IdDaUnidade IdDoPlanoDeGestao Data Frequencia FormaDeVisualizacao [1 - Apurado, 2- Acumulado]

PortalSIM.Domain.Performance.API.FiltroDoFarol

Name	Type	Additional information
Cenario	PortalSIM.Domain.Indicadores.Cenario	Documentação não disponível
CompararCom	PortalSIM.Domain.Indicadores.TipoDeValor	Documentação não disponível
CompararDe	PortalSIM.Domain.Indicadores.TipoDeValor	Documentação não disponível
FormaDeVisualizacao	PortalSIM.Domain.Indicadores.FormaDeVisualizacao	Documentação não disponível
Frequencia	PortalSIM.Domain.Indicadores.Frequencia	Documentação não disponível
Data	date	Documentação não disponível
FiltroAvancado	boolean	Documentação não disponível
IdDaUnidade	integer	Documentação não disponível
IdDoPlanoDeGestao	integer	Documentação não disponível
IdDaVisao	integer	Documentação não disponível
AnoDoPlanoDeGestao	integer	Documentação não disponível

Request Formats

application/json, text/json

Sample:

{
  "Cenario": 1,
  "CompararCom": 0,
  "CompararDe": 0,
  "FormaDeVisualizacao": 1,
  "Frequencia": 0,
  "Data": "2024-11-23T17:31:49.0596684+00:00",
  "FiltroAvancado": true,
  "IdDaUnidade": 1,
  "IdDoPlanoDeGestao": 1,
  "IdDaVisao": 1,
  "AnoDoPlanoDeGestao": 3
}

application/xml, text/xml

Sample:

<FiltroDoFarol xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortalSIM.Domain.Performance.API">
  <AnoDoPlanoDeGestao>3</AnoDoPlanoDeGestao>
  <Cenario>PercentualDeAtingimento</Cenario>
  <CompararCom>Real</CompararCom>
  <CompararDe>Real</CompararDe>
  <Data>2024-11-23T17:31:49.0596684+00:00</Data>
  <FiltroAvancado>true</FiltroAvancado>
  <FormaDeVisualizacao>Apurado</FormaDeVisualizacao>
  <Frequencia>Indefinido</Frequencia>
  <IdDaUnidade>1</IdDaUnidade>
  <IdDaVisao>1</IdDaVisao>
  <IdDoPlanoDeGestao>1</IdDoPlanoDeGestao>
</FiltroDoFarol>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.