Consortiums
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"
}
The id of the consortium, provided in the url
The id of the account to invite to the consortium
Membership record created or returned
Bad Request
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"
}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"
The id of the consortium that the membership belongs to
The id of the membership to be deleted
No Content
Bad Request
DELETE /api/consortiums/{id}/members/{memberId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
No content
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
}
The id of the consortium
The id of the membership record to update
Whether the consortium member has the privilege to share resources to the consortium
Membership record updated
Bad Request
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 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"
}
The id of the consortium
The id of the membership record to update
The new membership status for the institution in the consortium. The existing membership in the consortium must be pending.
Membership record updated
Bad Request
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"
}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"
An array of consortiums
Bad Request
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
}
]
}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"
}
The desired name for the consortium
The newly created consortium
Bad Request
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"
}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"
The consortium id
Consortium and members
Bad Request
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 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"
}
The consortium id
The new name to use for the consortium
The updated consortium
Bad Request
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"
}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"
The consortium id
No Content
Bad Request
DELETE /api/consortiums/{consortiumId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?