DELETE /branches/{branchRef}
Apaga uma filial do cliente.
| Informação do recurso | |
|---|---|
| Autenticação | Obrigatória (Token de API, Bearer) |
| Scope | property-api-delete |
| HTTP Method | DELETE |
| Response | JSON |
| Version | 1 |
🔴 Não é apenas retirá-la de uma lista
Se a filial existe na conta Mapaprop do cliente, apagá-la move coisas: as suas propriedades, contactos, placas e utilizadores passam para outra filial. Isso não se desfaz.
| Quantas filiais tem a conta | O que acontece |
|---|---|
| 2 | Tudo passa para a filial principal. Não há nada a escolher |
| 3 ou mais | Escolhe você com ?targetBranchRef= — se não o enviar, respondemos 400 em vez de decidir pelo seu cliente |
| 1 | Não se pode apagar: uma conta não pode ficar sem filiais |
Se a filial vive apenas na ficha (o seu cliente não tem conta Mapaprop), retira-se a entrada e não há nada a reatribuir.
A chamada
DELETE https://property-api.mapaprop.com/property-v1/branches/centro
Authorization: Bearer {access_token}
x-client-ref: {a sua referência do cliente}
Com destino, quando a conta tem três ou mais filiais:
DELETE https://property-api.mapaprop.com/property-v1/branches/centro?targetBranchRef=casa-central
| Parâmetro | Tipo | Descrição |
|---|---|---|
branchRef | string (path) | A sua referência da filial que se apaga. O seu branchId numérico da Mapaprop também serve |
targetBranchRef | string (query) | A filial que fica com as propriedades, os contactos e as placas. Obrigatório com 3 ou mais filiais |
A resposta
{
"branchRef": "centro",
"mapapropBranchId": 12122,
"deleted": true,
"deletedInMapaprop": true,
"reassignedTo": 1,
"scope": "mapaprop"
}
| Campo | Tipo | Descrição |
|---|---|---|
deleted | boolean | true — a filial já não está |
deletedInMapaprop | boolean | true se também foi apagada na conta Mapaprop. false = vivia apenas na ficha |
reassignedTo | number | O branchId que recebeu as propriedades, se enviou um destino |
scope | string | mapaprop ou ficha |
Erros
| Código | O que aconteceu | O que fazer |
|---|---|---|
400 | Falta o destino (code: TARGET_BRANCH_REQUIRED) | A conta tem 3 ou mais filiais: envie ?targetBranchRef= |
400 | O destino não serve (code: INVALID_TARGET_BRANCH) | Não pode ser a mesma que se apaga nem a filial de um consultor. Veja GET /branches |
403 | O token não tem o scope property-api-delete | É uma permissão do seu token: escreva-nos |
404 | Esse branchRef não é uma filial do cliente (rule: branch_not_found) | O erro lista as refs que de facto tem |
409 | É a única filial da conta (code: MUST_HAVE_AT_LEAST_ONE_BRANCH) | Crie a outra primeiro e depois apague esta |
409 | É a filial de um consultor (code: CANNOT_DELETE_AGENT_BRANCH) | A sua desativação faz-se a partir do utilizador do consultor, na Mapaprop. Pela API ainda não há forma |
503 | Não conseguimos apagá-la neste momento | É transitório e do nosso lado: tente de novo. Não se apagou nada |
ℹ️ O
409do consultor não se resolve tentando de novo. A filial de um consultor está ligada ao seu utilizador: liberta-se quando esse utilizador é desativado, e isso faz-se na Mapaprop. É uma regra da conta, não um problema da sua chamada.
Relacionado
- Editar uma filial
- GET /branches — as filiais da conta, com o seu
branchId - PUT /customers — declarar as filiais na ficha