Jump to

• Request
• Response

Get all users.

get

/learn.rest/v1/users

Request

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
• q: string
  Search through users collection items. Use Mongo DB Query format. Searchable properties are - username, email, employeeId. example ?q={email:{$eq: '[e-mail]'}}
• totalResults(optional): boolean
  If set to true, the payload includes the total number of rows that satisfies the request. Use of this 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

Users collection fetched.

Body ()

Root Schema : UsersResponse

Type: object

Show Source

• count(optional): number
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): number
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleUserResponse"
            }
        },
        "limit":{
            "type":"number"
        },
        "count":{
            "type":"number"
        },
        "hasMore":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "id":628706,
                "roleId":640,
                "user":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/users/628706"
                        }
                    ]
                },
                "userRole":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640"
                        }
                    ]
                },
                "statusFlag":true,
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users/628706"
                    }
                ]
            },
            {
                "...":null
            }
        ],
        "limit":100,
        "count":100,
        "hasMore":true,
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "id":628706,
            "roleId":640,
            "user":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/users/628706"
                    }
                ]
            },
            "userRole":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640"
                    }
                ]
            },
            "statusFlag":true,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users/628706"
                }
            ]
        },
        {
            "...":null
        }
    ],
    "limit":100,
    "count":100,
    "hasMore":true,
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object UserRoleUserResponse

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

Nested Schema : links

Type: array

Show Source

• Array of: object items

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

Nested Schema : UserRoleUserResponse

Type: object

Show Source

• createdDate(optional): string
  Example: 2019-02-04T10:46:21Z
• links(optional): array links
• roleId(optional): number
  Example: 640
• statusFlag(optional): boolean
  Example: true
• user(optional): object user
• userId(optional): number
  Example: 123123
• userRole(optional): object userRole

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"number",
            "example":123123
        },
        "roleId":{
            "type":"number",
            "example":640
        },
        "user":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLinkItem"
                    }
                }
            }
        },
        "userRole":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserRoleLinkItem"
                    }
                }
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2019-02-04T10:46:21Z"
        },
        "statusFlag":{
            "type":"boolean",
            "example":true
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
                }
            ]
        }
    }
}

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://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
    }
]

Nested Schema : user

Type: object

Show Source

• links(optional): array links

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

Nested Schema : userRole

Type: object

Show Source

• links(optional): array links

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

Nested Schema : items

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Show Source

• Array of: object UserLinkItem
  Object of the User Link Item.

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

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

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

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "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 UserRoleLinkItem

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

Nested Schema : UserRoleLinkItem

Type: object

Show Source

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

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

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/639"
}

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 the token is invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top