Server Configuration Read

What does it do?

Returns information about a particular ohmage install.

URI

config/read

Accessibility

Anyone may access this API call.

Input Parameters

None.

Example GET

http://localhost/app/config/read

cURL Example

curl -v -d "" https://dev.ohmage.org/app/config/read

Output Format

Success

{
   "result" : "success",
   "data" : {
     "application_build" : "<Git version number>",
     "application_name" : "<Name of the application>",
     "application_version" : "<Version of the application>",
     "auth_token_lifetime" : "<The milliseconds an authentication token is allowed to exist>,
     "default_campaign_creation_privilege" : <A boolean representing what the default campaign creation privilege is>,
     "default_survey_response_sharing_state" : "<Default response sharing state>",
     "maximum_parameter_size": <Maximum parameter size in bytes>,
     "maximum_request_size": <Maximum request size in bytes>,
     "mobility_enabled" : <A boolean representing the visibility status of mobility visualizations in the front-end>,
     "recaptcha_public_key": <A public key for Google's reCAPTCHA service>,
     "self_registration_allowed": <A boolean representing whether the install supports self-registration>,
     "survey_response_privacy_states" : <A JSONArray of all possible survey response sharing states for this deployment>
   }
}

Failure

See the error page for a description of error codes and their associated descriptions.