Consortiums

Invite account to consortium

post

/api/consortiums/{id}/members

Invites an account to become a member of a consortium. This can only be performed by admins of the account that created the consortium. If the account is already a pending or joined member of the consortium, their existing membership record will be returned.

Example:

curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/consortiums/0123456789/members"
data.json:
{
  "accountId": "0123456789"
}

Authorizations

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Path parameters

idstringRequired

The id of the consortium, provided in the url

Body

accountIdstringRequired

The id of the account to invite to the consortium

Responses

200

Membership record created or returned

application/json

idstringOptional

The id of the membership record

consortiumIdstringOptional

The id of the consortium the membership invitation is for

accountIdstringOptional

The id of the account that was invited to be a member

accountNamestringOptional

The name of the account that was invited

isContributorbooleanOptional

Whether or not the invited account should be a contributor to the account. New invites default to true

statusstring · enumOptional

The current status of the invitation. By default new invites are pending

Possible values:

4XX

Bad Request

application/json

post

/api/consortiums/{id}/members

POST /api/consortiums/{id}/members HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "accountId": "text"
}

{
  "id": "text",
  "consortiumId": "text",
  "accountId": "text",
  "accountName": "text",
  "isContributor": true,
  "status": "pending"
}

Remove a member account from a consortium

delete

/api/consortiums/{id}/members/{memberId}

Delete a membership record for a consortium. This request can only be performed by an admin of the institution that created the consortium for which the membership record belongs. The creator of the consortium cannot remove themselves as a member of the consortium. The memberId must be for a membership record that is part of the consortium (consortiumId).

Example:

curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/consortiums/123/members/456"

Authorizations

x-session-idstringRequired

Path parameters

idstringRequired

The id of the consortium that the membership belongs to

memberIdstringRequired

The id of the membership to be deleted

Responses

204

No Content

4XX

Bad Request

application/json

delete

/api/consortiums/{id}/members/{memberId}

DELETE /api/consortiums/{id}/members/{memberId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

Update consortium membership

put

/api/consortiums/{id}/members/{memberId}

Update an account member's contributor setting. Only an admin of the account that created the consortium can perform this action.

Example:

curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/consortiums/0123456789/members/9876543210"
data.json:
{
  "isContributor": true
}

Authorizations

x-session-idstringRequired

Path parameters

idstringRequired

The id of the consortium

memberIdstringRequired

The id of the membership record to update

Body

isContributorbooleanRequired

Whether the consortium member has the privilege to share resources to the consortium

Responses

200

Membership record updated

application/json

idstringOptional

The id of the membership record

consortiumIdstringOptional

The id of the consortium the membership is for

accountIdstringOptional

The id of the account of the consortium member

accountNamestringOptional

The name of the account

isContributorbooleanOptional

Whether or not the consortium member should be a contributor to the consortium

statusstring · enumOptional

The current status of the membership. There are 3 different possibilities: pending, member, declined.

Possible values:

4XX

Bad Request

application/json

put

/api/consortiums/{id}/members/{memberId}

PUT /api/consortiums/{id}/members/{memberId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "isContributor": true
}

{
  "id": "text",
  "consortiumId": "text",
  "accountId": "text",
  "accountName": "text",
  "isContributor": true,
  "status": "pending"
}

Update consortium membership status

put

/api/consortiums/{id}/members/{memberId}/status

Update the membership status of your own institution in a consortium. This action can only be performed by an admin of the institution that is a member of the consortium.

Example:

curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/consortiums/0123456789/members/9876543210/status"
data.json:
{
  "status": "member"
}

Authorizations

x-session-idstringRequired

Path parameters

idstringRequired

The id of the consortium

memberIdstringRequired

The id of the membership record to update

Body

statusstring · enumRequired

The new membership status for the institution in the consortium. The existing membership in the consortium must be pending.

Possible values:

Responses

200

Membership record updated

application/json

idstringOptional

The id of the membership record

consortiumIdstringOptional

The id of the consortium the membership is for

accountIdstringOptional

The id of the account of the consortium member

accountNamestringOptional

The name of the account

isContributorbooleanOptional

Whether or not the consortium member should be a contributor to the consortium

statusstring · enumOptional

The current status of the membership. There are 3 different possibilities: pending, member, declined.

Possible values:

4XX

Bad Request

application/json

put

/api/consortiums/{id}/members/{memberId}/status

PUT /api/consortiums/{id}/members/{memberId}/status HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "member"
}

{
  "id": "text",
  "consortiumId": "text",
  "accountId": "text",
  "accountName": "text",
  "isContributor": true,
  "status": "pending"
}

Get account consortiums

get

/api/consortiums

Gets a list of all consortiums that the current user's account is a part of.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/consortiums"

Authorizations

x-session-idstringRequired

Responses

200

An array of consortiums

application/json

4XX

Bad Request

application/json

get

/api/consortiums

GET /api/consortiums HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "creatorAccountId": "text",
      "creatorAccountName": "text",
      "membershipStatus": "pending",
      "membershipId": "text",
      "membershipIsContributor": true
    }
  ]
}

Create account consortiums

post

/api/consortiums

Creates a new consortium with the provided name. Only account admins may perform this action.

Example:

  curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json  "https://lor.instructure.com/api/consortiums"
  data.json:
  {
    "name": "The consortium name"
  }

Authorizations

x-session-idstringRequired

Body

namestring · min: 1 · max: 50Optional

The desired name for the consortium

Responses

201

The newly created consortium

application/json

4XX

Bad Request

application/json

post

/api/consortiums

POST /api/consortiums HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "The consortium name"
}

{
  "id": "text",
  "name": "text",
  "creatorAccountId": "text"
}

Get consortium and details

get

/api/consortiums/{consortiumId}

Gets a consortium as well as all membership information for the consortium. Must be an admin of the account that created the consortium to use this request.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/consortiums/0123456789"

Authorizations

x-session-idstringRequired

Path parameters

consortiumIdstringRequired

The consortium id

Responses

200

Consortium and members

application/json

4XX

Bad Request

application/json

get

/api/consortiums/{consortiumId}

GET /api/consortiums/{consortiumId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "consortium": {
    "id": "text",
    "name": "text",
    "creatorAccountId": "text"
  },
  "members": [
    {
      "id": "text",
      "consortiumId": "text",
      "accountId": "text",
      "accountName": "text"
    }
  ]
}

Update consortium settings

put

/api/consortiums/{consortiumId}

Update a consortium's settings.

Example:

  curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/consortiums/0123456789"
  data.json:
  {
    "name": "New name"
  }

Authorizations

x-session-idstringRequired

Path parameters

consortiumIdstringRequired

The consortium id

Body

namestringOptional

The new name to use for the consortium

Responses

200

The updated consortium

application/json

idstringOptional

The id of the consortium

namestringOptional

The name of the consortium

creatorAccountIdstringOptional

The Account ID of the consortium's creator

4XX

Bad Request

application/json

put

/api/consortiums/{consortiumId}

PUT /api/consortiums/{consortiumId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "New name"
}

{
  "id": "text",
  "name": "text",
  "creatorAccountId": "text"
}

Delete a consortium

delete

/api/consortiums/{consortiumId}

Deletes a consortium. Only Administrators are allowed to perform this action.

Example: curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/consortiums/123"

Authorizations

x-session-idstringRequired

Path parameters

consortiumIdstringRequired

The consortium id

Responses

204

No Content

4XX

Bad Request

application/json

delete

/api/consortiums/{consortiumId}

DELETE /api/consortiums/{consortiumId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

PreviousAccount NextCourses

Last updated 8 months ago

Was this helpful?

hashtagInvite account to consortium

hashtagRemove a member account from a consortium

hashtagUpdate consortium membership

hashtagUpdate consortium membership status

hashtagGet account consortiums

hashtagCreate account consortiums

hashtagGet consortium and details

hashtagUpdate consortium settings

hashtagDelete a consortium

Invite account to consortium

Remove a member account from a consortium

Update consortium membership

Update consortium membership status

Get account consortiums

Create account consortiums

Get consortium and details

Update consortium settings

Delete a consortium