Jump to

• Request
• Response

Get learnCenters

get

/learn.rest/v1/learnCenters

Returns LearnCenters.

Request

Query Parameters

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

  Default Value: 0
• q(required): string
  Search through LearnCenters collection items. Use Mongo DB Query format. Searchable properties are - name, path. example: ?q={path:{$eq: 'home/api'}}
• totalResults: boolean
  If set to true, the payload includes total number of rows that satisfies the request. 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

LearnCenters collection fetched.

Body ()

Root Schema : LearnCentersResponse

Type: object

Show Source

• count: number
  Example: 100
• hasMore: boolean
  Example: true
• items: array items
• limit: number
  Example: 100
• links: array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterResponse"
            }
        },
        "limit":{
            "type":"number",
            "example":100
        },
        "count":{
            "type":"number",
            "example":100
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/learnCenters"
                },
                {
                    "rel":"first",
                    "href":"{url}/v1/learnCenters?limit=100&offset=0"
                },
                {
                    "rel":"prev",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
                },
                {
                    "rel":"next",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
                },
                {
                    "rel":"last",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object LearnCenterResponse

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

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":"{url}/learn.rest/v1/learnCenters"
        },
        {
            "rel":"first",
            "href":"{url}/v1/learnCenters?limit=100&offset=0"
        },
        {
            "rel":"prev",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
        },
        {
            "rel":"next",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
        },
        {
            "rel":"last",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters"
    },
    {
        "rel":"first",
        "href":"{url}/v1/learnCenters?limit=100&offset=0"
    },
    {
        "rel":"prev",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
    },
    {
        "rel":"next",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
    },
    {
        "rel":"last",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
    }
]

Nested Schema : LearnCenterResponse

Type: object

Show Source

• description: string
  Example: Description of LearnCenter
• id: number
  Example: 178000
• links: array links
• memberships: object memberships
• name: string
  Name of the LearnCenter

  Example: Name of LearnCenter
• path: string
  Example: home/xyz
• publicFlag: string
  Example: false
• status: string
  Example: active
• supervisorAccounts: object supervisorAccounts
• url: string
  Example: {url}/xyz
• userCustomFields: object userCustomFields

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":178000
        },
        "name":{
            "type":"string",
            "description":"Name of the LearnCenter",
            "example":"Name of LearnCenter"
        },
        "description":{
            "type":"string",
            "example":"Description of LearnCenter"
        },
        "url":{
            "type":"string",
            "example":"{url}/xyz"
        },
        "path":{
            "type":"string",
            "example":"home/xyz"
        },
        "publicFlag":{
            "type":"string",
            "example":false
        },
        "status":{
            "type":"string",
            "example":"active"
        },
        "memberships":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterMembershipsLink"
                    }
                }
            }
        },
        "userCustomFields":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterUserCustomFieldsLink"
                    }
                }
            }
        },
        "supervisorAccounts":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountsLink"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterLink

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

Nested Schema : memberships

Type: object

Show Source

• links: array links

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

Nested Schema : supervisorAccounts

Type: object

Show Source

• links: array links

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

Nested Schema : userCustomFields

Type: object

Show Source

• links: array links

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

Nested Schema : LearnCenterLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409
• rel: string
  Example: canonical

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

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterMembershipsLink

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

Nested Schema : LearnCenterMembershipsLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships
• rel: string
  Example: canonical

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

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountsLink
  Object comprising supervisor accounts links.

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

Nested Schema : SupervisorAccountsLink

Type: object

Object comprising supervisor accounts links.

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts
• rel: string
  Example: canonical

{
    "type":"object",
    "description":"Object comprising supervisor accounts links.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterUserCustomFieldsLink

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

Nested Schema : LearnCenterUserCustomFieldsLink

Type: object

Show Source

• href: string
  Example: {url}/learn.rest/v1/learnCenters/178409/userCustomFields
• rel: string
  Example: canonical

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

Nested Schema : items

Type: object

Show Source

• href: string
• rel: 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