Buscar Indicador pelo ID

De Wiki iScore
(Diferença entre revisões)
Ir para: navegação, pesquisa
(URL)
Linha 1: Linha 1:
 
== Descrição ==
 
== Descrição ==
  
Listagem de todas as informações do Indicador solicitado por meio do seu ID.
+
Lista o indicador de uma determinada organizacional, correspondente ao ID informado.
  
== URL ==
 
  
<pre>http://api.iscore.com.br/:identificador/:sigla_empresa/metas/indicador/:id_indicador.xml?token=:token_usuario</pre>
+
== URL (XML)==
 +
 
 +
http://api.iscore.com.br/:identificador/indicador/:indicador_id.xml?token=:token
 +
 
 +
 
 +
== URL (JSon)==
 +
 
 +
http://api.iscore.com.br/:identificador/indicador/:id_indicador.json?token=:token
 +
 
 +
 
 +
==Parâmetros==
  
* Parâmetros
 
 
<pre>
 
<pre>
:identificador   - Identificador usado para fazer login no iSCORE
+
:identificador               - Identificador utilizado para efetuar o login no sistema
:sigla_empresa    - Sigla da empresa que deseja listar as metas
+
:identificador_id            - ID do indicador, o mesmo pode ser visto na tela de Resultados ao lado do nome
:id_indicador    - Id do Indicador
+
                                do mesmo e na unidade de medida                       
:token_usuario    - Token do usuário que está solicitando a operação
+
:token                        - Todo usuário possui um token que é único e identifica o mesmo na API.
 +
                             
 
</pre>
 
</pre>
 +
 +
 +
== Método HTTP==
 +
 +
GET
 +
  
 
== Retorno ==
 
== Retorno ==
* Tipo: XML
+
 
* Exemplo:
+
'''XML'''
 +
 
 +
<pre>
 +
<indicador>
 +
    <id>5</id>
 +
    <descricao>
 +
        Número de visitas realizadas aos Clientes em um determinado período
 +
    </descricao>
 +
    <responsavel>João Silva</responsavel>
 +
    <iniciativa>Executar o programa de visitas a Clientes da NTech</iniciativa>
 +
    <menor_melhor>0</menor_melhor>
 +
    <limite_minimo/>
 +
    <limite_maximo/>
 +
    <objetivo_estrategico_id>4</objetivo_estrategico_id>
 +
    <unidade_de_medida_id>4</unidade_de_medida_id>
 +
    <processo_id/>
 +
    <status>1</status>
 +
    <nome>Nº de Visitas Efetuadas a Clientes</nome>
 +
    <ordem>1</ordem>
 +
    <metodo_calculo/>
 +
</indicador>
 +
</pre>
 +
 
 +
 
 +
'''JSon'''
 +
 
 
<pre>
 
<pre>
<metas>
+
{
     <meta>
+
     Indicador: {
         <indicador_id>5</indicador_id>
+
         id: 5,
         <mes>8</mes>
+
         descricao: "Número de visitas realizadas aos Clientes em um determinado período",
         <ano>2010</ano>
+
         responsavel: "João Silva",
         <valor>30,0000</valor>
+
         iniciativa: "Executar o programa de visitas a Clientes da NTech",
         <tipo>p</tipo>
+
         menor_melhor: false,
    </meta>
+
        limite_minimo: null,
    <meta>
+
        limite_maximo: null,
         <indicador_id>5</indicador_id>
+
         objetivo_estrategico_id: 4,
         <mes>8</mes>
+
         unidade_de_medida_id: 4,
         <ano>2010</ano>
+
         processo_id: null,
         <valor>40,0000</valor>
+
        status: true,
         <tipo>r</tipo>
+
        nome: "Nº de Visitas Efetuadas a Clientes",
     </meta>
+
         ordem: 1,
</metas>
+
         metodo_calculo: null
 +
     }
 +
}
 
</pre>
 
</pre>

Edição das 10h13min de 9 de março de 2012

Índice

Descrição

Lista o indicador de uma determinada organizacional, correspondente ao ID informado.


URL (XML)

http://api.iscore.com.br/:identificador/indicador/:indicador_id.xml?token=:token


URL (JSon)

http://api.iscore.com.br/:identificador/indicador/:id_indicador.json?token=:token


Parâmetros

:identificador                - Identificador utilizado para efetuar o login no sistema
:identificador_id             - ID do indicador, o mesmo pode ser visto na tela de Resultados ao lado do nome 
                                do mesmo e na unidade de medida                        
:token                        - Todo usuário possui um token que é único e identifica o mesmo na API. 
                               


Método HTTP

GET


Retorno

XML

<indicador>
    <id>5</id>
    <descricao>
        Número de visitas realizadas aos Clientes em um determinado período
    </descricao>
    <responsavel>João Silva</responsavel>
    <iniciativa>Executar o programa de visitas a Clientes da NTech</iniciativa>
    <menor_melhor>0</menor_melhor>
    <limite_minimo/>
    <limite_maximo/>
    <objetivo_estrategico_id>4</objetivo_estrategico_id>
    <unidade_de_medida_id>4</unidade_de_medida_id>
    <processo_id/>
    <status>1</status>
    <nome>Nº de Visitas Efetuadas a Clientes</nome>
    <ordem>1</ordem>
    <metodo_calculo/>
</indicador>


JSon

{
    Indicador: {
        id: 5,
        descricao: "Número de visitas realizadas aos Clientes em um determinado período",
        responsavel: "João Silva",
        iniciativa: "Executar o programa de visitas a Clientes da NTech",
        menor_melhor: false,
        limite_minimo: null,
        limite_maximo: null,
        objetivo_estrategico_id: 4,
        unidade_de_medida_id: 4,
        processo_id: null,
        status: true,
        nome: "Nº de Visitas Efetuadas a Clientes",
        ordem: 1,
        metodo_calculo: null
    }
}
Ferramentas pessoais
Espaços nominais

Variantes
Ações
Navegação
Ferramentas