Documentação

Documento que descreve comportamento específico da API SnapProperty, para integração com a Imobiliar.

Documentação Imobiliar

http://imobiliar.inf.br:4001/webservice/Imobiliar

Índice

Métodos de negócio

Métodos de Recebimento

        Métodos que tem como objetivo receber requisições da Imobiliar.

ContratoRest.cancelar

Descrição: Método responsável por cancelar um contrato de administração ou locação (snap_brok__Contrato__c).

Neste método será possível o cancelamento de um contrato , antes que tenha sido assinado. 

Tipo de parâmetro: Contrato.

Método Rest: Post

Tipo: Síncrono

Máximo de registros por requisição: 1

                <instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Processamento SnapProperty

                1. SnapProperty realiza busca em contratos(snap_brok__Contrato__c) com base

                    no Id ou Id externo informado.

                2. Caso não encontrado contrato, retorna mensagem de erro informando que "Contrato não foi localizado".

                3. SnapProperty verifica se contrato já consta como cancelado: snap_brok__Cancelado__c igual a true.

4. SnapProperty verifica se contrato já consta como assinado: snap_brok__Assinado__c igual a true.

5. Se contrato já estiver cancelado ou assinado retornara erro, não atualizara o contrato.

6. Se não houver impedimento para o cancelamento o SnapProperty atualiza contrato: 

     6.1 Situação (Situacao__c) do contrato para "Cancelado".

     6.2 Cancelado (Cancelado__c) para verdadeiro(true).

     6.3 Data do cancelamento (Data_cancelamento__c) para data atual (Today).

     6.4 Demais informações como recebido no request.  

7. SnapProperty verifica tipo de registro do contrato:

     7.1 Se contrato é de Locação:

            7.1.1 Cancela-la a locação com as mesmas atualizações  de cancelamento do contrato.

            7.1.2 . Cancela-la a proposta com as mesmas atualizações  de cancelamento do contrato.

    7.2 Se contrato é de Administração: 

             7.2.1 Cancela-la a captação com as mesmas atualizações de cancelamento do contrato.

ContratoRest.distratarContratoAdministracao

Descrição: Método responsável por distrato de um contrato de administração (snap_brok__Contrato__c).

Neste método será possível

encerrar um contrato de administração, sem possuir ainda um contrato de Locação criado. 

Deve ser utilizado, por exemplo, quando o cliente quer encerrar o contrato com a administradora, por ter desistido de locar o imóvel.

Método Rest: Post

Tipo de parâmetro: Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Processamento SnapProperty

                    no Id ou Id externo informado.

Processamento SnapProperty

  1. SnapProperty realiza busca em contratos(snap_brok__

Contrato__c

4. SnapProperty verifica se contrato já consta como assinado: snap_brok__Assinado__c igual a true.

5. Se contrato já estiver cancelado ou assinado retornara erro, não atualizara o contrato.

) com base

                    no Id ou Id externo informado.

                 2. Caso não encontrado contrato, retorna mensagem de erro informando que contrato não foi localizado.

                 3. Se não houver impedimento para o

distrato o SnapProperty atualiza contrato: 

3.1

"Situação" (snap_brok__Situacao__c) do contrato para "

Distratado".

 4. Pesquisar todos Imóveis do contrato:

4.1

Altera a "Situação" (snap_brok__Situacao__c) do imóvel para  "Indisponível". 

4.2 Altera o campo "Disponível para locação"(snap_brok__Disponivel_locacao__c) para falso(false).

ContratoRest.

desocuparImovel

Descrição: Método responsável por distrato desocupação de um contrato de administração imóvel pelo locatário (snap_brok__Contrato__c).

Neste método será possível encerrar um contrato de administração, sem possuir ainda um contrato de Locação criado. Deve ser utilizado, por exemplo, quando o cliente quer encerrar o contrato com a administradora, por ter desistido de locar o imóveldesocupar um imóvel, que ocasionará no distrato do contrato de locação

e disponibilizar um imóvel para uma nova locação.

Método Rest: Post

Tipo de parâmetro: Contrato Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Processamento SnapProperty

                1. SnapProperty realiza busca em contratos(snap_brok__Contrato__c) com base

                    no Id ou Id externo informadoinformado.

 2. Caso não encontrado contrato, retorna mensagem de erro informando que contrato não foi localizado.

                3. Se não houver impedimento para a desocupação SnapProperty atualiza contrato de locação:

       3.1 "Situação"(snap_brok__Situacao__c) para "Encerrado".

                 3. Se não houver impedimento para o distrato o SnapProperty atualiza contrato: 

 3.2 "Ativo" (snap_brok__Ativo__c) igual a falso(false).

       3.3 "Faturar" (snap_brok__Faturar__c) igual a falso(false).

       3.4 Atualiza "Valor do aluguel corrigido" (snap_brok__Valor_aluguel_

corrigido__c)

para o valor recebido no request.  

 4.3 "Data de encerramento" igual a data do sistema(Today).

  4. Pesquisar todos Imóveis do contrato:

                      4.1 Altera a "Situação" (snap_brok__Situacao__c) do imóvel para  "IndisponívelDisponivel". 

                      4.2 Altera o campo "Disponível para locação"(snap_brok__Disponivel_locacao__c) para falso(false)."Disponível para locação" para verdadeiro (true).               

ContratoRest.

desocuparImovelComDistratoAdm

Descrição: Método responsável por desocupação de um imóvel pelo locatário e término do contrato de administração(snap_brok__Contrato__c).

Neste método será possível desocupar um imóvel, que ocasionará no distrato do contrato de locação

e disponibilizar um imóvel para uma nova locaçãocancelará também o contrato de administração.

Método Rest: Post

Tipo de parâmetro: Contrato Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Processamento SnapProperty

                    no Id ou Id externo informado.

 2. Caso não encontrado contrato, retorna mensagem de erro informando que contrato não foi localizado.

                3. Se não houver impedimento para a desocupação SnapProperty atualiza contrato de locação:

       4.3 "Data de encerramento" igual a data do sistema(Today).

Processamento SnapProperty

                      4.1 Altera a "Situação"   1. SnapProperty realiza busca em contratos(snap_brok__SituacaoContrato__c) do imóvel para  "Disponivel". com base

                    no Id ou Id externo informado.

 2. Caso não encontrado contrato, retorna mensagem de erro informando que contrato não foi localizado.

 3. Se não houver impedimento para a desocupação do imóvel e distrato do contrato de administração

ContratoRest.desocuparImovelComDistratoAdm

o SnapProperty atualiza contrato de locação:

       3.1 "Situação"(snap_brok__Situacao__c) para "Encerrado".

       3.2 "Ativo" (snap_brok__Ativo__c) igual a falso(false).

       3.3 "Faturar" (snap_brok__Faturar__c) igual a falso(false).

       3.4 "Data de encerramento" igual a data do sistema(Today).

  4. Pesquisar todos Imóveis do contrato:

                      4.1 Altera a "Situação" (snap_brok__

Situacao__c)

Neste método será possível desocupar um imóvel, que ocasionará no distrato do contrato de locação

e cancelará também o contrato de administração.

Método Rest: Post

Tipo de parâmetro: Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

• Informado o Id externo do contrato de locação no sistema que está realizando a desocupação.
• Informado o Id Salesforce do contrato, de locação, que pode ter sido obtido em uma busca ou inserção.

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Exemplo: Método

Post

Exemplo: URL

https://snap-property.salesforce.com/services/apexrest/snap_brok/contrato/v1/desocuparImovelComDistratoAdm

{

  "contrato": {

   "snap_brok__Id_externo__c":"2236262",

   "snap_brok__Valor_aluguel_corrigido__c":"2500.32"

 }

}

• Valores monetários devem seguir a seguinte formatação: todo o número junto e o "."(ponto) para separar os centavos. Exemplo: 1200.40(Mil e duzentos reais e quarenta centavos).

Exemplo: Resposta - Sucesso

{
"Mensagem": "Sucesso",
"Erro": false,
"Contrato": {
"attributes": {
"type": "snap_brok__Contrato__c",
"url": "/services/data/v41.0/sobjects/snap_brok__Contrato__c/a0l0B00001JoA23QAF"
},
"snap_brok__Id_externo__c": "TesteDevLoc",
"snap_brok__Ativo__c": false,
"snap_brok__Faturar__c": false,
"snap_brok__Data_encerramento__c": "2019-03-27",
"snap_brok__Situacao__c": "Encerrado",
"Id": "a0l0B00001JoA23QAF"
}
}

Exemplo: Resposta - Falha

Contrato não localizado.

Processamento SnapProperty

                1. SnapProperty realiza busca em contratos(snap_brok__Contrato__c) com base

                    no Id ou Id externo informado.

 2. Caso não encontrado contrato, retorna mensagem de erro informando que contrato não foi localizado.

         3. Se não houver impedimento para a desocupação do imóvel e distrato do contrato de administração

              o SnapProperty atualiza contrato de locação:

       3.1 "Situação"(snap_brok__Situacao__c) para "Encerrado".

       3.2 "Ativo" (snap_brok__Ativo__c) igual a falso(false).

       3.3 "Faturar" (snap_brok__Faturar__c) igual a falso(false).

       3.4 "Data de encerramento" igual a data do sistema(Today).

  4. Pesquisar todos Imóveis do contrato:

                      4.1 Altera a "Situação" (snap_brok__Situacao__c) do imóvel para  "Indisponivel". 

                      4.2 Altera "Disponível para locação" para falso(false).

                  5. Pesquisa os contratos de administração dos Imóveis do contrato:

                      5.1 Altera Situação(snap_brok__Situacao__c) igual "Distratado".

ContratoRest.desocuparImovelIDExterno

Descrição: Método responsável por desocupação de um imóvel pelo locatário (snap_brok__Contrato__c).

Neste método será possível desocupar um imóvel, que ocasionará no distrato do contrato de locação

e disponibilizar um imóvel para uma nova locação, utilizando-se do id do imó´vel para essa desocuapação.

Método Rest: Post

Tipo de parâmetro: Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

Informado o Id externo do contrato imóvel, no sistema que está realizando a desocupação.

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Exemplo: Método

Post

Exemplo: URL

https://snap-property.salesforce.com/services/apexrest/snap_brok/contrato/v1/desocuparImovelIDImovel

{

  "imovel": 

 {

   "snap_brok__ID_externo__c":"CR12345",

 }

}

Exemplo: Resposta - Sucesso

{
"Mensagem": "Sucesso",
"Erro": false,
"Contrato": {
"attributes": {
"type": "snap_brok__Imovel__c",
"url": "/services/data/v41.0/sobjects/snap_brok__Imovel__c/a0l0B00001JoA23QAF"
},
"snap_brok__Id_externo__c": "CR12345",
"Id": "a0l0B00001JoA23QAF"
}
}

Exemplo: Resposta - Falha

Imóvel não encontrado

Processamento SnapProperty

                1. SnapProperty realiza busca em imóveis(snap_brok__Imovel__c) com base no Id externo informado

                 2. Caso não encontrado imóvel, retorna mensagem de erro informando que imóvel não foi localizado

                 3. Localizando o imóvel

                      3.1 Altera a "Situação" (snap_brok__Situacao__c) do imóvel para  "Aguardando aprovação"

                      3.2 Pesquisa os contratos de locação do imóvel:

                 3.2.1 Se não houver impedimento para a desocupação SnapProperty atualiza contrato de locação:

           3.2.1.1 "Situação"(snap_brok__Situacao__c) para "Encerrado".

           3.2.1.2 "Ativo" (snap_brok__Ativo__c) igual a falso(false).

           3.2.1.3 "Faturar" (snap_brok__Faturar__c) igual a falso(false).

           3.2.1.4 "Data de encerramento" igual a data do sistema(Today)

do imóvel para  "Indisponivel". 

                      4.2 Altera "Disponível para locação" para falso(false).

                  5. Pesquisa os contratos de administração dos Imóveis do contrato:

                      5.1 Altera Situação(snap_brok__Situacao__c) igual "Distratado".

ContratoRest.desocuparImovelIDExterno

Descrição: Método responsável por desocupação de um imóvel pelo locatário (snap_brok__Contrato__c).

Neste método será possível desocupar um imóvel, que ocasionará no distrato do contrato de locação

e disponibilizar um imóvel para uma nova locação, utilizando-se do id do imó´vel para essa desocuapação.

Método Rest: Post

Tipo de parâmetro: Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza. 

Processamento SnapProperty

                1. SnapProperty realiza busca em imóveis(snap_brok__Imovel__c) com base no Id externo informado

                 2. Caso não encontrado imóvel, retorna mensagem de erro informando que imóvel não foi localizado

                 3. Localizando o imóvel

                      3.1 Altera a "Situação" (snap_brok__Situacao__c) do imóvel para  "Aguardando aprovação"

                      3.2 Pesquisa os contratos de locação do imóvel:

                 3.2.1 Se não houver impedimento para a desocupação SnapProperty atualiza contrato de locação:

           3.2.1.1 "Situação"(snap_brok__Situacao__c) para "Encerrado".

           3.2.1.2 "Ativo" (snap_brok__Ativo__c) igual a falso(false).

           3.2.1.3 "Faturar" (snap_brok__Faturar__c) igual a falso(false).

           3.2.1.4 "Data de encerramento" igual a data do sistema(Today)

ContratoRest.trocarGerente

Descrição: Método responsável por trocar a gerência do imóvel em um contrato de administração, contrato de locação e no imóvel.

Método Rest: Post

Tipo de parâmetro: Contrato.

Tipo: Síncrono

Máximo de registros por requisição: 1

<instância do cliente> : nome de instância da org salesforce que o cliente utiliza.