Overview
Request for User Settings.Details
Type
POST
Endpoint
{{url}}/api/Users/GetSettings
Request
The request will have two valid parameters, Id or EmailAddress can be used but at least one is required.
Example
{
"Id": int,
"EmailAddress": "string",
}
Response
Example
{
"Id": 13,
"FirstName": "string",
"LastName": "string",
"EmailAddress": Object{
"Value": "string",
"Locked": false
},
"TelNumber": Object{
"Value": "string",
"Locked": false
},
"JobTitle": Object{
"Value": "string",
"Locked": true
},
"UserImage": Object{
"Value": "string",
"Locked": false
},
"WorkingDays": {
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": false,
"Sunday": false
},
"DefaultWorkPlaces": Object{
"Monday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
],
"Tuesday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
],
"Wednesday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
],
"Thursday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
],
"Friday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
],
"Saturday": Array[],
"Sunday": Array[],
}
"WorkPlaceVisibility": "Organisation" // (Organisation, Department, Team, Only Me)
"DateFormat": "dd/MM/yyyy",
"Is24hrFormat": boolean,
"AccessCode": Object{
"Value": "string",
"Locked": true
},
"FirstDayOfWeek": "Monday", // (Monday, Tuesday, ...)
"DefaultLocation": Object{
"LocationId": int,
"Country": "string",
"City": "string",
"Site": "string",
"Building": "string",
"Floor": "string",
"Zone": "string",
"Locked": false
},
"Departments": Array[
Object{
"Id": int,
"Name": "string",
"Manager": int (User Id),
"Members": [int (User Id),int (User Id)],
"Teams": [int,int,int]
}
],
"Teams": Array[
Object{
"Id": int,
"Name": "string",
"TeamLeader": int (User Id),
"Members": [int (User Id),int (User Id)]
}
],
"BookableLocations": Array[
Object{
"LocationId": int,
"Country": "string",
"City": "string",
"Site": "string",
"Building": "string",
"Floor": "string",
"Zone": "string"
}
],
"ViewableLocations": Array[
Object{
"LocationId": int,
"Country": "string",
"City": "string",
"Site": "string",
"Building": "string",
"Floor": "string",
"Zone": "string"
}
]
}