voltar

API Referências: Imovel | Consultar

post /api/Imovel/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AceitaFinanciamento: bit,
          AceitaPermuta: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          Arquivado: bit,
          ArquivoAnexo: string,
          ArquivoAnexo2: string,
          AtivarIntegracaoCasaMineira: bit,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoImovelGuide: bit,
          AtivarIntegracaoImovelWeb: bit,
          AtivarIntegracaoMercadoLivre: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoWimoveis: bit,
          AtivarIntegracaoZap: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          CodigoDwv: string,
          CodigoIntegracaoEnviadoMercadoLivre: text,
          CodigoTipoSubtipoCasaMineira: string,
          CodigoTipoSubtipoImovelWeb: string,
          CodigoTipoSubtipoWimoveis: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Condominio: bit,
          Construcao: bit,
          Corretor: uniqueidentifier,
          CorretorDescricao: string,
          CpfProprietario: string,
          DescricaoCasaMineira: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoImovelGuide: string,
          DescricaoImovelWeb: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          DescricaoWimoveis: string,
          Destaque: bit,
          DestaqueCasaMineira: bit,
          DestaqueChavesNaMao: bit,
          DestaqueImovelGuide: bit,
          DestaqueImovelWeb: bit,
          DestaqueWimoveis: bit,
          Detalhe: text,
          DetalheZap: string,
          Disponivel: bit,
          EmailProprietario: string,
          EmailProprietario2: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          EstudaPermuta: bit,
          ExibirSite: bit,
          Hash: uniqueidentifier,
          Hashtags: string,
          HashtagsReferenciaInterna: string,
          Imagem: string,
          Imagem2: string,
          InicioEmpreendimento: smalldatetime,
          InstagramProprietario: string,
          IntegradoMercadoLivre: bit,
          LinkMercadoLivre: string,
          LinkYoutube: string,
          MensagemDwv: string,
          MensagemGaleriaDwv: string,
          MercadoLivre: string,
          MercadoLivreBairro: string,
          MercadoLivreBuyingMode: string,
          MercadoLivreCategory: string,
          MercadoLivreCidade: string,
          MercadoLivreEstado: string,
          MercadoLivreListingType: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          Notificavel: bit,
          Novo: bit,
          ObservacoesAdicionais: text,
          OperacaoCasaMineira: string,
          OperacaoImovelWeb: string,
          OperacaoWimoveis: string,
          OrdenacaoGaleriaFotos: string,
          OrdenacaoGaleriaImagensPlantas: string,
          PeriodicidadeLocacao: string,
          Planta: bit,
          PontoReferencia: string,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          Proprietario2: string,
          QuantidadeAndares: int,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeElevadores: int,
          QuantidadePessoasTemporada: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          RegiaoImovelDescricao: string,
          RegistroIncorporacao: string,
          Residencia: string,
          ResidenciaProprietario: string,
          RetornoMercadoLivre: text,
          RgProprietario: string,
          Subtipo: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          TelefoneProprietario2: string,
          TerminoEmpreendimento: smalldatetime,
          TipoContratoZap: string,
          TipoImovel: int,
          TipoLocalizacaoImovel: int,
          TipoNegociacao: int,
          TipoPublicacaoCasaMineira: string,
          TipoPublicacaoImovelWeb: string,
          TipoPublicacaoWimoveis: string,
          Titulo: string,
          Unidade: string,
          UpdateDwv: smalldatetime,
          UpdateGaleriaDwv: smalldatetime,
          UrlAmigavel: string,
          UrlImagemExterna: string,
          UrlProprietario: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          ValorTemporada: decimal(18,2),
          VirtualCategoriaImovel: string,
          VirtualEspacoImovel: string,
          VirtualGaleriaFotos: string,
          VirtualGaleriaImagensPlantas: string,
          VirtualImovelComodidadeCondominio: string,
          VirtualImovelComodidadeLocalizacao: string,
          VirtualImovelRelacionado: string,
          VirtualProprietarioImovel: string,
          VirtualTipoImovel: string,
          VirtualTipoNegociacao: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Excluir

post /api/Imovel/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Listar

post /api/Imovel/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AceitaFinanciamento: bit,
          AceitaPermuta: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          Arquivado: bit,
          AtivarIntegracaoCasaMineira: bit,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoImovelGuide: bit,
          AtivarIntegracaoImovelWeb: bit,
          AtivarIntegracaoMercadoLivre: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoWimoveis: bit,
          AtivarIntegracaoZap: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          CepProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          CodigoDwv: string,
          CodigoIntegracaoEnviadoMercadoLivre: text,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Condominio: bit,
          Construcao: bit,
          Corretor: uniqueidentifier,
          CpfProprietario: string,
          DescricaoCasaMineira: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoImovelGuide: string,
          DescricaoImovelWeb: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          DescricaoWimoveis: string,
          Destaque: bit,
          DestaqueCasaMineira: bit,
          DestaqueChavesNaMao: bit,
          DestaqueImovelGuide: bit,
          DestaqueImovelWeb: bit,
          DestaqueWimoveis: bit,
          Detalhe: text,
          DetalheZap: string,
          Disponivel: bit,
          EmailProprietario: string,
          EmailProprietario2: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          EstudaPermuta: bit,
          ExibirSite: bit,
          Hash: uniqueidentifier,
          Hashtags: string,
          HashtagsReferenciaInterna: string,
          InicioEmpreendimento: smalldatetime,
          InstagramProprietario: string,
          IntegradoMercadoLivre: bit,
          LinkMercadoLivre: string,
          LinkYoutube: string,
          MensagemDwv: string,
          MensagemGaleriaDwv: string,
          MercadoLivre: string,
          MercadoLivreBairro: string,
          MercadoLivreCidade: string,
          MercadoLivreEstado: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          Notificavel: bit,
          Novo: bit,
          ObservacoesAdicionais: text,
          OrdenacaoGaleriaFotos: string,
          OrdenacaoGaleriaImagensPlantas: string,
          Planta: bit,
          PontoReferencia: string,
          Privado: bit,
          QuantidadeAndares: int,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeElevadores: int,
          QuantidadePessoasTemporada: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          RegistroIncorporacao: string,
          Residencia: string,
          ResidenciaProprietario: string,
          RetornoMercadoLivre: text,
          RgProprietario: string,
          Subtipo: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          TelefoneProprietario2: string,
          TerminoEmpreendimento: smalldatetime,
          TipoImovel: int,
          TipoLocalizacaoImovel: int,
          TipoNegociacao: int,
          Titulo: string,
          Unidade: string,
          UpdateDwv: smalldatetime,
          UpdateGaleriaDwv: smalldatetime,
          UrlAmigavel: string,
          UrlImagemExterna: string,
          UrlProprietario: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          ValorTemporada: decimal(18,2),
          VirtualCategoriaImovel: text,
          VirtualEspacoImovel: text,
          VirtualGaleriaFotos: string,
          VirtualGaleriaImagensPlantas: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
          VirtualImovelRelacionado: text,
          VirtualProprietarioImovel: string,
          VirtualTipoImovel: text,
          VirtualTipoNegociacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Salvar

post /api/Imovel/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AceitaFinanciamento: bit,
     AceitaPermuta: bit,
     AcessoLiberado: text,
     Ano: int,
     Arquivado: bit,
     ArquivoAnexo: varchar,
     ArquivoAnexo2: varchar,
     AtivarIntegracaoCasaMineira: bit,
     AtivarIntegracaoChavesNaMao: bit,
     AtivarIntegracaoImovelGuide: bit,
     AtivarIntegracaoImovelWeb: bit,
     AtivarIntegracaoMercadoLivre: bit,
     AtivarIntegracaoOlx: bit,
     AtivarIntegracaoWimoveis: bit,
     AtivarIntegracaoZap: bit,
     Bairro: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Codigo: varchar,
     CodigoDwv: varchar,
     CodigoIntegracaoEnviadoMercadoLivre: text,
     CodigoTipoSubtipoCasaMineira: varchar,
     CodigoTipoSubtipoImovelWeb: varchar,
     CodigoTipoSubtipoWimoveis: varchar,
     Complemento: varchar,
     Concluido: bit,
     Condominio: bit,
     Construcao: bit,
     ConsultarPorCampo: varchar,
     Corretor: uniqueidentifier,
     DescricaoCasaMineira: nvarchar,
     DescricaoChavesNaMao: varchar,
     DescricaoCodigoGoogleMaps: varchar,
     DescricaoImovelGuide: nvarchar,
     DescricaoImovelWeb: nvarchar,
     DescricaoIncorporadoYoutube: varchar,
     DescricaoIncorporadoYoutube2: varchar,
     DescricaoOlx: nvarchar,
     DescricaoWimoveis: nvarchar,
     Destaque: bit,
     DestaqueCasaMineira: bit,
     DestaqueChavesNaMao: bit,
     DestaqueImovelGuide: bit,
     DestaqueImovelWeb: bit,
     DestaqueWimoveis: bit,
     Detalhe: text,
     DetalheZap: varchar,
     Disponivel: bit,
     Empreendimento: varchar,
     Empresa: varchar,
     Endereco: varchar,
     Entrega: smalldatetime,
     EstadoFederal: uniqueidentifier,
     EstudaPermuta: bit,
     ExibirSite: bit,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Hashtags: varchar,
     HashtagsReferenciaInterna: varchar,
     Imagem: varchar,
     Imagem2: varchar,
     InicioEmpreendimento: smalldatetime,
     IntegradoMercadoLivre: bit,
     LinkMercadoLivre: varchar,
     LinkYoutube: varchar,
     MensagemDwv: nvarchar,
     MensagemGaleriaDwv: nvarchar,
     MercadoLivre: varchar,
     MercadoLivreBairro: varchar,
     MercadoLivreBuyingMode: varchar,
     MercadoLivreCategory: varchar,
     MercadoLivreCidade: varchar,
     MercadoLivreEstado: varchar,
     MercadoLivreListingType: varchar,
     Metragem: decimal,
     MetragemAlqueires: decimal,
     MetragemAreaTotal: decimal,
     MetragemComum: decimal,
     MetragemConstruida: decimal,
     MetragemHectares: decimal,
     MetragemPrivativa: decimal,
     MetragemTerreno: decimal,
     Mobiliado: bit,
     Modo: varchar,
     Notificavel: bit,
     Novo: bit,
     ObservacoesAdicionais: text,
     OperacaoCasaMineira: varchar,
     OperacaoImovelWeb: varchar,
     OperacaoWimoveis: varchar,
     OrdenacaoGaleriaFotos: nvarchar,
     OrdenacaoGaleriaImagensPlantas: nvarchar,
     PeriodicidadeLocacao: varchar,
     Planta: bit,
     PontoReferencia: varchar,
     PrioridadeExibicao: int,
     Privado: bit,
     QuantidadeAndares: int,
     QuantidadeBanheiros: int,
     QuantidadeCozinhas: int,
     QuantidadeElevadores: int,
     QuantidadePessoasTemporada: int,
     QuantidadeQuartos: int,
     QuantidadeSalas: int,
     QuantidadeSuites: int,
     QuantidadeVagasGaragem: int,
     RegiaoImovel: uniqueidentifier,
     RegistroIncorporacao: varchar,
     Residencia: varchar,
     RetornarDataSet: bit,
     RetornoMercadoLivre: text,
     Subtipo: varchar,
     Subtitulo: varchar,
     Telefone: varchar,
     TerminoEmpreendimento: smalldatetime,
     TipoContratoZap: varchar,
     TipoImovel: int,
     TipoLocalizacaoImovel: int,
     TipoNegociacao: int,
     TipoPublicacaoCasaMineira: varchar,
     TipoPublicacaoImovelWeb: varchar,
     TipoPublicacaoWimoveis: varchar,
     Titulo: varchar,
     Unidade: varchar,
     UpdateDwv: smalldatetime,
     UpdateGaleriaDwv: smalldatetime,
     UrlAmigavel: varchar,
     UrlImagemExterna: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     Valor: decimal,
     ValorAluguel: decimal,
     ValorCondominio: decimal,
     ValorConsultaPorCampo: varchar,
     ValorIptu: decimal,
     ValorTemporada: decimal,
     VirtualCategoriaImovel: text,
     VirtualEspacoImovel: text,
     VirtualGaleriaFotos: text,
     VirtualGaleriaImagensPlantas: text,
     VirtualImovelComodidadeCondominio: text,
     VirtualImovelComodidadeLocalizacao: text,
     VirtualImovelRelacionado: text,
     VirtualProprietarioImovel: nvarchar,
     VirtualTipoImovel: text,
     VirtualTipoNegociacao: text,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/imovel?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | AssociarCodigoTipoImovel

post /api/Imovel/AssociarCodigoTipoImovel?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdCodigo: varchar,
     IdEmpresa: varchar,
     IdImovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | AssociarComodidadeCondominio

post /api/Imovel/AssociarComodidadeCondominio?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Comodidade: varchar,
     IdEmpresa: varchar,
     IdImovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | AssociarTipoImovel

post /api/Imovel/AssociarTipoImovel?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     IdImovel: varchar,
     IdLegenda: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | AssociarTipoNegociacaoDwv

post /api/Imovel/AssociarTipoNegociacaoDwv?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Aluguel: varchar,
     IdEmpresa: varchar,
     IdImovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | AtualizarNomesArquivosGalerias

post /api/Imovel/AtualizarNomesArquivosGalerias?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: AtualizarNomesArquivosGalerias não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Consultar

post /api/Imovel/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     UrlAmigavel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          _RfTipoContratoZap: string,
          AcessoLiberado: text,
          Alqueires: decimal(18,2),
          Alteracao: datetime,
          Anexo: string,
          Anexo2: string,
          Ano: int,
          AnoConstrucao: int,
          ArquivoAnexo: string,
          ArquivoAnexo2: string,
          ArquivoLogotipo: string,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoZap: bit,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Banheiros: int,
          Cadastro: datetime,
          Categoria: string,
          Categoria: string,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          CodigoInterno: string,
          ComodidadesCondominio: string,
          ComodidadesLocalizacao: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Concluido_int: int,
          Concluido_str: string,
          Construcao: bit,
          Corretor.CdCreci: string,
          Corretor.DsDescricao: string,
          Corretor.DsEmail: string,
          Corretor.DsFacebook: string,
          Corretor.DsInstagram: string,
          Corretor.DsLinkWhatsapp: string,
          Corretor.DsTitulo: string,
          Corretor.DsTwitter: string,
          Corretor.DsYoutube: string,
          Corretor.Link: string,
          Corretor.NmArquivoFoto: string,
          Corretor.NrTelefone: string,
          Corretor.NrTelefoneWhatsapp: string,
          CorretorCreci: string,
          CorretorDescricao: string,
          CorretorEmail: string,
          CorretorFacebook: string,
          CorretorHash: uniqueidentifier,
          CorretorImagem: string,
          CorretorInstagram: string,
          CorretorLink: string,
          CorretorLinkWhatsapp: string,
          CorretorNome: string,
          CorretorTelefone: string,
          CorretorTitulo: string,
          CorretorTwitter: string,
          CorretorWhatsapp: string,
          CorretorYoutube: string,
          Cozinhas: int,
          CpfProprietario: string,
          DataEntrega: smalldatetime,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          Destaque: bit,
          Detalhe: text,
          DetalheZap: string,
          Email: string,
          EmailProprietario: string,
          EmbedYoutube: string,
          EmbedYoutube2: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          EstadoUF: string,
          ExibirSite: bit,
          GoogleMaps: string,
          Hash: uniqueidentifier,
          Hashtags: string,
          Hectares: decimal(18,2),
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Link: string,
          Link: string,
          LinkYoutube: string,
          Locacao: string,
          LocacaoCodigo: string,
          Loja: string,
          LojaCdCep: string,
          LojaCdUf: string,
          LojaDsEndereco: string,
          LojaNmBairro: string,
          LojaNmCidade: string,
          LojaNmEstado: string,
          LojaNrResidencia: string,
          LojaNrTelefone: string,
          LojaStAtivarIntegracaoOlx: bit,
          LojaStAtivarIntegracaoZap: bit,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoConcluida: bit,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          NumeroResidencial: string,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          QuartosSuites: int,
          Regiao: string,
          RegiaoImovel: uniqueidentifier,
          RegistroIncorporacao: string,
          Residencia: string,
          ResidenciaProprietario: string,
          RgProprietario: string,
          Salas: int,
          SeoAuthor: string,
          SeoHashtags: string,
          SeoImagem: string,
          SeoLink: string,
          SeoSubtitulo: string,
          SeoTitulo: string,
          Subtitulo: string,
          Suites: int,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          TipoContratoZap: string,
          TipoImovel: string,
          TipoLocalizacao: string,
          TipoLocalizacaoCodigo: int,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacao: string,
          TipoNegociacaoCodigo: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          VagasGaragem: int,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorAluguelMoeda: string,
          ValorCondominio: decimal(18,2),
          ValorCondominioMoeda: string,
          ValorIptu: decimal(18,2),
          ValorIptuMoeda: string,
          ValorMoeda: string,
          VirtualGaleriaFotos: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ConsultarPorUrlAmigavel

post /api/Imovel/ConsultarPorUrlAmigavel?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     UrlAmigavel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AceitaFinanciamento: bit,
          AceitaPermuta: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          Arquivado: bit,
          ArquivoAnexo: string,
          ArquivoAnexo2: string,
          AtivarExportacaoHtml: bit,
          AtivarIntegracaoCasaMineira: bit,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoImovelGuide: bit,
          AtivarIntegracaoImovelWeb: bit,
          AtivarIntegracaoMercadoLivre: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoWimoveis: bit,
          AtivarIntegracaoZap: bit,
          AtualizadoGalerias: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          CodigoDwv: string,
          CodigoIntegracaoEnviadoMercadoLivre: text,
          CodigoTipoSubtipoCasaMineira: string,
          CodigoTipoSubtipoImovelWeb: string,
          CodigoTipoSubtipoWimoveis: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Condominio: bit,
          Construcao: bit,
          Corretor: uniqueidentifier,
          CpfProprietario: string,
          DataExportacaoHtml: smalldatetime,
          DescricaoCasaMineira: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoImovelGuide: string,
          DescricaoImovelWeb: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          DescricaoWimoveis: string,
          Destaque: bit,
          DestaqueCasaMineira: bit,
          DestaqueChavesNaMao: bit,
          DestaqueImovelGuide: bit,
          DestaqueImovelWeb: bit,
          DestaqueWimoveis: bit,
          Detalhe: text,
          DetalheZap: string,
          Disponivel: bit,
          EmailProprietario: string,
          EmailProprietario2: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          EstudaPermuta: bit,
          ExibirSite: bit,
          Hashtags: string,
          HashtagsReferenciaInterna: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          InicioEmpreendimento: smalldatetime,
          InstagramProprietario: string,
          IntegradoMercadoLivre: bit,
          LinkMercadoLivre: string,
          LinkYoutube: string,
          MensagemDwv: string,
          MensagemGaleriaDwv: string,
          MercadoLivre: string,
          MercadoLivreBairro: string,
          MercadoLivreBuyingMode: string,
          MercadoLivreCategory: string,
          MercadoLivreCidade: string,
          MercadoLivreEstado: string,
          MercadoLivreListingType: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          Notificavel: bit,
          Novo: bit,
          ObservacoesAdicionais: text,
          OperacaoCasaMineira: string,
          OperacaoImovelWeb: string,
          OperacaoWimoveis: string,
          OrdenacaoGaleriaFotos: string,
          OrdenacaoGaleriaImagensPlantas: string,
          PeriodicidadeLocacao: string,
          Planta: bit,
          PontoReferencia: string,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          Proprietario2: string,
          QuantidadeAndares: int,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeElevadores: int,
          QuantidadePessoasTemporada: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          RegistroIncorporacao: string,
          Residencia: string,
          ResidenciaProprietario: string,
          RetornoMercadoLivre: text,
          RgProprietario: string,
          Subtipo: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          TelefoneProprietario2: string,
          TerminoEmpreendimento: smalldatetime,
          Timestamp: timestamp,
          TipoContratoZap: string,
          TipoImovel: int,
          TipoLocalizacaoImovel: int,
          TipoNegociacao: int,
          TipoPublicacaoCasaMineira: string,
          TipoPublicacaoImovelWeb: string,
          TipoPublicacaoWimoveis: string,
          Titulo: string,
          Unidade: string,
          UpdateDwv: smalldatetime,
          UpdateGaleriaDwv: smalldatetime,
          UrlAmigavel: string,
          UrlImagemExterna: string,
          UrlProprietario: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          ValorTemporada: decimal(18,2),
          VirtualCategoriaImovel: text,
          VirtualEspacoImovel: text,
          VirtualGaleriaFotos: string,
          VirtualGaleriaImagensPlantas: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
          VirtualImovelRelacionado: text,
          VirtualProprietarioImovel: string,
          VirtualTipoImovel: text,
          VirtualTipoNegociacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Excluir

post /api/Imovel/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ImoveisArquivadosListarRelatorioPrincipal

post /api/Imovel/ImoveisArquivadosListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ImoveisTodosListarRelatorioPrincipal

post /api/Imovel/ImoveisTodosListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ImportarFotos

post /api/Imovel/ImportarFotos?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ImportarFotos não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Empresa: uniqueidentifier,
          Imovel: uniqueidentifier,
          Principal: bit,
          UrlImagem: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | IntegracoesImoveisListarRelatorioPrincipal

post /api/Imovel/IntegracoesImoveisListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _RfTipoPublicacaoWimoveisValor: string,
          AtivarIntegracaoCasaMineira: string,
          AtivarIntegracaoCasaMineiraValor: bit,
          AtivarIntegracaoChavesNaMao: string,
          AtivarIntegracaoChavesNaMaoValor: bit,
          AtivarIntegracaoImovelWeb: string,
          AtivarIntegracaoImovelWebValor: bit,
          AtivarIntegracaoMercadoLivre: string,
          AtivarIntegracaoMercadoLivreValor: bit,
          AtivarIntegracaoOlx: string,
          AtivarIntegracaoOlxValor: bit,
          AtivarIntegracaoWimoveis: string,
          AtivarIntegracaoWimoveisValor: bit,
          AtivarIntegracaoZap: string,
          AtivarIntegracaoZapValor: bit,
          AutonumeracaoEmpresa: int,
          Cidade: string,
          CidadeEstado: string,
          Codigo: string,
          CodigoTipoSubtipoCasaMineira: string,
          CodigoTipoSubtipoCasaMineiraValor: string,
          CodigoTipoSubtipoImovelWeb: string,
          CodigoTipoSubtipoImovelWebValor: string,
          CodigoTipoSubtipoWimoveis: string,
          CodigoTipoSubtipoWimoveisValor: string,
          DestaqueChavesNaMao: string,
          DestaqueChavesNaMaoValor: bit,
          EstadoFederal: string,
          Imagem: string,
          Imovel: uniqueidentifier,
          IntegradoMercadoLivre: string,
          IntegradoMercadoLivreValor: bit,
          LinkYoutube: string,
          MercadoLivre: string,
          MercadoLivreBuyingMode: string,
          MercadoLivreBuyingModeValor: string,
          MercadoLivreListingType: string,
          MercadoLivreListingTypeValor: string,
          OperacaoCasaMineira: string,
          OperacaoCasaMineiraValor: string,
          OperacaoImovelWeb: string,
          OperacaoImovelWebValor: string,
          OperacaoWimoveis: string,
          OperacaoWimoveisValor: string,
          TipoContratoZap: string,
          TipoContratoZapValor: string,
          TipoLocalizacaoImovel: string,
          TipoLocalizacaoImovelValor: int,
          TipoPublicacaoCasaMineira: string,
          TipoPublicacaoCasaMineiraValor: string,
          TipoPublicacaoImovelWeb: string,
          TipoPublicacaoImovelWebValor: string,
          TipoPublicacaoWimoveis: string,
          Titulo: string,
          Unidade: string,
          Valor: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarCasamineira

post /api/Imovel/ListarCasamineira?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          AutonumeracaoEmpresa: int,
          AutonumeracaoEmpresa: int,
          Cep: string,
          Codigo: string,
          CodigoTipoSubtipoCasaMineira: string,
          DescricaoCasaMineira: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          IdadeImovel: string,
          Imagem: string,
          Imagem2: string,
          Imobiliaria: int,
          Imovel: uniqueidentifier,
          Localidade: string,
          MetragemAreaTotal: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MostrarMapa: string,
          OperacaoCasaMineira: string,
          PossuiSuite: bit,
          Quantidade: string,
          QuantidadeBanheiros: int,
          QuantidadeQuartos: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          TipoImovel: string,
          TipoPublicacao: string,
          Titulo: string,
          Url: string,
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          Youtube: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarChavesnamao

post /api/Imovel/ListarChavesnamao?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cep: string,
          Cidade: string,
          Codigo: string,
          ComodidadesCondominio: string,
          ComodidadesLocalizacao: string,
          DescricaoChavesNaMao: string,
          DestaqueChavesNaMao: string,
          Detalhe: text,
          Empresa: uniqueidentifier,
          Endereco: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Link: string,
          LinkYoutube: string,
          Metragem: string,
          MetragemAreaTotal: decimal(18,2),
          Novo: bit,
          QuantidadeBanheiros: int,
          QuantidadeQuartos: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Residencia: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarComodidadesCondominio

post /api/Imovel/ListarComodidadesCondominio?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Autonumeracao: int,
          ComodidadeCondominio: uniqueidentifier,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Imovel: uniqueidentifier,
          ImovelComodidadeCondominio: uniqueidentifier,
          ImovelTitulo: string,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarComodidadesLocalizacao

post /api/Imovel/ListarComodidadesLocalizacao?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Autonumeracao: int,
          ComodidadeLocalizacao: uniqueidentifier,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Imovel: uniqueidentifier,
          ImovelComodidadeLocalizacao: uniqueidentifier,
          ImovelTitulo: string,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarEmpresasDwv

post /api/Imovel/ListarEmpresasDwv?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ListarEmpresasDwv não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          ArquivarImovelVendidoDwv: int,
          Empresa: uniqueidentifier,
          ImportarImagensDwv: bit,
          TipoImagemImportacao: string,
          TokenDwv: string,
          Url: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarGaleriaFotos

post /api/Imovel/ListarGaleriaFotos?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarGaleriaPlantas

post /api/Imovel/ListarGaleriaPlantas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarImovelguide

post /api/Imovel/ListarImovelguide?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          AceitaPermuta: string,
          Ano: int,
          Bairro: string,
          Cep: string,
          Cidade: string,
          Codigo: string,
          ComodidadesCondominio: string,
          ComodidadesLocalizacao: string,
          Complemento: string,
          Construcao: bit,
          DescricaoImovelGuide: string,
          DestaqueImovelGuide: string,
          Detalhe: text,
          Empresa: uniqueidentifier,
          Endereco: string,
          Estado: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Metragem: string,
          MetragemAreaTotal: decimal(18,2),
          Novo: bit,
          OrdenacaoGaleriaFotos: string,
          QuantidadeBanheiros: int,
          QuantidadeQuartos: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Residencia: string,
          Titulo: string,
          Url: string,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarImovelweb

post /api/Imovel/ListarImovelweb?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          AutonumeracaoEmpresa: int,
          AutonumeracaoEmpresa: int,
          Cep: string,
          Codigo: string,
          CodigoTipoSubtipoImovelWeb: string,
          DescricaoImovelWeb: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          IdadeImovel: string,
          Imagem: string,
          Imagem2: string,
          Imobiliaria: int,
          Imovel: uniqueidentifier,
          Localidade: string,
          MetragemAreaTotal: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MostrarMapa: string,
          OperacaoImovelWeb: string,
          PossuiSuite: bit,
          Quantidade: string,
          QuantidadeAluguel: string,
          QuantidadeBanheiros: int,
          QuantidadeQuartos: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          TipoImovel: string,
          TipoPublicacao: string,
          Titulo: string,
          Url: string,
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          Youtube: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarMercadolivre

post /api/Imovel/ListarMercadolivre?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ListarMercadolivre não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AplicacaoMercadoLivre: string,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cidade: string,
          CodeValidoMercadoLivre: string,
          Codigo: string,
          Empresa: uniqueidentifier,
          Estado: string,
          Imovel: uniqueidentifier,
          MercadoLivre: string,
          MercadoLivreBairro: string,
          MercadoLivreCidade: string,
          MercadoLivreEstado: string,
          MercadoLivreListingType: string,
          SecretoMercadoLivre: string,
          Titulo: string,
          TokenMercadoLivre: string,
          Url: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarOlx

post /api/Imovel/ListarOlx?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          Ano: int,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Banheiros: int,
          Categoria: string,
          Categorias: string,
          CategoriasUrlAmigavel: string,
          Cep: string,
          Cidade: string,
          Codigo: string,
          CodigoInterno: string,
          ComodidadesCondominio: string,
          ComodidadesLocalizacao: string,
          Construcao: bit,
          DescricaoOlx: string,
          Destaque: bit,
          Detalhe: text,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Entrega: smalldatetime,
          Estado: string,
          Imagem: string,
          ImagemSite: string,
          Imovel: uniqueidentifier,
          Link: string,
          Link: string,
          Link: string,
          LinkYoutube: string,
          Locacao: string,
          LocacaoCodigo: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          Salas: int,
          Subtitulo: string,
          Suites: int,
          TipoImovel: string,
          TipoImovelCodigo: string,
          TipoImovelDescricao: string,
          TipoNegociacao: string,
          TipoNegociacaoCodigo: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          VagasGaragem: int,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorGeral: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarRelacionados

post /api/Imovel/ListarRelacionados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Autonumeracao: int,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Imagem: string,
          Imovel: uniqueidentifier,
          ImovelItem: uniqueidentifier,
          Titulo: string,
          UrlAmigavel: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarRelatorioPrincipal

post /api/Imovel/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivado: string,
          ArquivadoValor: bit,
          AtivarIntegracaoCasaMineira: string,
          AtivarIntegracaoCasaMineiraValor: bit,
          AtivarIntegracaoChavesNaMao: string,
          AtivarIntegracaoChavesNaMao: string,
          AtivarIntegracaoChavesNaMaoValor: bit,
          AtivarIntegracaoChavesNaMaoValor: bit,
          AtivarIntegracaoImovelGuide: string,
          AtivarIntegracaoImovelGuide: string,
          AtivarIntegracaoImovelGuideValor: bit,
          AtivarIntegracaoImovelGuideValor: bit,
          AtivarIntegracaoImovelWeb: string,
          AtivarIntegracaoImovelWebValor: bit,
          AtivarIntegracaoMercadoLivre: string,
          AtivarIntegracaoMercadoLivreValor: bit,
          AtivarIntegracaoWimoveis: string,
          AtivarIntegracaoWimoveisValor: bit,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cidade: string,
          CidadeEstado: string,
          Codigo: string,
          CodigoTipoSubtipoCasaMineira: string,
          CodigoTipoSubtipoCasaMineiraValor: string,
          CodigoTipoSubtipoImovelWeb: string,
          CodigoTipoSubtipoImovelWebValor: string,
          CodigoTipoSubtipoWimoveis: string,
          CodigoTipoSubtipoWimoveisValor: string,
          Construcao: string,
          ConstrucaoValor: bit,
          Corretor: string,
          CorretorAbreviacaoTecnica: string,
          CorretorCampoImagem: string,
          CorretorImagem: string,
          CorretorSubDescricao: string,
          CorretorUrl: string,
          CorretorValor: uniqueidentifier,
          Destaque: string,
          DestaqueImovelGuide: string,
          DestaqueImovelGuideValor: bit,
          DestaqueValor: bit,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Entrega: smalldatetime,
          Estado: string,
          EstadoFederal: string,
          ExibirSite: string,
          ExibirSiteValor: bit,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          IntegradoMercadoLivre: string,
          IntegradoMercadoLivreValor: bit,
          MercadoLivre: string,
          MercadoLivreBuyingMode: string,
          MercadoLivreBuyingModeValor: string,
          MercadoLivreListingType: string,
          MercadoLivreListingTypeValor: string,
          Mobiliado: string,
          MobiliadoValor: bit,
          Novo: string,
          NovoValor: bit,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacaoValor: string,
          Planta: string,
          PlantaValor: bit,
          Proprietario: string,
          TipoImovel: string,
          TipoLocalizacaoImovel: string,
          TipoLocalizacaoImovelValor: int,
          Titulo: string,
          Uf: string,
          Unidade: string,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          VirtualTipoNegociacao: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarWimoveis

post /api/Imovel/ListarWimoveis?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          AutonumeracaoEmpresa: int,
          AutonumeracaoEmpresa: int,
          Cep: string,
          Codigo: string,
          CodigoTipoSubtipoWimoveis: string,
          DescricaoWimoveis: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          IdadeImovel: string,
          Imagem: string,
          Imagem2: string,
          Imobiliaria: int,
          Imovel: uniqueidentifier,
          Localidade: string,
          MetragemAreaTotal: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MostrarMapa: string,
          OperacaoWimoveis: string,
          PossuiSuite: bit,
          Quantidade: string,
          QuantidadeBanheiros: int,
          QuantidadeQuartos: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          TipoImovel: string,
          TipoPublicacao: string,
          Titulo: string,
          Url: string,
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          Youtube: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarZap

post /api/Imovel/ListarZap?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          _RfTipoContratoZap: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          ArquivoLogotipo: string,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoZap: bit,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Cadastro: datetime,
          Categoria: string,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          ComodidadesCondominio: string,
          ComodidadesLocalizacao: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Concluido_int: int,
          Concluido_str: string,
          Corretor: uniqueidentifier,
          Corretor.CdCreci: string,
          Corretor.DsDescricao: string,
          Corretor.DsEmail: string,
          Corretor.DsFacebook: string,
          Corretor.DsInstagram: string,
          Corretor.DsLinkWhatsapp: string,
          Corretor.DsTitulo: string,
          Corretor.DsTwitter: string,
          Corretor.DsYoutube: string,
          Corretor.Link: string,
          Corretor.NmArquivoFoto: string,
          Corretor.NrTelefone: string,
          Corretor.NrTelefoneWhatsapp: string,
          CpfProprietario: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          Destaque: bit,
          Detalhe: text,
          DetalheZap: string,
          Email: string,
          EmailProprietario: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          ExibirSite: bit,
          Hashtags: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Link: string,
          LinkYoutube: string,
          Loja: string,
          LojaCdCep: string,
          LojaCdUf: string,
          LojaDsEndereco: string,
          LojaNmBairro: string,
          LojaNmCidade: string,
          LojaNmEstado: string,
          LojaNrResidencia: string,
          LojaNrTelefone: string,
          LojaStAtivarIntegracaoOlx: bit,
          LojaStAtivarIntegracaoZap: bit,
          Metragem: string,
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Novo: bit,
          OrdenacaoGaleriaFotos: string,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          Residencia: string,
          ResidenciaProprietario: string,
          RgProprietario: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          TipoContratoZap: string,
          TipoImovel: string,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          VirtualGaleriaFotos: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | QuantificarCategorias

post /api/Imovel/QuantificarCategorias?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          CategoriaImovel: uniqueidentifier,
          Qtd: int,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | TiposImovelExtenso

post /api/Imovel/TiposImovelExtenso?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     IdImovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Categorias: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Bairros

post /api/Imovel/Bairros?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Cidade: varchar,
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Cidades

post /api/Imovel/Cidades?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Uf: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Estado: string,
          Titulo: string,
          Uf: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Estados

post /api/Imovel/Estados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Titulo: string,
          Uf: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | GaleriaFotos

post /api/Imovel/GaleriaFotos?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
          Link: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | GaleriaFotosPorUrl

post /api/Imovel/GaleriaFotosPorUrl?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
          Link: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | GaleriaPlantas

post /api/Imovel/GaleriaPlantas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
          Link: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | GaleriaPlantasPorUrl

post /api/Imovel/GaleriaPlantasPorUrl?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Arquivo: string,
          Imagem: string,
          Link: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | ListarImoveis

post /api/Imovel/ListarImoveis?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          Ano: int,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Banheiros: int,
          Categoria: string,
          Categorias: string,
          CategoriasUrlAmigavel: string,
          Cidade: string,
          Codigo: string,
          CodigoInterno: string,
          Construcao: bit,
          Destaque: bit,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Entrega: smalldatetime,
          Estado: string,
          Imagem: string,
          ImagemSite: string,
          Imovel: uniqueidentifier,
          Link: string,
          Link: string,
          Link: string,
          Locacao: string,
          LocacaoCodigo: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          Salas: int,
          Subtitulo: string,
          Suites: int,
          TipoImovel: string,
          TipoImovelCodigo: string,
          TipoImovelDescricao: string,
          TipoNegociacao: string,
          TipoNegociacaoCodigo: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          UrlAmigavel: string,
          VagasGaragem: int,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorGeral: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Pesquisar

post /api/Imovel/Pesquisar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Bairro: varchar,
     Categoria: varchar,
     Cidade: varchar,
     Codigo: varchar,
     CodigoInterno: varchar,
     ComodidadeCondominio: varchar,
     ComodidadeLocalizacao: varchar,
     Construcao: varchar,
     Empreendimento: varchar,
     Hashtag: varchar,
     IdEmpresa: varchar,
     MetragemAlqueiresMax: int,
     MetragemAlqueiresMin: int,
     MetragemConstruidaMax: int,
     MetragemConstruidaMin: int,
     MetragemHectaresMax: int,
     MetragemHectaresMin: int,
     MetragemMax: int,
     MetragemMin: int,
     MetragemTerrenoMax: int,
     MetragemTerrenoMin: int,
     Mobiliado: varchar,
     NalorAluguelMin: decimal,
     Novo: varchar,
     Planta: varchar,
     QuantidadeBanheirosMax: int,
     QuantidadeBanheirosMin: int,
     QuantidadeCozinhasMax: int,
     QuantidadeCozinhasMin: int,
     QuantidadeQuartosMax: int,
     QuantidadeQuartosMin: int,
     QuantidadeSalasMax: int,
     QuantidadeSalasMin: int,
     QuantidadeSuitesMax: int,
     QuantidadeSuitesMin: int,
     QuantidadeVagasMax: int,
     QuantidadeVagasMin: int,
     Regiao: varchar,
     Setor: varchar,
     Termo: varchar,
     TipoImovel: varchar,
     TipoLocalizacaoImovel: varchar,
     TipoNegociacao: varchar,
     Titulo: varchar,
     UrlAmigavel: varchar,
     ValorAluguelMax: decimal,
     ValorMax: decimal,
     ValorMin: decimal,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          _RfTipoContratoZap: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          ArquivoAnexo: string,
          ArquivoLogotipo: string,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoZap: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Banheiros: int,
          Cadastro: datetime,
          Categoria: string,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          CodigoInterno: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Concluido_int: int,
          Concluido_str: string,
          Construcao: bit,
          Corretor: uniqueidentifier,
          Corretor.CdCreci: string,
          Corretor.DsDescricao: string,
          Corretor.DsEmail: string,
          Corretor.DsFacebook: string,
          Corretor.DsInstagram: string,
          Corretor.DsLinkWhatsapp: string,
          Corretor.DsTitulo: string,
          Corretor.DsTwitter: string,
          Corretor.DsYoutube: string,
          Corretor.Link: string,
          Corretor.NmArquivoFoto: string,
          Corretor.NrTelefone: string,
          Corretor.NrTelefoneWhatsapp: string,
          CpfProprietario: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          Destaque: bit,
          Detalhe: text,
          DetalheZap: string,
          Email: string,
          EmailProprietario: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          ExibirSite: bit,
          Hashtags: string,
          Imagem: string,
          Imagem2: string,
          ImagemPrincipal: string,
          ImagemSite: string,
          Imovel: uniqueidentifier,
          Link: string,
          Link: string,
          LinkYoutube: string,
          Locacao: string,
          LocacaoCodigo: string,
          Loja: string,
          LojaCdCep: string,
          LojaCdUf: string,
          LojaDsEndereco: string,
          LojaNmBairro: string,
          LojaNmCidade: string,
          LojaNmEstado: string,
          LojaNrResidencia: string,
          LojaNrTelefone: string,
          LojaStAtivarIntegracaoOlx: bit,
          LojaStAtivarIntegracaoZap: bit,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          ObservacoesAdicionais: text,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          RegiaoImovel: uniqueidentifier,
          RegiaoImovel.Descricao: string,
          RegiaoImovelAutonumeracaoEmpresa: int,
          Residencia: string,
          ResidenciaProprietario: string,
          RgProprietario: string,
          Salas: int,
          Subtitulo: string,
          Suites: int,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          Timestamp: timestamp,
          TipoContratoZap: string,
          TipoImovel: string,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacao: string,
          TipoNegociacaoCodigo: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          VagasGaragem: int,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorBuscaPorAluguel: decimal(18,2),
          ValorBuscaPorCompra: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorGeral: decimal(18,2),
          ValorIptu: decimal(18,2),
          VirtualGaleriaFotos: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | PesquisarOld

post /api/Imovel/PesquisarOld?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Bairro: varchar,
     Categoria: varchar,
     Cidade: varchar,
     Codigo: varchar,
     CodigoInterno: varchar,
     ComodidadeCondominio: varchar,
     ComodidadeLocalizacao: varchar,
     Construcao: varchar,
     Empreendimento: varchar,
     Hashtag: varchar,
     IdEmpresa: varchar,
     MetragemAlqueiresMax: int,
     MetragemAlqueiresMin: int,
     MetragemConstruidaMax: int,
     MetragemConstruidaMin: int,
     MetragemHectaresMax: int,
     MetragemHectaresMin: int,
     MetragemMax: int,
     MetragemMin: int,
     MetragemTerrenoMax: int,
     MetragemTerrenoMin: int,
     Mobiliado: varchar,
     NalorAluguelMin: decimal,
     Novo: varchar,
     Planta: varchar,
     QuantidadeBanheirosMax: int,
     QuantidadeBanheirosMin: int,
     QuantidadeCozinhasMax: int,
     QuantidadeCozinhasMin: int,
     QuantidadeQuartosMax: int,
     QuantidadeQuartosMin: int,
     QuantidadeSalasMax: int,
     QuantidadeSalasMin: int,
     QuantidadeSuitesMax: int,
     QuantidadeSuitesMin: int,
     QuantidadeVagasMax: int,
     QuantidadeVagasMin: int,
     Regiao: varchar,
     Setor: varchar,
     Termo: varchar,
     TipoImovel: varchar,
     TipoLocalizacaoImovel: varchar,
     TipoNegociacao: varchar,
     Titulo: varchar,
     UrlAmigavel: varchar,
     ValorAluguelMax: decimal,
     ValorMax: decimal,
     ValorMin: decimal,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoNegociacaoDescricao: string,
          _RfTipoContratoZap: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          ArquivoAnexo: string,
          ArquivoLogotipo: string,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoZap: bit,
          Autonumeracao: bigint,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Cadastro: datetime,
          Categoria: string,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Concluido_int: int,
          Concluido_str: string,
          Construcao: bit,
          Corretor: uniqueidentifier,
          Corretor.CdCreci: string,
          Corretor.DsDescricao: string,
          Corretor.DsEmail: string,
          Corretor.DsFacebook: string,
          Corretor.DsInstagram: string,
          Corretor.DsLinkWhatsapp: string,
          Corretor.DsTitulo: string,
          Corretor.DsTwitter: string,
          Corretor.DsYoutube: string,
          Corretor.Link: string,
          Corretor.NmArquivoFoto: string,
          Corretor.NrTelefone: string,
          Corretor.NrTelefoneWhatsapp: string,
          CpfProprietario: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          Destaque: bit,
          Detalhe: text,
          DetalheZap: string,
          Email: string,
          EmailProprietario: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          ExibirSite: bit,
          Hashtags: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Link: string,
          LinkYoutube: string,
          Loja: string,
          LojaCdCep: string,
          LojaCdUf: string,
          LojaDsEndereco: string,
          LojaNmBairro: string,
          LojaNmCidade: string,
          LojaNmEstado: string,
          LojaNrResidencia: string,
          LojaNrTelefone: string,
          LojaStAtivarIntegracaoOlx: bit,
          LojaStAtivarIntegracaoZap: bit,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          numero: int,
          ObservacoesAdicionais: text,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          RegiaoImovel.Descricao: string,
          Residencia: string,
          ResidenciaProprietario: string,
          RgProprietario: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          Timestamp: timestamp,
          TipoContratoZap: string,
          TipoImovel: string,
          TipoImovel: string,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorBuscaPorAluguel: decimal(18,2),
          ValorBuscaPorCompra: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorGeral: decimal(18,2),
          ValorIptu: decimal(18,2),
          VirtualGaleriaFotos: text,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Pesquisar2

post /api/Imovel/Pesquisar2?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Bairro: varchar,
     Categoria: varchar,
     Cidade: varchar,
     Codigo: varchar,
     CodigoInterno: varchar,
     ComodidadeCondominio: varchar,
     ComodidadeLocalizacao: varchar,
     Construcao: varchar,
     Empreendimento: varchar,
     Hashtag: varchar,
     IdEmpresa: varchar,
     MetragemAlqueiresMax: int,
     MetragemAlqueiresMin: int,
     MetragemConstruidaMax: int,
     MetragemConstruidaMin: int,
     MetragemHectaresMax: int,
     MetragemHectaresMin: int,
     MetragemMax: int,
     MetragemMin: int,
     MetragemTerrenoMax: int,
     MetragemTerrenoMin: int,
     Mobiliado: varchar,
     NalorAluguelMin: decimal,
     Novo: varchar,
     Planta: varchar,
     QuantidadeBanheirosMax: int,
     QuantidadeBanheirosMin: int,
     QuantidadeCozinhasMax: int,
     QuantidadeCozinhasMin: int,
     QuantidadeQuartosMax: int,
     QuantidadeQuartosMin: int,
     QuantidadeSalasMax: int,
     QuantidadeSalasMin: int,
     QuantidadeSuitesMax: int,
     QuantidadeSuitesMin: int,
     QuantidadeVagasMax: int,
     QuantidadeVagasMin: int,
     Regiao: varchar,
     Setor: varchar,
     Termo: varchar,
     TipoImovel: varchar,
     TipoLocalizacaoImovel: varchar,
     TipoNegociacao: varchar,
     Titulo: varchar,
     UrlAmigavel: varchar,
     ValorAluguelMax: decimal,
     ValorMax: decimal,
     ValorMin: decimal,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          _RfTipoContratoZap: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Ano: int,
          ArquivoAnexo: string,
          ArquivoLogotipo: string,
          AtivarIntegracaoChavesNaMao: bit,
          AtivarIntegracaoOlx: bit,
          AtivarIntegracaoZap: bit,
          Autonumeracao: bigint,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          BairroProprietario: string,
          Cadastro: datetime,
          Categoria: string,
          Cep: string,
          CepProprietario: string,
          Cidade: string,
          CidadeProprietario: string,
          CnpjProprietario: string,
          Codigo: string,
          Complemento: string,
          ComplementoProprietario: string,
          Concluido: bit,
          Concluido_int: int,
          Concluido_str: string,
          Construcao: bit,
          Corretor: uniqueidentifier,
          Corretor.CdCreci: string,
          Corretor.DsDescricao: string,
          Corretor.DsEmail: string,
          Corretor.DsFacebook: string,
          Corretor.DsInstagram: string,
          Corretor.DsLinkWhatsapp: string,
          Corretor.DsTitulo: string,
          Corretor.DsTwitter: string,
          Corretor.DsYoutube: string,
          Corretor.Link: string,
          Corretor.NmArquivoFoto: string,
          Corretor.NrTelefone: string,
          Corretor.NrTelefoneWhatsapp: string,
          CpfProprietario: string,
          DescricaoChavesNaMao: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          DescricaoOlx: string,
          DescricaoProprietario: string,
          Destaque: bit,
          Detalhe: text,
          DetalheZap: string,
          Email: string,
          EmailProprietario: string,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EnderecoProprietario: string,
          Entrega: smalldatetime,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          EstadoFederalProprietario: uniqueidentifier,
          ExibirSite: bit,
          Hashtags: string,
          Imagem: string,
          Imagem2: string,
          Imovel: uniqueidentifier,
          Link: string,
          LinkYoutube: string,
          Loja: string,
          LojaCdCep: string,
          LojaCdUf: string,
          LojaDsEndereco: string,
          LojaNmBairro: string,
          LojaNmCidade: string,
          LojaNmEstado: string,
          LojaNrResidencia: string,
          LojaNrTelefone: string,
          LojaStAtivarIntegracaoOlx: bit,
          LojaStAtivarIntegracaoZap: bit,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Mobiliado: bit,
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          ObservacoesAdicionais: text,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          Planta: bit,
          PrioridadeExibicao: int,
          Privado: bit,
          Proprietario: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          RegiaoImovel: uniqueidentifier,
          RegiaoImovel.Descricao: string,
          RegiaoImovelAutonumeracaoEmpresa: int,
          Residencia: string,
          ResidenciaProprietario: string,
          RgProprietario: string,
          Subtitulo: string,
          Telefone: string,
          TelefoneCelularProprietario: string,
          TelefoneProprietario: string,
          Timestamp: timestamp,
          TipoContratoZap: string,
          TipoImovel: string,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          Uf: string,
          UltimaModificacao: datetime,
          Url: string,
          UrlAmigavel: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
          VirtualGaleriaFotos: string,
          VirtualImovelComodidadeCondominio: text,
          VirtualImovelComodidadeLocalizacao: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | PorSetor

post /api/Imovel/PorSetor?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Setor: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _CdTipoImovel: string,
          _CdTipoNegociacaoDescricao: string,
          Anexo: string,
          Ano: int,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Banheiros: int,
          Categoria: string,
          Categoria: string,
          Cidade: string,
          Codigo: string,
          CodigoInterno: string,
          DescricaoCodigoGoogleMaps: string,
          DescricaoIncorporadoYoutube: string,
          DescricaoIncorporadoYoutube2: string,
          Destaque: bit,
          Empreendimento: string,
          Empresa: uniqueidentifier,
          EstadoFederal: uniqueidentifier,
          Foto: string,
          Imagem: string,
          Imovel: uniqueidentifier,
          Link: string,
          Locacao: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          NegociacaoAluguel: string,
          NegociacaoCompra: string,
          NegociacaoTroca: string,
          NegociacaoVenda: string,
          Novo: bit,
          PeriodicidadeLocacao: string,
          PeriodicidadeLocacao.Descricao: string,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          TipoImovel: string,
          TipoLocalizacaoImovel: int,
          TipoLocalizacaoImovel.Descricao: string,
          TipoNegociacao: string,
          TipoNegociacaoDescricao: string,
          Titulo: string,
          UrlAmigavel: string,
          VagasGaragem: int,
          Valor: string,
          ValorAluguel: string,
          ValorCondominio: decimal(18,2),
          ValorGeral: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | Relacionados

post /api/Imovel/Relacionados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
     Imovel: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Alteracao: datetime,
          Ano: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Banheiros: int,
          Cadastro: datetime,
          Cep: string,
          Cidade: string,
          Codigo: string,
          CodigoInterno: string,
          Corretor: uniqueidentifier,
          DescricaoIncorporadoYoutube: string,
          Destaque: bit,
          Empresa: uniqueidentifier,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          Imagem: string,
          Imovel: uniqueidentifier,
          Link: string,
          Link: string,
          LinkYoutube: string,
          Metragem: decimal(18,2),
          MetragemAlqueires: decimal(18,2),
          MetragemAreaTotal: decimal(18,2),
          MetragemComum: decimal(18,2),
          MetragemConstruida: decimal(18,2),
          MetragemHectares: decimal(18,2),
          MetragemPrivativa: decimal(18,2),
          MetragemTerreno: decimal(18,2),
          Novo: bit,
          QuantidadeBanheiros: int,
          QuantidadeCozinhas: int,
          QuantidadeQuartos: int,
          QuantidadeSalas: int,
          QuantidadeSuites: int,
          QuantidadeVagasGaragem: int,
          Quartos: int,
          Subtitulo: string,
          Suites: int,
          TipoLocalizacaoImovel: int,
          Titulo: string,
          Uf: string,
          UrlAmigavel: string,
          VagasGaragem: int,
          Valor: decimal(18,2),
          ValorAluguel: decimal(18,2),
          ValorCondominio: decimal(18,2),
          ValorIptu: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Imovel | TiposImoveisEmUso

post /api/Imovel/TiposImoveisEmUso?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Codigo: string,
          Hash: uniqueidentifier,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token