[GET] User

Operation

Returns a list of all the User by chain.

GET
http://{urlName}/tesiproPMS/api/{version}/chain/{chainId}/user/{userId}


Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
The id of the chain. This parameter will be in the URL. Path parameter.
userIdIntegerfalse
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

PropertyTypeRequiredDescription
UserUsertrueResponse

Entity


FieldTypeRequiredDescription
idinttrueUnique identifier for the User.
chainChaintrueChain related to this user.
userNameStringtrueName in the app for this user
emailStringtrueEmail of the user
languageLanguagefalseLanguage of the user
accountLockDateDatefalseDate that the account was locked
remarkStringfalseremark of the user
statusCodeStatusCodetrueThe status of this user account
userRoleSetCollection of UserRolefalseCollection of entities that link one User with one Role.
userPropertySetCollection of UserPropertyfalseCollection of entities that link one User with one Property.
gridColumnUserSetCollection of GridColumnUserfalseCollection of entities that link one User with one GridColumn.
dashboardSetCollection of DashboardfalseCollection of Dashboard entities, that change the display of the homepage in the PMS.
userPreferenceSetCollection of UserPreferencefalseCollection of entities that link one User with a UserPreferenceType with a certain name.
dateFormatTypeDateFormatTypefalseShows the format for the date available for this user.
timeFormatTypeTimeFormatTypefalseShows the format for the time available for this user.
dayOfWeekDayOfWeekfalseShows 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"
  }
}