KB User's Guide - API - Site Logos

This document provides information in the Site Logos API for the KnowledgeBase.

Title

Get Site Logos

Calls the externally-published site logos of the specified site domain

Collection Endpoint

This API does not have an collection response.

Entity Endpoint

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

Example: https://kb.wisc.edu/api/v1/site-logos/1

** 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 URI Component.

Entity Sample Response

{
"logoImgPath": "https://kb.wisc.edu/images/group363/logo/uw-crest-web.png",
"logoImgWidth": "",
"logoImgHeight": "",
"logoImgLink": "",
"_links": {
"self": {
"href": "https://kb.wisc.edu/api/v1/site-logo/2"
}
}
}

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:86203
Owner:Teresa A.Group:KB User's Guide
Created:2018-10-02 17:19 CDTUpdated:2021-10-18 13:27 CDT
Sites:KB User's Guide
Feedback:  0   0