Read System color

Resource type: basicsettings

“Basic settings” refer to specific configurations that can be set in the “basic settings” (Grundeinstellung) of “enterprise” under the “Characteristics/CI” (Merkmale/CI) section. These settings relate to design elements and color schemes to reflect the customer’s corporate identity (CI).

These are the settings that can be read via the API: Logo, System Color (Systemfarbe), Icon Color (Module-Icons), Shading (Schattierung), Warning Notice Color (Warnhinweis), Logo Display, Spot Color. Permission is located in the “basic settings” and “onOffice App” tab.

Parameters: 

• • • characteristicsCi
      ARRAY
      • • • logo
            This is a file uploaded by the customer, such as an image file in PNG or JPEG format.
          • color
            A hexadecimal value representing the main color.
          • color2
            A hexadecimal value representing the secondary color.
          • textcolorMail
            A hexadecimal value representing the font color.
          • claim
            Claim is a text input field.
          • systemUiColor
            A hexadecimal value representing the desired main color of the system. (Example: ff0000).
          • moduleIconUiColor
            A hexadecimal value representing the color of the module icons.
          • moduleIconShadeUiType
            Select the shading between the values “hell” (light) or “dunkel” (dark).
          • warningNoticeUiColor
            A hexadecimal value representing the color of the warning notice.
          • showLogoInQuickbar
            This checkbox allows the user to choose whether to show the logo in the user interface.
          • spotColor
            A calculated color derived from the system color that is automatically darkened for light values.
  • • permissions
      BOOLEAN. The checkbox to start/stop working time via the onOffice app.
    • team
      STRING. This is the text field where you input information about the team for the “About Us” section.
  Request example

  {
      "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
      "resourceid": "",
      "identifier": "",
      "resourcetype": "basicsettings",
      "parameters": {
          "data": {
              "basicData": {
                  "characteristicsCi": [
                      "logo",
                      "color",
                      "color2",
                      "textcolorMail",
                      "claim",
                      "systemUiColor",
                      "moduleIconUiColor",
                      "moduleIconShadeUiType",
                      "warningNoticeUiColor",
                      "showLogoInQuickbar",
                      "spotColor"
                  ],
                  "permissions": [
                      "/onOfficeApp/timetracking/enabled"
                  ],
                  "team": [
                      "about"
                  ]
              }
          }
      }
  }
  

  Response example

  {
      "status": {
          "code": 200,
          "errorcode": 0,
          "message": "OK"
      },
      "response": {
          "results": [
              {
                  "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
                  "resourceid": "",
                  "resourcetype": "basicsettings",
                  "cacheable": false,
                  "identifier": "",
                  "data": {
                      "meta": {
                          "cntabsolute": null
                      },
                      "records": [
                          {
                              "id": 0,
                              "type": null,
                              "elements": {
                                  "basicData": {
                                      "characteristicsCi": {
                                          "logo": "",
                                          "color": "d8bfd8",
                                          "color2": "ffa07a",
                                          "textcolorMail": "ff0000",
                                          "claim": "",
                                          "systemUiColor": "a52a2a",
                                          "moduleIconUiColor": "ffffff",
                                          "moduleIconShadeUiType": "ffffff22",
                                          "warningNoticeUiColor": "ff7f50",
                                          "showLogoInQuickbar": false,
                                          "spotColor": "a52a2a"
                                      },
                                      "permissions": {
                                          "/onOfficeApp/timetracking/enabled": true
                                      },
                                      "team": {
                                          "about": "Test about us Text field in Response"
                                      }
                                  }
                              }
                          }
                      ]
                  },
                  "status": {
                      "errorcode": 0,
                      "message": "OK"
                  }
              }
          ]
      }
  }