Adicionar Metas

De Wiki iScore
(Diferença entre revisões)
Ir para: navegação, pesquisa
(Envio)
Linha 1: Linha 1:
 
== Descrição ==
 
== Descrição ==
  
Cadastro e alteração de Metas
+
Recebe um xml contendo metas e as salva no bando de dados.
  
== URL ==
 
  
<pre>http://api.iscore.com.br/:identificador/:sigla_empresa/metas.xml?token=:token_usuario</pre>
+
== URL (XML)==
 +
 
 +
http://api.iscore.com.br/:identificador/metas.xml?token=:token
 +
 
 +
 
 +
== URL (JSon)==
 +
 
 +
http://api.iscore.com.br/:identificador/metas.json?token=:token
 +
 
 +
 
 +
==Parâmetros==
  
* Parâmetros
 
 
<pre>
 
<pre>
:identificador   - Identificador cadastrado na base de dados iSCORE Gerencial
+
:identificador               - Identificador utilizado para efetuar o login no sistema (Iscore)                       
:sigla_empresa    - Sigla da empresa que deseja listar as metas
+
:token                        - Todo usuário possui um token que é único e identifica o mesmo na API.
:token_usuario    - Token do usuário que está solicitando a operação
+
                             
 
</pre>
 
</pre>
  
== Envio ==
 
  
* Tipo: XML
+
== Método HTTP==
* Descrição: O XML informado para ser realizada a inserção deve ser conforme exemplo abaixo.
+
 
* Exemplo:
+
POST
 +
 
 +
== Informações do Recurso==
 +
 
 +
• Limite de requests? '''Sim'''
 +
 
 +
• Nível de privilégio mínimo? '''Escrita'''
 +
 
 +
• Formatos de response? '''xml'''
 +
 
 +
• HTTP Method '''POST'''
 +
 
 +
 
 +
'''EXEMPLO DE XML PARA ADIÇÃO'''
 +
 
 
<pre>
 
<pre>
<?xml version="1.0" encoding="UTF-8" ?>
+
<code class="xml">
 
<metas>
 
<metas>
<meta>
+
  <meta>
<indicador_id>16</indicador_id>
+
    <indicador_id>27</indicador_id>
<mes>2</mes>
+
    <ano>2013</ano>
<ano>2012</ano>
+
    <mes>1</mes>
<valor>5,000</valor>
+
    <valor>324</valor>
<tipo>r</tipo>
+
    <tipo>p</tipo>
</meta>
+
  </meta>
+
  <meta>
<meta>
+
    <indicador_id>27</indicador_id>
<indicador_id>83</indicador_id>
+
    <ano>2013</ano>
<mes>2</mes>
+
    <mes>4</mes>
<ano>2012</ano>
+
    <valor>1104</valor>
<valor>10,000</valor>
+
    <tipo>p</tipo>
<tipo>r</tipo>
+
  </meta>
</meta>
+
 
</metas>
 
</metas>
</pre>
+
</code>
  
== Retorno ==
 
 
* Tipo: XML
 
* Exemplo:
 
<pre>
 
<mensagem>MENSAGEM RETORNADA PELA API</mensagem>
 
 
</pre>
 
</pre>

Edição das 14h25min de 12 de março de 2012

Índice

Descrição

Recebe um xml contendo metas e as salva no bando de dados.


URL (XML)

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


URL (JSon)

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


Parâmetros

:identificador                - Identificador utilizado para efetuar o login no sistema (Iscore)                        
:token                        - Todo usuário possui um token que é único e identifica o mesmo na API. 
                               


Método HTTP

POST

Informações do Recurso

• Limite de requests? Sim

• Nível de privilégio mínimo? Escrita

• Formatos de response? xml

• HTTP Method POST


EXEMPLO DE XML PARA ADIÇÃO

<code class="xml">
<metas>
  <meta>
    <indicador_id>27</indicador_id>
    <ano>2013</ano>
    <mes>1</mes>
    <valor>324</valor>
    <tipo>p</tipo>
  </meta>
  <meta>
    <indicador_id>27</indicador_id>
    <ano>2013</ano>
    <mes>4</mes>
    <valor>1104</valor>
    <tipo>p</tipo>
  </meta>
</metas>
</code>

Ferramentas pessoais
Espaços nominais

Variantes
Ações
Navegação
Ferramentas