[GET] User
Operation
Returns a list of all the User by chain.
GET
http://{urlName}/tesiproPMS/api/{version}/chain/{chainId}/user/{userId}
Request
Property | Type | Required | Default value | Description |
---|---|---|---|---|
chainId | Integer | true | The id of the chain. This parameter will be in the URL. Path parameter. | |
userId | Integer | false | The id of the user. This parameter will be in the URL. Path parameter. |
Example request
GET http://81.184.0.161:9696/tesiproPMS/api/v1/chain/1/user/1
Response
Property | Type | Required | Description |
---|---|---|---|
User | User | true | Response |
Entity
Field | Type | Required | Description |
---|---|---|---|
id | int | true | Unique identifier for the User. |
chain | Chain | true | Chain related to this user. |
userName | String | true | Name in the app for this user |
String | true | Email of the user | |
language | Language | false | Language of the user |
accountLockDate | Date | false | Date that the account was locked |
remark | String | false | remark of the user |
statusCode | StatusCode | true | The status of this user account |
userRoleSet | Collection of UserRole | false | Collection of entities that link one User with one Role. |
userPropertySet | Collection of UserProperty | false | Collection of entities that link one User with one Property. |
gridColumnUserSet | Collection of GridColumnUser | false | Collection of entities that link one User with one GridColumn. |
dashboardSet | Collection of Dashboard | false | Collection of Dashboard entities, that change the display of the homepage in the PMS. |
userPreferenceSet | Collection of UserPreference | false | Collection of entities that link one User with a UserPreferenceType with a certain name. |
dateFormatType | DateFormatType | false | Shows the format for the date available for this user. |
timeFormatType | TimeFormatType | false | Shows the format for the time available for this user. |
dayOfWeek | DayOfWeek | false | Shows which day of week is considered the first one for this user. |
Example response
{ "id": 1, "createdDate": "2018-07-16T15:23:54.897Z", "modifiedDate": "2018-07-16T15:23:55.170Z", "createdUser": 0, "modifiedUser": 0, "chain": null, "userName": "Tesipro", "passwordLastChangeDate": 1531747435193, "email": "d.martin@tesipro.com", "language": { "id": 2, "codeISO6391": "EN", "name": "English", "nativeName": "English" }, "statusCode": { "id": 1, "code": "1", "name": "Open", "colorCode": "#43a047", "nameI18n": "Open" }, "userRoleSet": null, "userPropertySet": null, "gridColumnUserSet": null, "dashboardSet": null, "userPreferenceSet": null, "dateFormatType": { "id": 1, "code": "dd/MM/aaaa", "name": "dd/MM/aaaa", "pattern": "DD/MM/YYYY", "nameI18n": "Dd/Mm/Yyyy" }, "timeFormatType": { "id": 1, "code": "HH:mm:ss 24h", "name": "HH:mm:ss", "pattern": "HH:mm:ss", "nameI18n": "Hh:Mm:Ss" }, "dayOfWeek": { "id": 1, "code": "Sun", "name": "Sunday", "nameI18n": "Sunday" } }