Usada como resposta padrão para solicitações cadastrais da Câmara Base.
A mensagem indica se a solicitação foi processada com sucesso ou rejeitada devido a erros de validação, regra de negócio ou falha técnica inesperada.
Essa mensagem é utilizada como resposta para todos os fluxos de cadastro, criação e modificação de entidades cadastrais.
R1: O campo Errors é vazio quando ResponseCode = 200.
R2: O campo Errors possui ao menos um elemento quando ResponseCode != 200.
| Índice | Campo | Tipo | Obrigatório | Descrição | Regras |
|---|---|---|---|---|---|
| 1 | Correlation | object | SIM | Informações de correlação com a mensagem que está sendo respondida | |
| 1.1 | OriginalRequestId | string | SIM | RequestId da solicitação original |
|
| 1.2 | OriginalRequesterParticipantCode | string | SIM | Código do Participante solicitante original | |
| 1.3 | OriginalMessageTypeCode | string | SIM | Tipo da mensagem original no padrão base-m-cad-???-##-### |
|
| 2 | ResponseCode | integer | SIM | Código do resultado da solicitação. Valores possíveis: RegistrationResponseCode | |
| 3 | Errors | array | SIM | Lista de erros encontrados durante o processamento | R1, R2 |
| 3.1 | ErrorCode | string | SIM | Código do erro | |
| 3.2 | ErrorMessage | string | NÃO | Descrição resumida do erro | |
| 3.3 | ElementPath | string | NÃO | Caminho do campo relacionado ao erro, quando aplicável | |
| 3.4 | ElementContent | string | NÃO | Conteúdo recebido no campo relacionado ao erro, quando aplicável |
{
"Correlation": {
"OriginalRequestId": "5508C253259242969AEA8121FA6C2B2B",
"OriginalRequesterParticipantCode": "713",
"OriginalMessageCode": "base-m-cad-acc-01-001"
},
"ResponseCode": 200,
"Errors": []
}
{
"Correlation": {
"OriginalRequestId": "924D0F2105ED4F47B8C3D7CAF3183020",
"OriginalRequesterParticipantCode": "713",
"OriginalMessageCode": "base-m-cad-acc-01-001"
},
"ResponseCode": 400,
"Errors": [
{
"ErrorCode": "CAD0020",
"ErrorMessage": "Invalid CPF",
"ElementPath": "InvestorInformation.NewInvestor.ResidentNaturalPerson.Cpf",
"ElementContent": "Batata"
},
{
"ErrorCode": "CAD0021",
"ErrorMessage": "Invalid Email",
"ElementPath": "InvestorInformation.NewInvestor.ResidentNaturalPerson.EmailAddress",
"ElementContent": "jose.silva@example@123"
}
]
}