Providers

The Providers resource can be used to retrieve information about your Provider account as well as Providers that have shared all or some of their Assets with your organization and Providers with whom you have shared Assets. You can list all of the Providers related to you, filter the list of related Providers or lookup a specific Provider. The response contains the name of the related Provider as well as the Provider's unique GUID and a list of AB taxonomies they have licensed. In the special circumstance where your own Provider object shows up in the response, you will also see relationships listing Providers that are sharing Assets with you (Owners) as well as Providers with whom you are sharing assets (Consumers).

To locate your own Provider object, user the filter parameter and request Providers with ID _me. That is a special constant that matches yourself. While not terribly helpful with the Providers endpoint, you can also use _all as a match on Provider fields to indicate that you want to match on all Providers. This can be used with the owner.id property on the Assets resource where the default behavior is to only list Assets owned by you.

Single Provider

In its simplest form, you are able to retrieve the details of a specific Provider by appending the AB GUID to the path portion of the URL.

Fetching a Provider

GEThttps://api.abconnect.instructure.com/rest/v4.1/providers/{guid}

Path parameters

guid*string

guid of specified asset

Query parameters

Response

200400401404

OK

Body

application/json

linksobject

metaSimpleMetadata (object)

dataProvider (object)

includedarray of Provider (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.abconnect.instructure.com/rest/v4.1/providers/{guid}?partner.id=text&auth.signature=text&auth.expires=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 0
  },
  "data": {
    "type": "providers",
    "id": "text",
    "attributes": {
      "guid": "text",
      "descr": "text",
      "taxonomies": [
        "concepts"
      ]
    },
    "relationships": {
      "owners": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "consumers": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      }
    }
  },
  "included": [
    {
      "type": "providers",
      "id": "text",
      "attributes": {
        "guid": "text",
        "descr": "text",
        "taxonomies": [
          "concepts"
        ]
      },
      "relationships": {
        "owners": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "consumers": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      }
    }
  ]
}

Searching for Providers

Using filtering and facets, it is possible to retrieve sets of Providers that match specific criteria. These Providers are returned in an array of Provider objects. See the Introduction for an explanation on filtering and the use of facets. This section covers the specifics of using these parameters with the Providers resource. Note that by default, the endpoint returns your Provider object and the objects of all Providers related to you.

Finding Sets of Providers

GEThttps://api.abconnect.instructure.com/rest/v4.1/providers

Query parameters

Response

200400401

OK

Body

application/json

linksLinks (all of)

metaPageMetadata (all of)

dataarray of Provider (object)

includedarray of Provider (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.abconnect.instructure.com/rest/v4.1/providers?partner.id=text&auth.signature=text&auth.expires=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "links": {
    "self": "text",
    "first": "text",
    "last": "text",
    "next": "text",
    "prev": "text"
  },
  "meta": {
    "took": 0,
    "limit": 0,
    "count": 0,
    "offset": 0
  },
  "data": [
    {
      "type": "providers",
      "id": "text",
      "attributes": {
        "guid": "text",
        "descr": "text",
        "taxonomies": [
          "concepts"
        ]
      },
      "relationships": {
        "owners": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "consumers": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "providers",
      "id": "text",
      "attributes": {
        "guid": "text",
        "descr": "text",
        "taxonomies": [
          "concepts"
        ]
      },
      "relationships": {
        "owners": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "consumers": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      }
    }
  ]
}