GET /api/action/portal-v2/branches

PROD

Lista as filiais que o portal pode exibir. Cada uma traz o seu endereço, os seus telefones, a sua zona e a quantidade de imóveis publicados que possui.

Informação do recurso
Autenticação	Required
Método HTTP	GET
Resposta	JSON
Versão	2

URL do recurso

https://mapaprop.app/api/action/portal-v2/branches

Parâmetros

Chave	Tipo	Obrigatório	Descrição
custId	int	não	Limita a lista às filiais de uma imobiliária
seoUrl	string	não	Limita a lista à filial com esse `seoUrl`
from	int	não	Deslocamento para paginar. O padrão é `0`
size	int	não	Quantidade a devolver. O padrão é `50`

Exemplo de chamada

GET /api/action/portal-v2/branches?custId=1019&size=2 HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}

Resposta

Objeto	Campo	Tipo	Descrição
Response	total	int	Quantidade total de filiais correspondentes
Response	branches	Array	A lista
Branch	branchId	int	Identificador da filial
Branch	name	string	Nome da filial
Branch	seoUrl	string	O seu identificador na URL — o que `branches/{seoUrl}/properties` utiliza
Branch	main	boolean	Se é a matriz
Branch	propertyCount	int	Imóveis publicados dessa filial
Branch	address · zip · location	string	Localização
Branch	phone1 · phone2 · phone3 · mobile · phones · email	string	Contato
Branch	zone0…zone2 e os seus `*Description`	int · string	A zona, por nível
Branch	custId · customerName · customerSeoUrl	int · string	A imobiliária proprietária

Exemplo de resposta

{
    "total": 1,
    "branches": [
        {
            "branchId": 1,
            "name": "Casa Central",
            "seoUrl": "inmobiliaria-ciocale",
            "main": true,
            "propertyCount": 48,
            "customerSeoUrl": "ciocale-inmobiliaria",
            "zone1Description": "Capital Federal"
        }
    ]
}