Pesquisar Cidades {API}

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:

Verbo	POST

Verbo	POST
Url	https://login.salesforce.com/services/oauth2/token
Parâmetros	grant_type : urn:ietf:params:oauth:grant-type:jwt-bearer assertion : {chave que será recebida da organização}
Endpoint	https://login.salesforce.com/services/oauth2/token?grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&assertiona=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0YXJnZXIfYXVkaWVuY2UiOm51bGwsInN1YiI6InJpY2FyZG2uZ2lnbGlvQHNuYXBwcm9wZXJ0eS5jb20uYnIiLLJzY29wZSI6bnVsbCwiaXNzIjoiM01WRzlRRHg4SVg4blA1U0l5RGE0WUNLWjViYlFYdk1SRERxSW1ZbUJ1QXFKbXNQU0laVkJOTXV6MTZWMWtlUmo1QUg3enZqby5McnBLTVBZaHMxRiIsImlhdCI6MTYyMDMyBjA2NSwiZXhwIjoxOTM1ODk1MzI1LVJhdWQiOiJodHRwczovL2xvZ2luLnNhbGVzZm3yY2UuY29tIn0=.Kp37sR4YQRynlDtl6oXxHYSHw9VX725elzdqDS-vFknPV7pCujOJwVHoIKZaeGVkahazod8FoRWXQfRXrgH4vV_cucRV15OgkR-RrvZAQyglEbBDJFETLc5biCmKoHOgvlZh7zu2U1ED8yb13Ww7EP8dPfG4nVvDYV1r49n7Rwmj85FjviOh45olm8vM6dUS4wHB20zOs2SoeE7UUSq3974y-RmLntbvBoFQR7AIsvJblfIHOdY7ruuSb9mhzZ2NB7_0TSzrhL4fk3luYmAdqhh7M87l0jFojtPsaM03PIMMWO7SAo56R5ykm_aOr-s8WPlWwZRaLBOOA5xKJdFQHw

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/cidades
Endpoint	https://snapproperty-developer-edition.na132.force.com/services/apexrest/snap_brok/imovel/cidades

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

Campo	Tipo	Descrição	Exemplo
Total	Número	Indica a quantidade total de cidades encontradas com os imóveis disponíveis para locação.	90
Mensagem	String	Mensagem do sistema	"Pesquisa realizada com sucesso"
cidades	List<snap_finan__Cidade__c>	Lista com os registros da cidades retornados pela pesquisa.	[ { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000FibSsQAJ" }, "Id": "a0a0B00000FibSsQAJ", "Name": "Assis" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000MEBUSQA5" }, "Id": "a0a4P00000MEBUSQA5", "Name": "Belém" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000LVISkQAP" }, "Id": "a0a4P00000LVISkQAP", "Name": "Natal" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000Hm5dtQAB" }, "Id": "a0a0B00000Hm5dtQAB", "Name": "Goiânia" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PAojoQAD" }, "Id": "a0a4P00000PAojoQAD", "Name": "Maringá" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PoY2sQAF" }, "Id": "a0a4P00000PoY2sQAF", "Name": "ALEGRETE" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000HxkNuQAJ" }, "Id": "a0a0B00000HxkNuQAJ", "Name": "Guarulhos" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000Hm5cxQAB" }, "Id": "a0a0B00000Hm5cxQAB", "Name": "São Paulo" }, { "attributes": { "type": "snap_finan__Cidade__c", "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PAj5hQAD" }, "Id": "a0a4P00000PAj5hQAD", "Name": "Uberlândia" } ]
Erro	Boolean	FALSE

Exemplo:

{
    "Total": 16,
    "Mensagem": "Pesquisa realizada com sucesso",
    "Erro": false,
    "cidades": [
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000FibSsQAJ"
            },
            "Id": "a0a0B00000FibSsQAJ",
            "Name": "Assis"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000MEBUSQA5"
            },
            "Id": "a0a4P00000MEBUSQA5",
            "Name": "Belém"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000LVISkQAP"
            },
            "Id": "a0a4P00000LVISkQAP",
            "Name": "Natal"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000Hm5dtQAB"
            },
            "Id": "a0a0B00000Hm5dtQAB",
            "Name": "Goiânia"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PAojoQAD"
            },
            "Id": "a0a4P00000PAojoQAD",
            "Name": "Maringá"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PoY2sQAF"
            },
            "Id": "a0a4P00000PoY2sQAF",
            "Name": "ALEGRETE"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000HxkNuQAJ"
            },
            "Id": "a0a0B00000HxkNuQAJ",
            "Name": "Guarulhos"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000Hm5cxQAB"
            },
            "Id": "a0a0B00000Hm5cxQAB",
            "Name": "São Paulo"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PAj5hQAD"
            },
            "Id": "a0a4P00000PAj5hQAD",
            "Name": "Uberlândia"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000PoGsRQAV"
            },
            "Id": "a0a4P00000PoGsRQAV",
            "Name": "SANTA MARIA"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000JdVxnQAF"
            },
            "Id": "a0a0B00000JdVxnQAF",
            "Name": "Rio de Janeiro"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000Pmrp6QAB"
            },
            "Id": "a0a4P00000Pmrp6QAB",
            "Name": "Santa Maria - Ok"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000ME8zFQAT"
            },
            "Id": "a0a4P00000ME8zFQAT",
            "Name": "São José dos Campos"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a0B00000Hm7CQQAZ"
            },
            "Id": "a0a0B00000Hm7CQQAZ",
            "Name": "Aparecida de Goiânia"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000LSb2zQAD"
            },
            "Id": "a0a4P00000LSb2zQAD",
            "Name": "Ferraz de Vasconcelos"
        },
        {
            "attributes": {
                "type": "snap_finan__Cidade__c",
                "url": "/services/data/v52.0/sobjects/snap_finan__Cidade__c/a0a4P00000LWBtPQAX"
            },
            "Id": "a0a4P00000LWBtPQAX",
            "Name": "Porto Alegre [excluir]"
        }
    ]
}

Retorno com erro

Campo	Tipo	Descrição	Exemplo

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 cidades: unexpected token: '100' - linha: 493 na linha 502"
Cidades	List<snap_finan__Cidade__c>		null
Erro	Boolean	TRUE

Exemplo:

{
    "Total": null,
    "Mensagem": "Erro na pesquisa de cidades: Erro na pesquisa de cidades: unexpected token: '100' - linha: 493 na linha 502",
    "Cidades": null,
    "Erro": true
}