KB User's Guide - API - Site Banners

Get Site Banners

Calls externally-published Site Banners for a specified site domain.

This API does not have a collection response.

https://[KB site domain]/api/v1/site-banners/[siteId]

Example: https://kb.wisc.edu/api/v1/site-banners/2

** You can find your siteId by reviewing the URI Components in the Group Spaces API. Please review KB User's Guide - API - Group Spaces for details. Your siteId will be listed as an integer in the extSiteId value.

{
    "siteId": "2",
    "header": null,
    "headerActivation": "2018-07-27 23:15:35",
    "headerExpiration": "2018-08-18 13:00:00",
    "_links": {
        "self": {
            "href": "https://kb.wisc.edu/api/v1/site-banners/2"
        }
    }
}

Code: 200 OK
Content: Content-type: application/hal+json

Code: 404 Page Not Found
Content: { error : "Page not found." }

OR

Code: 405 Method Not Allowed
Content: { error : None }