Settings

Site settings describe certain settings for the site, regarding logos, slogans and colors used.

Get Settings

curl "https://example.ziik.io/api/settings"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
{
    "site": {
        "name": "Awesome Intranet",
        "tagline": "The Awesome Intranet for All",
        "headline": "Welcome to the Awesome Intranet"
    },
    "look": {
        "logo": {
            "id": 123,
            "name": "logo.jpg",
            "extension": "jpg",
            "mime": "image/jpeg",
            "size": 2462,
            "type": "image",
            "source": "https://example.ziik.io/api/file/example/design/logo.jpg",
            "versions": {
                "listing": "https://example.ziik.io/sites/default/files/example/styles/article_listing/public/design/logo.jpg",
                "detail": "https://example.ziik.io/sites/default/files/example/styles/article_desktop/public/design/logo.jpg",
                "thumbnail":"https://example.ziik.io/api/file/styles/media_thumbnail/private/manuals/filename.png"
            }
        },
        "mobile": {
            "id": 124,
            "name": "mobilelogo.jpg",
            "extension": "jpg",
            "mime": "image/jpeg",
            "size": 2462,
            "type": "image",
            "source": "https://example.ziik.io/api/file/example/design/mobilelogo.jpg",
            "versions": {
                "listing": "https://example.ziik.io/sites/default/files/example/styles/article_listing/public/design/mobilelogo.jpg",
                "detail": "https://example.ziik.io/sites/default/files/example/styles/article_desktop/public/design/mobilelogo.jpg",
                "thumbnail":"https://example.ziik.io/api/file/styles/media_thumbnail/private/manuals/filename.png"
            }
        },
        "icon": {
            "id": 125,
            "name": "icon.jpg",
            "extension": "jpg",
            "mime": "image/jpeg",
            "size": 7591,
            "type": "image",
            "source": "https://example.ziik.io/api/file/example/design/icon.jpg",
            "versions": {
                "listing": "https://example.ziik.io/sites/default/files/example/styles/article_listing/public/design/icon.jpg",
                "detail": "https://example.ziik.io/sites/default/files/example/styles/article_desktop/public/design/icon.jpg",
                "thumbnail":"https://example.ziik.io/api/file/styles/media_thumbnail/private/manuals/filename.png"
            }
        },
        "mobile_bg": {
            "id": 126,
            "name": "mobilebg.jpg",
            "extension": "jpg",
            "mime": "image/jpeg",
            "size": 2462,
            "type": "image",
            "source": "https://example.ziik.io/api/file/example/design/mobilebg.jpg",
            "versions": {
                "listing": "https://example.ziik.io/sites/default/files/example/styles/article_listing/public/design/mobilebg.jpg",
                "detail": "https://example.ziik.io/sites/default/files/example/styles/article_desktop/public/design/mobilebg.jpg",
                "thumbnail":"https://example.ziik.io/api/file/styles/media_thumbnail/private/manuals/filename.png"
            }
        },
        "selected_mobile_logo": "mobilelogo"
    },
    "colors": {
        "top": "#274a65",
        "icon": "#f5f5f5",
        "active": "#3fb298"
    },
    "modules": {
        "calendar": true,
        "chat": true,
        "documents": true,
        "faq": true,
        "groups": true,
        "manuals": true,
        "news": true,
        "quicklinks": true,
        "shifts": true
    }
}

This endpoint retrieves site settings for logos and colors

HTTP Request

GET https://example.ziik.io/api/settings

Query Parameters

None - all settings are returned

Update Settings

curl -i -X PATCH "https://example.ziik.io/api/settings"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint replaces settings with the provided values.

HTTP Request

PATCH https://example.ziik.io/api/settings

Request Parameters

ParameterTypeRequiredDescription
siteArrayNoSite settings array with the following values
- nameStringNoName of the intranet - shown in title bar in browsers etc.
- taglineStringNoTagline - shown in page footer
- headlineStringNoIntroduction text - shown on login page
lookArrayNoFiles array with the following values
- logoArrayNoFile array with the following sub-values
-- typeStringYesType of file - can be either 'upload', 'youtube' or 'vimeo'.
-- nameStringYesFile name.
-- dataStringYesIf type is 'upload' this must be the base64 encoded content of the file. Else it must be the Youtube/Vimeo embed URL.
- mobileArrayNoFile array with the following sub-values
-- typeStringYesType of file - can be either 'upload', 'youtube' or 'vimeo'.
-- nameStringYesFile name.
-- dataStringYesIf type is 'upload' this must be the base64 encoded content of the file. Else it must be the Youtube/Vimeo embed URL.
- mobile_bgArrayNoFile array with the following sub-values
-- typeStringYesType of file - can be either 'upload', 'youtube' or 'vimeo'.
-- nameStringYesFile name.
-- dataStringYesIf type is 'upload' this must be the base64 encoded content of the file. Else it must be the Youtube/Vimeo embed URL.
- iconArrayNoFile array with the following sub-values
-- typeStringYesType of file - can be either 'upload', 'youtube' or 'vimeo'.
-- nameStringYesFile name.
-- dataStringYesIf type is 'upload' this must be the base64 encoded content of the file. Else it must be the Youtube/Vimeo embed URL.

Permissions Required

  • Administer permission to Look & Feel

Get Countries

curl -i -X GET "https://example.ziik.io/api/settings/countries"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"
{
    "AF": "Afghanistan",
    "AL": "Albanien",
    "DZ": "Algeriet",
    "AS": "Amerikansk Samoa",
    "AD": "Andorra",
    "AO": "Angola",
    "AI": "Anguilla",
    "AQ": "Antarktis",
    "AG": "Antigua og Barbuda",
    "AR": "Argentina",
    "AM": "Armenien",
    "AW": "Aruba",
    "AZ": "Aserbajdsjan",
    "AU": "Australien",
    "BS": "Bahamas",
    "BH": "Bahrain",
    "BD": "Bangladesh",
    "BB": "Barbados",
    "BE": "Belgien",
    "BZ": "Belize",
    [... Snip ...]
    "EH": "Vestsahara",
    "VN": "Vietnam",
    "WF": "Wallis og Futuna\u00f8erne",
    "YE": "Yemen",
    "ZM": "Zambia",
    "ZW": "Zimbabwe",
    "AX": "\u00c5land",
    "EG": "\u00c6gypten",
    "GQ": "\u00c6kvatorialguinea",
    "AT": "\u00d8strig"
}

This endpoint retrieves countries in ISO format and in the language of the current user

HTTP Request

GET https://example.ziik.io/api/settings/countries

Get Languages

curl -i -X GET "https://example.ziik.io/api/settings/languages"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"
{
    "da": "Dansk",
    "en": "English",
    "sv": "Svenska"
}

This endpoint retrieves languages in ISO format localised to the language itself

HTTP Request

GET https://example.ziik.io/api/settings/languages