List General Settings

Service name: list_general_settings

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings

Description

Lists general settings for the account.

Parameters

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings&optional_parameters={parameter-value}
ParameterDescriptionTypeOptionsDefault
describeOptional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.booleantrue0

Examples

List general settings

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_general_settings

Example response

<?xml version="1.0"?>
<settings created="2010-09-16T08:53:03+01:00" host="SERVERi">
  <items>
    <general>
      <language>en_GB</language>
      <clear24x7checks>1</clear24x7checks>
      <cleardailysafetychecks>1</cleardailysafetycheck>
      <notesbacklog>90</notesbacklog>
      <forcenotes>0</forcenotes>
      <vartimezone>Europe/London</vartimezone>
    </general>
  </items>
</settings>

Returned fields

FieldTypeCan Be EmptyDescription
languagestringnoLanguage representation
clear24x7checksintegerno1 or 0 flag
cleardailysafetychecksintegerno1 or 0 flag
notesbacklogintegernoNumber of days
forcenotesintegerno1 or 0 flag
vartimezonestringyesAccount time zone