Skip to content

Server Configuration Read

joshuaselsky edited this page Feb 3, 2012 · 8 revisions

What does it do?

Returns information about a particular ohmage install.

URL

config/read

Accessibility

Anyone may access this API call.

Input Parameters

None.

Example GET

http://localhost/app/config/read

Output Format

Success

{
   "result" : "success",
   "data" : {
     "application_name" : "<Name of the application>",
     "application_version" : "<Version of the application>",
     "application_build" : "<Git version number>",
     "default_survey_response_sharing_state" : "<Default response sharing state>",
     "survey_response_privacy_states" : <A JSONArray of all possible survey response sharing states for this deployment>
     "default_campaign_creation_privilege" : <A boolean representing what the default campaign creation privilege is.>
   }
}

Failure

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