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. | Mensagem de retorno para qualquer um dos serviços, quando não há registros para a busca requisitada. |
| 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. | Pode ocorrer quando o sistema não consegue identificar o vínculo do usuário logado. |
| 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. | Pode ocorrer quando o código do protocolo requisitado esteja em branco ou com número negativo (null ou menor que 1 ex. -123). |
| 14 | Código do anexo inválido. | Pode ocorrer quando o código do anexo requisitado estiver em branco ou com número negativo (null ou menor que 1 ex. -123). |
| 15 | Código do trâmite inválido. | Pode ocorrer quando o codigo do tramite requisitado estiver em branco ou com número negativo (null ou menor que 1 ex. -123). |
| 16 | Código da Área inexistente ou inválida. | Pode ocorrer quando quando o sistema não identifica o codigo da area solicitado ou ele não existe. |
| 17 | Código do Assunto inexistente ou inválido. | Código do Assunto inexistente ou inválido. |
| 18 | Código do Problema inexistente ou inválido. | Pode ocorrer quando o sistema não identifica o código do problema ou ele não existe. |
| 19 | Código do Meio de Consumo inexistente ou inválido. | Código do Meio de Consumo inexistente ou inválido. |
| 20 | Código do Grupo Econômico inexistente ou inválido. | Código do Grupo Econômico inexistente ou inválido. |
| 21 | Código da empresa do grupo econômico inexistente ou inválido. | Pode ocorrer quando o sistema não identifica o código do grupo econômico da empresa ou ele não existe. |
| 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. |
| 9901 | Erro interno ao complementar a informação. | Erro interno na ação de complementar a reclamação. |
| 9902 | Erro interno ao responder a informação. | Erro interno na ação de responder a reclamação. |
| 9903 | Erro interno ao recusar a informação. | Erro interno na ação de recusar a reclamação. |
| 9904 | Erro interno ao redirecionar a informação. | Erro interno na ação de redirecionar a reclamação. |
| 9905 | Erro interno ao recuperar credencial. | Erro interno na ação de recuperar credencial. |
| 9906 | Erro interno ao listar situações. | Erro interno ao listar as situações das reclamações. |
| 9907 | Erro interno ao listar meios de consumo. | Erro interno ao listar os meios de consumo das reclamações. |
| 9908 | Erro interno ao listar áreas. | Erro interno ao listar as áreas das reclamações. |
| 9909 | Erro interno ao listar tipos de trâmites. | Erro interno ao listar tipos de trâmites das reclamações. |
| 9910 | Erro interno ao listar Procons. | Erro interno ao listar Procons. |
| 9911 | Erro interno ao listar tipos de textos dos trâmites. | Erro interno ao listar tipos de textos dos trâmites das reclamações. |
| 9912 | Erro interno ao listar os municípios. | Erro interno ao listar os municípios das reclamações. |
| 9913 | Erro interno ao listar assuntos por área. | Erro interno ao listar assuntos por área das reclamações. |
| 9914 | Erro interno ao listar problemas por área. | Erro interno ao listar problemas por área das reclamações. |
| 9915 | Erro interno ao listar empresas por nome. | Erro interno ao listar empresas por nome das reclamações. |
| 9916 | Erro interno ao listar empresas. | Erro interno ao listar empresas das reclamações. |
| 9917 | Erro interno ao listar subsidiárias com perfil de fornecedor. | Erro interno ao listar subsidiárias com perfil de fornecedor das reclamações. |
| 9918 | Erro interno ao baixar anexo do trâmite da reclamação. | Erro interno na ação ao baixar anexo do trâmite da reclamação. |
| 9919 | Erro interno ao imprimir relatório da reclamação. | Erro interno na ação ao imprimir relatório da reclamação. |
| 9920 | Erro interno ao listar reclamações. | Erro interno ao listar reclamações. |
| 9921 | Erro interno ao listar reclamações paginadas. | Erro interno ao listar reclamações paginadas. |
| 9922 | Erro interno ao consultar reclamações em andamento. | Erro interno na ação ao consultar reclamações em andamento. |
| 9923 | Erro interno ao detalhar reclamação. | Erro interno na ação ao detalhar reclamação. |
| 9924 | Erro interno ao indicar a chegada da reclamação ao judiciário. | Erro interno na ação do indicar a chegada da reclamação ao judiciário. |
| 9925 | Erro interno ao consultar situação da reclamação. | Erro interno na ação de consultar situação da reclamação. |
| 9926 | Erro interno ao obter situações das reclamações. | Erro interno na ação de obter situações das reclamações. |
| 9927 | Erro interno ao listar os trâmites por reclamação. | Erro interno ao listar os trâmites por reclamação. |
| 9928 | Erro interno ao listar os trâmites por período. | Erro interno ao listar os trâmites por período. |
| 9929 | Erro interno ao listar os trâmites por período paginado. | Erro interno ao listar os trâmites por período paginado. |
