Settings for user
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | users.json | |
| General | Yes | Parameters described in overview | see overview | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=usersettings | Using data models |
| Active | No | Option filter | active=Y | |
| Filters | No | Filter by a key field | Filters |
Get a single user by passing UUID in filters. Eg: uuid=EE096758FAFA3541AA8383834734C739
Example request:
http://<SERVER>/jsonapi/users.json?user=user&password=user&style=modeldata&modelstructure=usersettings&version=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.9,
"data": [
{
"userUuid": "090AECF644244F62BA0F344AFC8B436D",
"userTimestampModified": 1622034249,
"userRecordVersionNumber": 1122,
"userDateFormat": "dd/mm/y",
"userDefaultCompany": "1",
"userDefaultCompanyName": "The Professional Services Company",
"calUserAvatarUrl": "/custom/User_54.jpg",
"userUserId": 54,
"userUsername": "User",
"userFullName": "User",
"userTimezoneCode": "UTCA",
"userCountry": "UK"
}
]
}