{
  "opencollection": "1.0.0",
  "info": {
    "name": "Lookup/Ibis web service group institution API",
    "version": "1.2"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "institution",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return a list of all the institution attribute schemes available.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/all-attr-schemes"
          },
          "docs": "Return a list of all the institution attribute schemes available.\nThe `schemeid` values of these schemes may be used in the\n`fetch` parameter of other methods that return institutions."
        },
        {
          "info": {
            "name": "Return a list of all institutions.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/all-insts",
            "params": [
              {
                "name": "includeCancelled",
                "value": "",
                "type": "query",
                "description": "Whether or not to include cancelled\ninstitutions. By default, only live institutions are returned."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch."
              }
            ]
          },
          "docs": "Return a list of all institutions.\n\nBy default, only a few basic details about each institution are\nreturned, but the optional `fetch` parameter may be used\nto fetch additional attributes or references."
        },
        {
          "info": {
            "name": "Get the institutions with the specified IDs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/list",
            "params": [
              {
                "name": "instids",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of instids."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch."
              }
            ]
          },
          "docs": "Get the institutions with the specified IDs.\n\nBy default, only a few basic details about each institution are\nreturned, but the optional `fetch` parameter may be used\nto fetch additional attributes or references.\n\nThe results are sorted by ID.\n\nNOTE: The URL path length is limited to around 8000 characters, and\nan instid is up to 8 characters long. Allowing for comma separators\nand URL encoding, this limits the number of institutions that this\nmethod may fetch to around 700.\n\nNOTE: The instituti"
        },
        {
          "info": {
            "name": "Find all institutions modified between the specified pair of\ntransactions.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/modified-insts",
            "params": [
              {
                "name": "minTxId",
                "value": "",
                "type": "query",
                "description": "Include modifications made in transactions\nafter (but not including) this one."
              },
              {
                "name": "maxTxId",
                "value": "",
                "type": "query",
                "description": "Include modifications made in transactions\nup to and including this one."
              },
              {
                "name": "instids",
                "value": "",
                "type": "query",
                "description": "Only include institutions with instids in\nthis list. By default, all modified institutions will be included."
              },
              {
                "name": "includeCancelled",
                "value": "",
                "type": "query",
                "description": "Include cancelled institutions. By\ndefault, cancelled institutions are excluded."
              },
              {
                "name": "contactRowChanges",
                "value": "",
                "type": "query",
                "description": "Include institutions whose contact\nrows have changed. By default, changes to institution contact rows are\nnot taken into consideration."
              },
              {
                "name": "membershipChanges",
                "value": "",
                "type": "query",
                "description": "Include institutions whose members\nhave changed. By default, changes to institutional memberships are not\ntaken into consideration."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch."
              }
            ]
          },
          "docs": "Find all institutions modified between the specified pair of\ntransactions.\n\nThe transaction IDs specified should be the IDs from two different\nrequests for the last (most recent) transaction ID, made at different\ntimes, that returned different values, indicating that some Lookup\ndata was modified in the period between the two requests. This method\nthen determines which (if any) institutions were affected.\n\nBy default, only a few basic details about each institution are\nreturned, but the optional"
        },
        {
          "info": {
            "name": "Search for institutions using a free text query string.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/search",
            "params": [
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The search string."
              },
              {
                "name": "approxMatches",
                "value": "",
                "type": "query",
                "description": "Flag to enable more approximate\nmatching in the search, causing more results to be returned. Defaults\nto `false`. This is ignored for LQL queries."
              },
              {
                "name": "includeCancelled",
                "value": "",
                "type": "query",
                "description": "Flag to allow cancelled institutions\nto be included. Defaults to `false`."
              },
              {
                "name": "attributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to\nconsider when searching. If this is `null` (the default) then\nall attribute schemes marked as searchable will be included. This is\nignored for LQL queries."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of results to skip at the start\nof the search. Defaults to 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return.\nDefaults to 100."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "The order in which to list the results.\nThis may be either `\"instid\"` or `\"name\"` (the default for\nnon-LQL queries). This is ignored for LQL queries, which always return\nresults in instid order."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch."
              }
            ]
          },
          "docs": "Search for institutions using a free text query string. This is the\nsame search function that is used in the Lookup web application.\n\nBy default, only a few basic details about each institution are\nreturned, but the optional `fetch` parameter may be used\nto fetch additional attributes or references.\n\nNOTE: If the query string starts with the prefix `\"inst:\"`, it\nis treated as an [LQL query](/lql), allowing\nmore advanced searches. An LQL query will ignore the\n`approxMatches` and `attributes` para"
        },
        {
          "info": {
            "name": "Count the number of institutions that would be returned by a search\nusing a free text query string.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/search-count",
            "params": [
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The search string."
              },
              {
                "name": "approxMatches",
                "value": "",
                "type": "query",
                "description": "Flag to enable more approximate\nmatching in the search, causing more results to be returned. Defaults\nto `false`. This is ignored for LQL queries."
              },
              {
                "name": "includeCancelled",
                "value": "",
                "type": "query",
                "description": "Flag to allow cancelled institutions\nto be included. Defaults to `false`."
              },
              {
                "name": "attributes",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of attributes to\nconsider when searching. If this is `null` (the default) then\nall attribute schemes marked as searchable will be included. This is\nignored for LQL queries."
              }
            ]
          },
          "docs": "Count the number of institutions that would be returned by a search\nusing a free text query string.\n\nNOTE: If the query string starts with the prefix `\"inst:\"`, it\nis treated as an [LQL query](/lql), allowing\nmore advanced searches. An LQL query will ignore the\n`approxMatches` and `attributes` parameters, but\nit will respect the value of `includeCancelled`."
        },
        {
          "info": {
            "name": "Get the institution with the specified ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution to fetch."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch."
              }
            ]
          },
          "docs": "Get the institution with the specified ID.\n\nBy default, only a few basic details about the institution are\nreturned, but the optional `fetch` parameter may be used\nto fetch additional attributes or references of the institution.\n\nNOTE: The institution returned may be a cancelled institution. It is\nthe caller's responsibility to check its cancelled flag."
        },
        {
          "info": {
            "name": "Get all the cancelled members of the specified institution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid/cancelled-members",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch for each person."
              }
            ]
          },
          "docs": "Get all the cancelled members of the specified institution.\n\nBy default, only a few basic details about each member are returned,\nbut the optional `fetch` parameter may be used to fetch\nadditional attributes or references of each person.\n\nNOTE: This method returns only cancelled people. It does not include\npeople who were removed from the institution. Cancelled people are no\nlonger considered to be current staff, students or accredited visitors,\nand are no longer regarded as belonging to any gro"
        },
        {
          "info": {
            "name": "Get all the contact rows of the specified institution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid/contact-rows",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch for any people referred to by any\nof the contact rows."
              }
            ]
          },
          "docs": "Get all the contact rows of the specified institution.\n\nAny addresses, email addresses, phone numbers and web pages\nassociated with the contact rows are automatically returned, as\nwell as any people referred to by the contact rows.\n\nIf any of the contact rows refer to people, then only a few basic\ndetails about each person are returned, but the optional\n`fetch` parameter may be used to fetch additional\nattributes or references of each person.\n\nNOTE: This method will not include cancelled people."
        },
        {
          "info": {
            "name": "Get one or more (possibly multi-valued) attributes of an institution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid/get-attributes",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution."
              },
              {
                "name": "attrs",
                "value": "",
                "type": "query",
                "description": "The attribute scheme(s) to fetch. This may\ninclude any number of the attributes or pseudo-attributes, but it\nmay not include references or attribute chains (see the documentation\nfor the `fetch` parameter in this class)."
              }
            ]
          },
          "docs": "Get one or more (possibly multi-valued) attributes of an institution.\nThe returned attributes are sorted by attribute scheme precedence and\nthen attribute precedence."
        },
        {
          "info": {
            "name": "Get all the members of the specified institution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid/members",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution."
              },
              {
                "name": "fetch",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of any additional\nattributes or references to fetch for each person."
              }
            ]
          },
          "docs": "Get all the members of the specified institution.\n\nBy default, only a few basic details about each member are returned,\nbut the optional `fetch` parameter may be used to fetch\nadditional attributes or references of each person.\n\nNOTE: This method will not include cancelled people."
        },
        {
          "info": {
            "name": "Get a specific attribute of an institution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://lookup-test.srv.uis.cam.ac.uk/api/v1/inst/:instid/:attrid",
            "params": [
              {
                "name": "instid",
                "value": "",
                "type": "path",
                "description": "The ID of the institution."
              },
              {
                "name": "attrid",
                "value": "",
                "type": "path",
                "description": "The ID of the attribute to fetch."
              }
            ]
          },
          "docs": "Get a specific attribute of an institution."
        }
      ]
    }
  ],
  "bundled": true
}