Jump to

• Request
• Response

Get a list of users mapped to groups in LearnCenter

get

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/users

Request

Path Parameters

• groupId: number
  Unique identifier of a Group.
• learnCenterId: number
  Unique identifier of LearnCenter.

Query Parameters

• limit(optional): integer
  Specifies how many items should be returned in a payload. Must be lower than server default limit size.
• offset(optional): integer
  Specify the starting point of the response.

  Default Value: 0
• totalResults(optional): boolean
  If set to true, the payload includes the total number of rows that satisfies the request. The use of this parameter determines if the 'last' link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Group users collection fetched.

Body ()

Root Schema : GroupUsersResponse

Type: object

Show Source

• count(optional): number
  Example: 1
• hasMore(optional): boolean
  Example: false
• items(optional): object GroupUserResponse
• limit(optional): number
  Example: 100
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/GroupUserResponse"
        },
        "limit":{
            "type":"number",
            "example":100
        },
        "count":{
            "type":"number",
            "example":1
        },
        "hasMore":{
            "type":"boolean",
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://<Rest API host>/learn.rest/v1/learnCenters/178942/groups/1232/users"
                }
            ]
        }
    }
}

Nested Schema : GroupUserResponse

Type: object

Show Source

• excludeFlag(optional): boolean
  Example: false
• group(optional): object group
• groupId(optional): number
  Example: 1234
• links(optional): array links
• statusFlag(optional): boolean
  Example: true
• user(optional): object user
• userId(optional): number
  Example: 112112

{
    "type":"object",
    "properties":{
        "groupId":{
            "type":"number",
            "example":1234
        },
        "group":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GroupLink"
                    }
                }
            }
        },
        "userId":{
            "type":"number",
            "example":112112
        },
        "user":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLink"
                    }
                }
            }
        },
        "statusFlag":{
            "type":"boolean",
            "example":true
        },
        "excludeFlag":{
            "type":"boolean",
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupUserLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://<Rest API host>/learn.rest/v1/learnCenters/178942/groups/1232/users"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://<Rest API host>/learn.rest/v1/learnCenters/178942/groups/1232/users"
    }
]

Nested Schema : group

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object GroupUserLink

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

Nested Schema : user

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object GroupLink

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

Nested Schema : GroupLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}

Nested Schema : GroupUserLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserLink

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

Nested Schema : UserLink

Type: object

Show Source

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

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

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