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]/[group name]/api/v2/banner/

Example: https://kb.wisc.edu/demo/api/v2/banner/

** You can find your siteId by reviewing the URI Components in the Group Spaces API. Please review [Link for document 86189 is unavailable at this time] for details. Your siteId will be listed as an integer in the extSiteId value.

{
    "siteId": "2",
    "header": "<p>The specific HTML content of my active banner.</p>",
    "headerActivation": "2022-07-27 23:15:35",
    "headerExpiration": "2022-08-18 13:00:00",
    "_links": {
        "self": {
            "href": "https://kb.wisc.edu/demo/api/v2/banner/"
        }
    }
}

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 }

This API will only return a result if the banner is currently active on the external site. If banner content was created, but the "Activation" time stamp is in the future or the "Expiration" time stamp is in the past, the API call will return a 404 error.