Page Comparison

Segurança

Para acessar o serviço de pesquisa, a aplicação deve enviar um acess_token, junto ao requisição. Esse acess_token deverá ser obetido da seguinte maneira:

...

Uma vez obtido o acess_token após essa requisição no header da requisição de pesquisa deve ser enviado o Autorization : Bearer + {espaço} + acess_token

Endpoint

Para acessar o serviço de pesquisa o sistema deve fazer uma requisição do tipo "GET” no “EndPoint” definido pela “URL Org” da organização

Verbo	GET
Url org	Endereço fornecido pelo administrador. Exemplo: https://snapproperty-developer-edition.na132.force.com
Serviço	/services/apexrest/snap_brok/imovel/bairros
Endpoint	https://snapproperty-developer-edition.na132.force.com/services/apexrest/snap_brok/imovel/bairros/{id}

Retorno da pesquisa

Retorno com sucesso

Na tabela abaixo estão descritos os campos retornados pelo serviço quando a pesquisa é realizada com sucesso.

Campo	Tipo	Descrição	Exemplo
Total	Número	Indica a quantidade total de bairros encontrados com os imóveis disponíveis para locação.	90
Mensagem	String	Mensagem do sistema	"Pesquisa realizada com sucesso"
Bairrosbairros	List<snap_finan__Bairrobairros__c>	Lista com os registros da bairros retornados pela pesquisa.	[ { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NRxXPUA1" }, "Id": "a0Q0B00000NRxXPUA1", "Name": "Sacomã" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000WESopUAH" }, "Id": "a0Q4P00000WESopUAH", "Name": "Pinheiros" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj10UAB" }, "Id": "a0Q0B00000Ivj10UAB", "Name": "Bela Vista" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0xUAB" }, "Id": "a0Q0B00000Ivj0xUAB", "Name": "Consolação" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0vUAB" }, "Id": "a0Q0B00000Ivj0vUAB", "Name": "Itaim Bibi" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0lUAB" }, "Id": "a0Q0B00000Ivj0lUAB", "Name": "Vila Sinhá" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UCfHCUA1" }, "Id": "a0Q4P00000UCfHCUA1", "Name": "Barra Funda" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000SJTFDUA5" }, "Id": "a0Q4P00000SJTFDUA5", "Name": "Vila Aimoré" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0fUAB" }, "Id": "a0Q0B00000Ivj0fUAB", "Name": "Jardim Europa" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Kg3mzUAB" }, "Id": "a0Q0B00000Kg3mzUAB", "Name": "Quarta Parada" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0kUAB" }, "Id": "a0Q0B00000Ivj0kUAB", "Name": "Vila Madalena" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0dUAB" }, "Id": "a0Q0B00000Ivj0dUAB", "Name": "Jardim América" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000KfYCdUAN" }, "Id": "a0Q0B00000KfYCdUAN", "Name": "Jardim Andaraí" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NS113UAD" }, "Id": "a0Q0B00000NS113UAD", "Name": "Vila Guilherme" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000KfXWWUA3" }, "Id": "a0Q0B00000KfXWWUA3", "Name": "Cerqueira César" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0wUAB" }, "Id": "a0Q0B00000Ivj0wUAB", "Name": "Jardim Paulista" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UD5C1UAL" }, "Id": "a0Q4P00000UD5C1UAL", "Name": "Chácara São João" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NRtd8UAD" }, "Id": "a0Q0B00000NRtd8UAD", "Name": "Jardim Ampliação" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0eUAB" }, "Id": "a0Q0B00000Ivj0eUAB", "Name": "Jardim Paulistano" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UrHXdUAN" }, "Id": "a0Q4P00000UrHXdUAN", "Name": "Vila Princesa Isabel" }, { "attributes": { "type": "snap_finan__Bairro__c", "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UDH5TUAX" }, "Id": "a0Q4P00000UDH5TUAX", "Name": "Jardim Santa Terezinha (Zona Leste)" } ]
Erro	Boolean	FALSE

...

Code Block

{
    "Total": 21,
    "Mensagem": "Pesquisa realizada com sucesso",
    "Erro": false,
    "bairros": [
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NRxXPUA1"
            },
            "Id": "a0Q0B00000NRxXPUA1",
            "Name": "Sacomã"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000WESopUAH"
            },
            "Id": "a0Q4P00000WESopUAH",
            "Name": "Pinheiros"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj10UAB"
            },
            "Id": "a0Q0B00000Ivj10UAB",
            "Name": "Bela Vista"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0xUAB"
            },
            "Id": "a0Q0B00000Ivj0xUAB",
            "Name": "Consolação"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0vUAB"
            },
            "Id": "a0Q0B00000Ivj0vUAB",
            "Name": "Itaim Bibi"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0lUAB"
            },
            "Id": "a0Q0B00000Ivj0lUAB",
            "Name": "Vila Sinhá"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UCfHCUA1"
            },
            "Id": "a0Q4P00000UCfHCUA1",
            "Name": "Barra Funda"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000SJTFDUA5"
            },
            "Id": "a0Q4P00000SJTFDUA5",
            "Name": "Vila Aimoré"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0fUAB"
            },
            "Id": "a0Q0B00000Ivj0fUAB",
            "Name": "Jardim Europa"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Kg3mzUAB"
            },
            "Id": "a0Q0B00000Kg3mzUAB",
            "Name": "Quarta Parada"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0kUAB"
            },
            "Id": "a0Q0B00000Ivj0kUAB",
            "Name": "Vila Madalena"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0dUAB"
            },
            "Id": "a0Q0B00000Ivj0dUAB",
            "Name": "Jardim América"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000KfYCdUAN"
            },
            "Id": "a0Q0B00000KfYCdUAN",
            "Name": "Jardim Andaraí"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NS113UAD"
            },
            "Id": "a0Q0B00000NS113UAD",
            "Name": "Vila Guilherme"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000KfXWWUA3"
            },
            "Id": "a0Q0B00000KfXWWUA3",
            "Name": "Cerqueira César"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0wUAB"
            },
            "Id": "a0Q0B00000Ivj0wUAB",
            "Name": "Jardim Paulista"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UD5C1UAL"
            },
            "Id": "a0Q4P00000UD5C1UAL",
            "Name": "Chácara São João"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000NRtd8UAD"
            },
            "Id": "a0Q0B00000NRtd8UAD",
            "Name": "Jardim Ampliação"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q0B00000Ivj0eUAB"
            },
            "Id": "a0Q0B00000Ivj0eUAB",
            "Name": "Jardim Paulistano"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UrHXdUAN"
            },
            "Id": "a0Q4P00000UrHXdUAN",
            "Name": "Vila Princesa Isabel"
        },
        {
            "attributes": {
                "type": "snap_finan__Bairro__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Bairro__c/a0Q4P00000UDH5TUAX"
            },
            "Id": "a0Q4P00000UDH5TUAX",
            "Name": "Jardim Santa Terezinha (Zona Leste)"
        }
    ]
}

Retorno com erro

Campo	Tipo	Descrição	Exemplo
Total	Número		null
Mensagem	String	Mensagem de erro gerada pelo serviço	"Erro na pesquisa de cidades: Erro na pesquisa de bairros: unexpected token: '100' - linha: 493 na linha 502"
bairros	List<snap_finan__Bairro__c>		null
Erro	Boolean	TRUE

...

Versions Compared

Old Version 1

New Version Current

Key

Segurança

Endpoint

Retorno da pesquisa

Retorno com sucesso

Retorno com erro