Características comuns às funcionalidades do Módulo Risk Manager

PREFIXO DA URL

Todas as URLs pertinentes para executar consultas são precedidas pelo endereço do Módulo Risk Manager, por exemplo: https://sistema.modulo.com/RM.WebApplication/.

Neste documento, esse endereço é identificado por "{RMUrl}".

SOLICITAÇÃO

Todos os objetos são enviados bare (sem codificação) e podem estar nos formatos JSON ou XML. Seus tipos devem ser especificados no cabeçalho Content-Type. Para obter mais detalhes, veja o tópico Orientações técnicas -> Content-Type.

RESPOSTA

Todos os objetos retornados são enviados bare (sem codificação) e podem estar nos formatos JSON ou XML, dependendo do tipo especificado nos cabeçalhos Accept ou Content-Type. Para obter mais detalhes, veja o tópico Orientações técnicas -> Accept.

RESPOSTA DE ERRO

Se um erro ocorrer durante a execução da funcionalidade, um objeto JSON será retornado no seguinte formato:

{

string error;

string error_description;

string error_uri;

string[] error_details;

ApiApplicationError[] app_errors;

}

O objeto ApiApplicationError está no seguinte formato:

ApiApplicationError

{

string error_code;

string parameter_name;

string[] values;

}

Dependendo do error_code, um parameter_name pode ser retornado junto com uma lista de valores. Para obter mais detalhes, veja o tópico Tratamento de erros -> Erros detalhados da API.