[GET] List Users
Operation
Returns a list of all the User by chain.
GET
http://{urlName}/tesiproPMS/api/{version}/chain/{chainId}/user
Request
Property | Type | Required | Default value | Description |
---|---|---|---|---|
chainId | Integer | true | The id of the chain. This parameter will be in the URL. Path parameter. | |
status | Integer | false | Filter by StatusCode | |
excludeByPropertyId | Integer | false | Filter by PropertyId. | |
search | String | false | Search by username | |
offset | Integer | false | 0 | The offset of the list of results |
limit | Integer | false | 10 | The limit amount of the list of results |
sort | String | false | Id | Field of User to sort by. |
sortMode | String | false | Asc | Mode of sorting: asc, desc.. |
Example request
GET http://81.184.0.161:9696/tesiproPMS/api/v1/chain/1/user
Response
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Response |
Example response
{ "count": 46, "offset": 0, "limit": 10, "list": [ { "id": 1, "createdDate": "2018-07-16T15:23:54.897Z", "modifiedDate": "2018-07-16T15:23:55.170Z", "createdUser": 0, "modifiedUser": 0, "chain": null, "userName": "Username", "passwordLastChangeDate": 1531747435193, "email": "username@tesipro.com", "language": null, "statusCode": { "id": 1, "code": "1", "name": "Open", "colorCode": "#43a047", "nameI18n": "Open" }, "userRoleSet": null, "userPropertySet": null, "gridColumnUserSet": null, "dashboardSet": null, "userPreferenceSet": null, "dateFormatType": null, "timeFormatType": null, "dayOfWeek": null }, { "id": 2, "createdDate": "2018-07-16T15:23:55.223Z", "modifiedDate": "2018-07-16T15:23:55.420Z", "createdUser": 0, "modifiedUser": 0, "chain": null, "userName": "username2", "passwordLastChangeDate": 1531747435420, "email": "username2@tesipro.com", "language": null, "statusCode": { "id": 1, "code": "1", "name": "Open", "colorCode": "#43a047", "nameI18n": "Open" }, "userRoleSet": null, "userPropertySet": null, "gridColumnUserSet": null, "dashboardSet": null, "userPreferenceSet": null, "dateFormatType": null, "timeFormatType": null, "dayOfWeek": null } ]}