Get memberships for user
get
/learn.rest/v1/users/{userId}/memberships
Request
Path Parameters
-
userId: number
Unique identifier of User.
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0
-
totalResults(optional): boolean
If set to true, payload includes total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/xml
- application/json
200 Response
memberships collection for user fetched.
Root Schema : UserMembershipResponse
Type:
object
The User Membership response object.
Show Source
-
count(optional):
number
Count is the current number of records displayed in the response.
-
hasMore(optional):
boolean
True indicates that we have more records to be displayed.
-
items(optional):
object UserAndMembbershipResponse
-
limit(optional):
number
Limit implies the maximum number of records which can be displayed in the page.
-
links(optional):
array links
Example:
{
"items":[
{
"groupId":932,
"group":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932"
}
]
},
"itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37",
"itemType":"learningPlan",
"itemName":"Name of the item",
"retainMapping":false
},
{
"...":null
}
],
"limit":100,
"count":1,
"hasMore":false,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932/mappedItems"
}
]
}
Nested Schema : UserAndMembbershipResponse
Type:
Show Source
object
-
createdDate(optional):
string
Date the membership was created.Example:
2016-02-23T07:21:00-05:00
-
id(optional):
number(int32)
Id of the user.Example:
6597
-
learnCenter(optional):
array learnCenter
Link to the LearnCenter items.
-
learnCenterId(optional):
number(int32)
Unique identifier of the Learn Center.Example:
178477
-
links(optional):
object MembershipLinkItems
-
status(optional):
string
Status of the membership.Example:
approved
-
statusChangedByUser(optional):
array statusChangedByUser
The link to the user who changed the status.
-
statusChangedByUserId(optional):
string
User Id of the user who changed the membership status.Example:
135131
-
statusChangedDate(optional):
string
The date the status of the membership was changed.Example:
2016-02-23T07:21:00-05:00
-
supervisorAccount(optional):
object supervisorAccount
Object comprising supervisor account links.
-
supervisorAccountId(optional):
string
Unique identifier of the supervisor account.Example:
{ "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0" }
-
user(optional):
array user
Link to the users.
-
userCustomFieldValues(optional):
object userCustomFieldValues
Object comprising user custom fields links.
-
userId(optional):
number
Unique Identifier for the user.Example:
456
Nested Schema : learnCenter
Type:
array
Link to the LearnCenter items.
Show Source
-
Array of:
object LearnCenterLinkItems
Learn Center Link Item object. This object comprises links to the Learn Center Items.
Nested Schema : MembershipLinkItems
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/memberships/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/memberships/456"
}
Nested Schema : statusChangedByUser
Type:
array
The link to the user who changed the status.
Show Source
-
Array of:
object UserLinkItems
Link to user items.
Nested Schema : supervisorAccount
Type:
object
Object comprising supervisor account links.
Show Source
Nested Schema : user
Type:
array
Link to the users.
Show Source
-
Array of:
object UserLinkItems
Link to user items.
Nested Schema : userCustomFieldValues
Type:
object
Object comprising user custom fields links.
Show Source
Nested Schema : LearnCenterLinkItems
Type:
object
Learn Center Link Item object. This object comprises links to the Learn Center Items.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/learncenters/178477
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178477"
}
Nested Schema : UserLinkItems
Type:
object
Link to user items.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
Nested Schema : SupervisorAccountLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
-
rel(optional):
string
Example:
canonical
Nested Schema : UserCustomFieldLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/memberships/6597/customFieldValues
-
rel(optional):
string
Example:
canonical
401 Response
500 Response
Internal server error.