Community

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

get
Path parameters
guidstringRequired

guid of specified asset

Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[providers]stringOptional

comma separated list of field names

includestringOptional

A comma separated list of resource names that will be returned in the response.

Responses
200
OK
application/json
get
GET /rest/v4.1/providers/{guid} HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*

{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 1
  },
  "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

get
Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[providers]stringOptional

comma separated list of field names

filter[providers]stringOptional

an ODATA-like query string used to filter

sort[providers]stringOptional

a comma separated list of property names specifying the sort order of the returned results

includestringOptional

A comma separated list of resource names that will be returned in the response.

limitnumberOptional

The page size for the response dataset. limit must be 100 or less.

offsetnumberOptional

How far into the dataset you are paging

Responses
200
OK
application/json
get
GET /rest/v4.1/providers HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*

{
  "links": {
    "self": "text",
    "first": "text",
    "last": "text",
    "next": "text",
    "prev": "text"
  },
  "meta": {
    "took": 1,
    "limit": 1,
    "count": 1,
    "offset": 1
  },
  "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"
          }
        }
      }
    }
  ]
}
PreviousManaging and Predicting RelationshipsNextCanvas LMS

Last updated

Was this helpful?