Jump to

• Request
• Response

Get a list of owners for groups in LearnCenter.

get

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

Request

Path Parameters

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

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 the total number of rows that satisfies the request. 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 owners collection fetched.

Body ()

Root Schema : GroupOwnersResponse

Type: object

Response object for Group Owners.

Show Source

• items(optional): object GroupOwnerLinkItem
  Link to the list of group owners.
• links(optional): array links

{
    "description":"Response object for Group Owners.",
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/GroupOwnerLinkItem"
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "id":112867,
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
                    }
                ]
            }
        ],
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "id":112867,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
        }
    ]
}

Nested Schema : GroupOwnerLinkItem

Type: object

Link to the list of group owners.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
• rel(optional): string
  Example: canonical

{
    "description":"Link to the list of group owners.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
    }
}

Example:

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

Nested Schema : links

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

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

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

Example Response (application/json)

{
    "items":[
        {
            "id":112867,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
        }
    ]
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top