System Parameters

System Parameters

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areasystemparameters.json
GeneralYesParameters described in overviewsee overviewStructure of an API call

Version number should NOT be passed.

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/systemparameters.json?

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/systemparameters.json?&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "uuid": "E646889F48DD423CA1300491A31E8C50",
      "paramsAutoEstimateMaterialUnits": 1,
      "paramsAutoEstimateTimeUnits": 1,
      "paramsAwss3Enable": true,
      "paramsCountry": "UK",
      "paramsDateMonthMargin": 36,
      "paramsDefaultCompany": 1,
      "paramsDiaryMinimumHours": 0.25,
      "paramsDiaryTimeSlot": "00:15:00",
      "paramsDisplayStartOfWeek": 2,
      "paramsRateDecimalPlacesBuy": 4,
      "paramsRateDecimalPlacesSell": 4,
      "paramsStartOfWeek": 2,
      "paramsTimezoneCode": "UTCA",
      "paramsVersionNo": 12.4,
      "paramsVersionRevision": "",
      "paramsWebAttachMaxSize": 0,
      "paramsWebAttachOverrideMaxSize": true,
      "paramsWebMaximumSize": 0,
      "paramsWebTimerMinutesIncrement": 3,
      "variable_apiversion": 3.8,
      "variable_systemparametersuserstartofweek__systemparameters_uuid": 2,
      "variable_systemparametersuserstartofweekdisplay__systemparameters_uuid": 2
    }
  ]
}