RP — Error Codes
BrokerNG nativo (contrato estável, códigos < 1000)
Esses códigos são emitidos pelo BrokerNG e permanecem inalterados por compatibilidade entre projetos.
| Código | HTTP | Descrição |
|---|---|---|
| 1 | 503 | No request for action execution. |
| 2 | 500 | Internal and unknown server error. |
| 3 | 503 | Requested database not configured. |
| 4 | 503 | Failed to setup DB connection/transaction. |
| 5 | 503 | Failed to finalize DB transaction/connection. |
| 6 | 501 | Invalid parameter type in action contract. |
| 7 | 503 | Internal action validation error. |
| 8 | 501 | Action not present in endpoint mapping. |
| 9 | 501 | Validator execution error. |
| 100 | 404 | Endpoint not configured. |
| 101 | 202 | OPTIONS/CORS handling. |
| 102 | 405 | HTTP method not supported for action. |
| 103 | 401 | IP address blocked by network rule. |
| 104 | 401 | Authorization header missing. |
| 105 | 401 | Session/token invalid or expired. |
| 106 | 400 | Input is not valid JSON. |
| 107 | 406 | Input parameter errors. |
| 110 | 401 | Token invalid/inactive. |
| 111 | 406 | Generic method-level validation error. |
| 112 | 404 | Requested resource does not exist. |
| 113 | 403 | Access denied on required ACLs. |
| 114 | 406 | Dry-run option not allowed. |
| 115 | 429 | Too many requests. |
Série global da API 100xxxx (reutilizável entre endpoints)
Esses códigos pertencem à aplicação (não ao BrokerNG) e podem ser usados por múltiplos endpoints.
| Código | HTTP | Descrição |
|---|---|---|
| 1000001 | 406 | Endereço de e-mail inválido. |
Série 101xxxx - Endpoints de Avatar
Endpoints: GET /avatar/get-1.0 · POST /avatar/forget-1.0 · POST /keepalive-1.0
| Código | HTTP | Descrição |
|---|---|---|
| 1010001 | 406 | Parâmetro inválido na requisição de avatar. |
| 1010002 | 500 | Falha no housekeeping de avatars (keepalive). |
| 1010003 | 406 | avatar_id é obrigatório (forget). |
| 1010004 | 404 | Avatar não encontrado (forget). |
Série 102xxxx - Endpoints de Contatos (Fase 1)
Endpoints: POST /contact/search-1.0 · POST /contact/get-1.0 · POST /contact/add-1.0 · POST /contact/update-1.0 · POST /contact/delete-1.0 · sub-recursos (email, phone, address, social, tag, note, history)
| Código | HTTP | Descrição |
|---|---|---|
| 1020001 | 406 | contact_id é obrigatório. |
| 1020002 | 404 | Contato não encontrado. |
| 1020003 | 406 | display_name é obrigatório (add). |
| 1020004 | 406 | scope_type inválido. Permitidos: identity, domain, customer, global. |
| 1020005 | 409 | Já existe um contato com este e-mail neste escopo. |
| 1020006 | 406 | email_id é obrigatório. |
| 1020007 | 404 | E-mail não encontrado ou não pertence a este contato. |
| 1020008 | 406 | phone_id é obrigatório. |
| 1020009 | 404 | Telefone não encontrado ou não pertence a este contato. |
| 1020010 | 406 | address_id é obrigatório. |
| 1020011 | 404 | Endereço não encontrado ou não pertence a este contato. |
| 1020012 | 406 | social_id é obrigatório. |
| 1020013 | 404 | Perfil social não encontrado ou não pertence a este contato. |
| 1020014 | 406 | email_address é obrigatório. |
| 1020015 | 406 | phone_e164 é obrigatório. |
| 1020016 | 403 | Permissão negada para o escopo deste contato. |
| 1020017 | 409 | Não é possível remover o único e-mail primário do contato. |
| 1020018 | 406 | source_email ou escopo explícito são necessários para listar contatos. |
| 1020019 | 406 | Valor de status do contato inválido. |
| 1020020 | 406 | address_line1, address_city e address_country são obrigatórios. |
| 1020021 | 406 | social_network e social_handle são obrigatórios. |
| 1020022 | 406 | O texto da nota é obrigatório e não pode ser vazio. |
| 1020023 | 503 | Conexão com o módulo de Comments não está disponível. |
Status HTTP por endpoint (análise efetiva do código)
| Endpoint | Status possíveis | Observações |
|---|---|---|
GET /avatar/get-1.0 |
200, 400, 401, 403, 405, 406, 429, 500, 501, 503 | BrokerNG nativo · global 1000001 · local 1010001 |
POST /avatar/forget-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | BrokerNG nativo · local 1010003, 1010004 · requer permissão rp.avatar.delete |
POST /keepalive-1.0 |
200, 400, 401, 403, 405, 429, 500, 501, 503 | BrokerNG nativo · local 1010002 |
POST /contact/search-1.0 |
200, 400, 401, 403, 405, 429, 500, 501, 503 | Requer rp.contact.read.identity · série 102xxxx |
GET /contact/get-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.read.identity · 1020001, 1020002, 1020016 |
POST /contact/add-1.0 |
200, 400, 401, 403, 405, 406, 409, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020003–1020005 |
POST /contact/update-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020002, 1020016, 1020019 |
POST /contact/delete-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.delete.identity · rp.contact.purge para hard delete |
POST /contact/email/add-1.0 |
200, 400, 401, 403, 404, 405, 406, 409, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020005, 1020014, 1020016 |
POST /contact/email/remove-1.0 |
200, 400, 401, 403, 404, 405, 406, 409, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020006, 1020007, 1020017 |
POST /contact/phone/add-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020015, 1020016 |
POST /contact/phone/remove-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020008, 1020009 |
POST /contact/address/add-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020016, 1020020 |
POST /contact/address/remove-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020010, 1020011 |
POST /contact/social/add-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020016, 1020021 |
POST /contact/social/remove-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020012, 1020013 |
POST /contact/tag/set-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.write.identity · 1020001, 1020016 |
POST /contact/note/add-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.note.write.identity · 1020001, 1020022, 1020023 |
GET /contact/history-1.0 |
200, 400, 401, 403, 404, 405, 406, 429, 500, 501, 503 | Requer rp.contact.audit.read.identity · 1020001, 1020016, 1020023 |