Na integração tanto pelo Webservice REST quanto pela API, os valores de retorno contem, além dos dados, uma mensagem e o código dessa mensagem.
Abaixo segue uma listagem de todos os códigos possíveis de retorno.
| Código da Mensagem | Mensagem | Descrição |
|---|---|---|
| 01 | Ok. | Mensagem de sucessos para qualquer um dos serviços. |
| 02 | Sem resultado para estes parâmetros. | -- |
| 03 | Validação - (descrição). | Retornado quando ocorre validações de regras nas ações. |
| 04 | Validação de segurança. | Validação genérica sobre segurança e acessos. |
| 05 | Usuário responsável inexistente. | Quando passa-se o CPF do usuário autorizado no cabeçalho, mas ele não existe, este erro é retornado. |
| 06 | Usuário responsável não representa um fornecedor ou vínculo não está ativo. | Usuários de acesso, quando passa-se o CPF do usuário autorizado no cabeçalho, devem ter vínculo de representante com a credenciada. |
| 07 | Credenciada inexistente na sessão de segurança. Verifique o token de acesso. | Quando o token temporário é gerado, a credenciada relativa é inserida no contexto de segurança. Ao acessar um recurso e caso a credenciada não esteja inserida no contexto, este erro é retornado. |
| 08 | O fornecedor da reclamação não é a credenciada logada. Verifique os dados e tente novamente. | Pode ocorrer caso tente efetuar ações para uma reclamação onde a sua credenciada não seja o reclamado. |
| 09 | O 'Tipo de Tramite' não foi encontrado para o código passado. | Caso tente consultar por um código de Tipo de Trâmite inexistente. |
| 10 | O período de abertura da consulta está inválido ou insuficiente. Datas devem estar no formato dd-MM-yyyy, e horas em HH:mm:ss. | Lançado caso os campos de período inicial e final de abertura na Consulta de Reclamações estejam inválidos. |
| 11 | O período do prazo da consulta está inválido ou insuficiente. Datas devem estar no formato dd-MM-yyyy, e horas em HH:mm:ss. | Lançado caso os campos de período inicial e final do prazo na Consulta de Reclamações estejam inválidos. |
| 12 | O período dos trâmites da consulta está inválido ou insuficiente. Datas devem estar no formato dd-MM-yyyy, e horas em HH:mm:ss. | Lançado caso os campos de período inicial e final dos trâmites na Consulta de Trâmites estejam inválidos. |
| 13 | Protocolo da reclamação inválido. | -- |
| 14 | Código do anexo inválido. | -- |
| 15 | Código do trâmite inválido. | -- |
| 16 | Código da Área inexistente ou inválida. | -- |
| 17 | Código do Assunto inexistente ou inválido. | -- |
| 18 | Código do Problema inexistente ou inválido. | -- |
| 19 | Código do Meio de Consumo inexistente ou inválido. | -- |
| 20 | Código do Grupo Econômico inexistente ou inválido. | -- |
| 21 | Usuário representante sem permissão para visualizar dados do seu grupo. | -- |
| 22 | Usuário representante sem permissão para adicionar anexos. | Nas ações onde pode-se inserir anexos, o usuário autorizado deve ter permissão específica para anexar arquivos, independente da permissão da ação. |
| 23 | Usuário representante sem permissão para efetuar complementos. | Na ação de complemento da reclamação, o usuário autorizado deve ter permissão específica, caso contrário este erro é retornado. |
| 24 | Usuário representante sem permissão para detalhar reclamação. | No retorno dos detalhes de uma reclamação, o usuário autorizado deve ter permissão específica, caso contrário este erro é retornado. |
| 25 | Usuário representante sem permissão para listagem de reclamações. | Na listagem das reclamações, o usuário autorizado deve ter permissão específica, caso contrário este erro é retornado. |
| 26 | Usuário representante sem permissão para visualizar dados do seu grupo. | Na listagem das reclamações, quando tentar acessar dados de outros fornecedores do seu grupo, o usuário autorizado deve ter permissão específica, caso contrário este erro é retornado. |
| 99 | Erro desconhecido. | Erro genérico sem relação com validações. |
