KB User's Guide - API - Site Footers

This document provides information about the Site Footers API for the KnowledgeBase.

Title

Get Site Footers

Calls externally-published Site Footers of the specified site domain.

Collection Endpoint

This API does not have an collection response.

Entity Endpoint

/api/v1/site-footers/[siteId]

Example: https://kb.wisc.edu/api/v1/site-footers/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 as the extSiteId value. (update on all docs)

Entity Sample Response

{
"siteId": "2",
"footer": "<div id=\"social_media\">\r\n<ul>\r\n<!--<li class=\"feedback\"><a href=\"http://kb.wisc.edu/helpdesk/feedback.php\">Feedback</a></li>-->\r\n<li class=\"facebook\"><a href=\"http://www.facebook.com/UWDoIT\">Facebook</a></li>\r\n<li class=\"twitter\"><a href=\"http://twitter.com/#!/UWDoIT\">Twitter</a></li>\r\n<li class=\"youtube\"><a href=\"http://www.youtube.com/user/uwmadisondoit\">YouTube</a></li>\r\n<li class=\"rss\"><a href=\"http://it.wisc.edu/feed/?post_type=post\">DoIT's newsfeed</a></li>\r\n</ul>\r\n</div>\r\n<a href=\"feedback.php\">Feedback</a><br />\r\n<a href=\"http://helpdesk.wisc.edu\">Help Desk</a>, 608-264-4357, help@doit.wisc.edu <br />\r\n<a href=\"http://www.doit.wisc.edu\">Division of Information Technology</a><br />\r\n1210 W Dayton St, Madison, WI<br />\r\nCopyright © 2018 The Board of Regents of the University of Wisconsin System<br />",
"gaStatus": "1",
"gaPropertyId": "UA-8213594-3",
"gaAnonymizeIp": "0",
"_links": {
"self": {
"href": "https://kb.wisc.edu/api/v1/site-footers/2"
}
}
}



gastatus = Google Analytics Status (1 = enabled, 0= not enabled)
gaPropertyId = Your distinct Google Analytics Tracking number
gaAnonymizeIp = Google Analytics does not report the last octet of the IP address subsequently preventing the IP address being an identifier.
(1 = enabled, 0= not enabled)

Success Response

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

Error Response

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

OR

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

Notes





Keywords:restapi method url data params parameters success errors responses sample calls notes service   Doc ID:86202
Owner:Teresa A.Group:KB User's Guide
Created:2018-10-02 17:05 CDTUpdated:2021-10-18 13:26 CDT
Sites:KB User's Guide
Feedback:  0   0