{{ajuda:logo-gsan3.png?90|}}

====== WebService Efetuar Autoleitura ======

<columns>
O WebService recebe apenas requisições do tipo **POST**, e os parâmetros são passados via **Query Parameter**.

Ele possui os seguintes Headers:

|Key|Value|
|client_id|testeAutoLeitura|
|client_secret|admin|

</columns>


<columns>
Ele espera o seguinte Parâmetro:

  - matricula, //Int// contendo o id do imóvel.
  - leitura, //Int// contendo a leitura do medidor/Hidrômetro do imovel.
  - foto, //String// contendo um arquivo Base64, com a imagem da leitura
  
</columns>

===== Exemplo de requisição para o sistema =====

Com a seguinte informação:

|matricula |1836421|
|leitura |5750|
|foto |https://messagefile.tatodesk.net/public/file?token=VTJGc2RHVmtYMTlidVprUHVXcG83UjJINy9kUzBIb0hsLzhrQjQwVFZuVkwyd0hlcnh2UnE2U3lqaStEV0R4SE1pdGVKOE16SS9PQ2hjQlVwQjRWTFREemp2MVp3ay9vSncxOUNTbmdvOGpoYXFraktoQ09keDBTcXZvblpNV1Zuc3RoVWNSbHA4VU9xRUs5MmlVVjBGdU11ZllTMVFDYkV4OVNGWndBa3VzPQ==|

===== Exemplo de requisição Seria =====

http://192.168.60.105:8080/gsan/api/efetuarAutoleitura

===== RAW =====

<code javascript>
      {
        "matricula":"2317591",
        "leitura":"45678",
        "foto":"https://message-file.tatodesk.net/public/file?	     token=VTJGc2RHVmtYMTg3SGZpWFhYdy96RnFPeGk2SjBDcGVwZ3J5Q3V2UjNIeTFRd3p6UDdtVGUyVjRydkxXLzNaMU0wWnRpeXpUb01TY3BmTnIrMkdOVHZ6Vk1QbWQvT0c4RmlySEVQOVJBWDhnTlR4NXY3dm5WQXhiSkE5MzcwZmRHWkRmYmtXWUlUek5ZMmpjM2lJVjVoNnpMUWd2S3F5VzhMSVBlajFkNFljPQ=="
      }
</code>

<columns>
Para a realização dos testes, foi utilizada uma imagem em formato Base64, extraída de uma
URL pública.
</columns>

===== Retorno com Sucesso =====

 - Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver desabilitado:
<code javascript>
{
    "body":{
    	"processado" : true,
        "visitaLeiturista" : false 
    }
}
</code>

 - Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver habilitado:

<code javascript>
{
    "body":{
    	"processado" : true,
        "visitaLeiturista" : true 
    }
}
</code>

===== Retorno em caso de Erro =====

 - Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver desabilitado:
<code javascript>
{
    "body":{
    	"processado" : false,
        "visitaLeiturista" : false 
    }
}
</code>

 - Quando o parâmetro do sistema “GERAR_IMOVEL_AUTOLEITURA_PARA_CAMPO” estiver habilitado:

<code javascript>
{
    "body":{
    	"processado" : false,
        "visitaLeiturista" : true 
    }
}
</code>

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|Body
|200|"OK"|
|500|"Internal Server Error"|
|404|"Page not found"|
|422|"Não foi possível encontrar o período"|


\\

Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.