Para facilitar e padronizar a informação para o usuário, os erros que podem ocorrer durante a integração da mensagem única, deverão ser tratados conforme catálogo abaixo.
Os códigos utilizam a seguinte máscara na sua composição:
XY999
Onde:
X - corresponde à área responsável pela geração do erro/aviso/informação. As letras possíveis na posição são:
Y - corresponde à natureza da mensagem. As opções são:
999 - código numérico sequencial.
| Código | Operação | Descrição | Retorno para mensagem |
|---|---|---|---|
AW001 | Exclusão | Registro não encontrado | Retornará código de warning informando que não encontrou o registro |
AW002 | Alteração/Exclusão | Não existência de de/para | Retornará código de warning informando que não encontrou o de/para |
AW003 | Inclusão/Alteração | Máscara incorreta | ** Aplicado somente nos casos padronizados ou em que houve um acordo na fase de desenho da integração. Retornará código de warning informando que a máscara está incorreta. |
AE001 | Exclusão | Registro relacionado em movimentações | Retornará código de erro informando que o registro não poderá ser excluído, pois está sendo utilizado em tabelas de movimentações. |
AE002 | Alteração | FK não encontrada; Encontrou o de/para, mas não encontrou o registro na base | Retornar código de erro informando que não ser alterado o registro, pois faltam cadastros relacionados. |
AE003 | Inclusão/Alteração | Exception (Erro de programação) | Retornar Erro + Log padrão de cada produto |
| AE004 | Inclusão/Alteração | Empresa não configurada para integração | Retornará código de erro informando que a empresa enviada na Tag CompanyId (BusinessContent) não está habilitada para integração |
FE001 | Todas | Mensagem padrão no formato incorreto | Tratado pelo EAI (Framework) |
FE002 | Todas | Incompatibilidade de versões da mensagem única | Tratado pelo EAI (Framework) |
FE003 | Todas | Timeout | Tratado pelo EAI (Framework) |
FE004 | Todas | Mensagem já existe no repositório com o UUID informado | Tratado pelo EAI (Framework) |
| IE001 | Pesquisa | Identificador da requisição inválido | Erro na validação do identificador da requisição. |
| IE002 | Inclusão/Alteração | Campos da estrutura JSON inválida | Erro na validação dos campos da estrutura json enviada para persistência. |
| IE003 | Pesquisa | Entidade não encontrada | Erro ao buscar entidade no repositório. |
| IE004 | Inclusão/Alteração | Estrutura JSON inválida | Erro na validação da estrutura json enviada para persistência |
| IE005 | Todas | Aplicativo de origem (sourceApplication) desconhecido. | Retornar o nome do aplicativo de origem fornecido na mensagem. |
| IE006 | Todas | Aplicativo de origem (sourceApplication) não foi informado. | |
| IE007 | Todas | Aplicativo de origem é o próprio aplicativo de recebimento. | Retornar o nome do aplicativo interno. |
| IE008 | Todas | Transação e versão não está habilitada para recebimento. | Retornar o nome da transação e a versão. |
| IE009 | Todas | Falha na comunicação entre sistemas. | Erro ao comunicar com sistema integrado : [Mensagem de erro] |