Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

memberships collection for user fetched.

Body ()

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

{
    "description":"The User Membership response object.",
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/UserAndMembbershipResponse"
        },
        "limit":{
            "type":"number",
            "description":"Limit implies the maximum number of records which can be displayed in the page."
        },
        "count":{
            "type":"number",
            "description":"Count is the current number of records displayed in the response."
        },
        "hasMore":{
            "type":"boolean",
            "description":" True indicates that we have more records to be displayed."
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "format":"int32",
            "example":6597,
            "description":"Id of the user."
        },
        "learnCenterId":{
            "type":"number",
            "format":"int32",
            "example":178477,
            "description":"Unique identifier of the Learn Center."
        },
        "learnCenter":{
            "description":"Link to the LearnCenter items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLinkItems"
            }
        },
        "userId":{
            "type":"number",
            "example":456,
            "description":"Unique Identifier for the user."
        },
        "user":{
            "description":"Link to the users.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"Date the membership was created."
        },
        "status":{
            "type":"string",
            "example":"approved",
            "description":"Status of the membership."
        },
        "statusChangedDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"The date the status of the membership was changed."
        },
        "statusChangedByUserId":{
            "type":"string",
            "example":"135131",
            "description":"User Id of the user who changed the membership status."
        },
        "statusChangedByUser":{
            "description":"The link to the user who changed the status.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "supervisorAccount":{
            "type":"object",
            "description":"Object comprising supervisor account links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "supervisorAccountId":{
            "type":"string",
            "description":"Unique identifier of the supervisor account.",
            "example":{
                "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0"
            }
        },
        "userCustomFieldValues":{
            "type":"object",
            "description":"Object comprising user custom fields links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserCustomFieldLink"
                    }
                }
            }
        },
        "links":{
            "$ref":"#/definitions/MembershipLinkItems"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

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.

{
    "description":"Link to the LearnCenter items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LearnCenterLinkItems"
    }
}

Nested Schema : MembershipLinkItems

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/memberships/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/memberships/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/memberships/456"
    }
}

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.

{
    "description":"The link to the user who changed the status.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : supervisorAccount

Type: object

Object comprising supervisor account links.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising supervisor account links.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : user

Type: array

Link to the users.

Show Source

• Array of: object UserLinkItems
  Link to user items.

{
    "description":"Link to the users.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : userCustomFieldValues

Type: object

Object comprising user custom fields links.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising user custom fields links.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserCustomFieldLink"
            }
        }
    }
}

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

{
    "type":"object",
    "description":"Learn Center Link Item object. This object comprises links to the Learn Center Items.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learncenters/178477"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learncenters/178477"
    }
}

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

{
    "type":"object",
    "description":"Link to user items.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SupervisorAccountLink"
    }
}

Nested Schema : SupervisorAccountLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00    "
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserCustomFieldLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserCustomFieldLink"
    }
}

Nested Schema : UserCustomFieldLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/memberships/6597/customFieldValues
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/memberships/6597/customFieldValues"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top