KB User's Guide - API - Institutions

This document provides information in the Institutions API for the KnowledgeBase.

Title

Get Institutions

Calls the list of current KB partner institutions.

Collection Endpoint

[KB site domain]/[subsite (optional)]/api/v1/institutions

Example: https://kb.wisc.edu/api/v1/institutions or https://kb.wisc.edu/helpdesk/api/v1/institutions

Method

GET

URL Params

Note: All URL params are optional.

parameter type description
query text string one or more search terms, separated by a plus sign (plus sign)

Collection Sample Response

{
  "_links": {
    "self": {
      "href": "https://kb.wisc.edu/api/v1/institutions?page=1"
    },
    "first": {
      "href": "https://kb.wisc.edu/api/v1/institutions"
    },
    "last": {
      "href": "https://kb.wisc.edu/api/v1/institutions?page=1"
    }
  },
  "_embedded": {
    "institution": [
      {
        "id": "1",
        "instId": "1",
        "instDomain": "wisc.edu",
        "instUrl": "kb.wisc.edu",
        "instName": "University of Wisconsin-Madison",
        "instNameShort": "UWMadison",
        "instMainGroup": "20",
        "instAdminDir": "kbAdmin",
        "instMobileApp": "1",
        "_links": {
          "self": {
            "href": "https://kb.wisc.edu/api/v1/institutions/1"
          }
        }
      },
      {
        "id": "2",
        "instId": "2",
        "instDomain": "uchicago.edu",
        "instUrl": "answers.uchicago.edu",
        "instName": "University of Chicago",
        "instNameShort": "UChicago",
        "instMainGroup": "0",
        "instAdminDir": "kbAdmin",
        "instMobileApp": "0",
        "_links": {
          "self": {
            "href": "https://kb.wisc.edu/api/v1/institutions/2"
          }
        }
      },

      ...

      }
    ]
  },
  "page_count": 1,
  "page_size": 35,
  "total_items": 22,
  "page": 1
}

Entity Endpoint

/api/v1/institutions/[institution_id]

Example: /api/v1/institutions/1

Entity Sample Response

{
  "id": "1",
  "instId": "1",
  "instDomain": "wisc.edu",
  "instUrl": "kb.wisc.edu",
  "instName": "University of Wisconsin-Madison",
  "instNameShort": "UWMadison",
  "instAdminDir": "kbAdmin",
  "instMobileApp": "1",
  "_links": {
    "self": {
      "href": "https://kb.wisc.edu/api/v1/institutions/1"
    }
  }
}

Success Response

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

Error Response

Code: 403 Forbidden
Content: {"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","title":"Forbidden","status":403,"detail":"Forbidden"}

OR

Code: 404 Page Not Found
Content: Page not found.

OR

Code: 405 Method Not Allowed
Content: None

OR

Code: 500 Unexpected error
Content: { error : "Error producing an iterator" }

Notes

N/A

See Also:




Keywords:restapi method url data params parameters success errors responses sample calls notes service institutions universities partners   Doc ID:71624
Owner:Leah S.Group:KB User's Guide
Created:2017-03-10 12:59 CSTUpdated:2021-10-18 12:21 CST
Sites:KB User's Guide
Feedback:  0   0