Preferences – Modulo Risk Manager

Returns information on the current user's personal preferences.

 

URL

{RMUrl}/api/info/me/preferences

 

REQUEST METHOD

GET

 

URL PARAMETERS

This feature does not have parameters.

 

REQUEST EXAMPLE

{RMUrl}/api/info/me/preferences

 

SUCCESS RESPONSE

A JSON object will be returned in the following format:

{

object ItemsPerPage;

object Language;

object ShowGraphs;

}

 

ItemsPerPage: Returns information on the user's preferences regarding the number of items displayed per page in lists throughout the system. This object contains two fields:

UseSystemDefault: "True" or "false". When "true", the "Value" field will display the specifications for the system default settings. When "false", the "Value" field will display those for the user's preferences.

Value: Whole number indicating the number of items displayed per page.

Language: Returns information on the user's preferences regarding the language used to access Modulo Risk Manager. This object contains two fields:

UseSystemDefault: "True" or "false". When "true", the "Value" field will display the specifications for the system default settings. When "false", the "Value" field will display those for the user's preferences.

Value: String indicating the language set by the user. Values returned: "en-US", "es-ES", and "pt-BR".

ShowGraphs: Returns information on the user's preferences regarding the default showing of graphs throughout the system. This object contains two fields:

UseSystemDefault: "True" or "false". When "true", the "Value" field will display the specifications for the system default settings. When "false", the "Value" field will display those for the user's preferences.

Value: Boolean ("true" or "false") indicating whether or not graphs are displayed by default in the system.

 

SUCCESS RESPONSE EXAMPLES

{

"ItemsPerPage":{"UseSystemDefault":true,"Value":10},

"Language":{"UseSystemDefault":false,"Value":"en-US"},

"ShowGraphs":{"UseSystemDefault":true,"Value":true}

}