Get User Settings (Basic)

By Elliot Dooleysmith
1 min

Overview

Request for a the basic User Settings.

Details

This request is similar to the Get User Settings request, however, it only returns the basic information about the user.

Update: the Id value should be an array of User Id’s.
Allowing for multiple user information to be requested at once.

Type

POST

Endpoint

{{url}}/api/Users/GetSettingsBasic

Request

The request will have two valid parameters, Id or EmailAddress can be used but at least one is required.

Example

{ "Id": Array[int], "EmailAddress": "string", }

Response

An array of user objects should be returned.

Example

Array[ Object{ "Id": 13, "FirstName": "string", "LastName": "string", "EmailAddress": "string", "TelNumber": "string", "JobTitle": "string", "UserImage": "string", "DateFormat": "dd/MM/yyyy", "Is24hrFormat": boolean, "AccessCode": "string", "FirstDayOfWeek": "Monday", // (Monday, Tuesday, ...) "WorkingDays": { "Monday": true, "Tuesday": true, "Wednesday": true, "Thursday": true, "Friday": true, "Saturday": false, "Sunday": false }, "DefaultLocation": Object{ "LocationId": int, "Country": "string", "City": "string", "Site": "string", "Building": "string", "Floor": "string", "Zone": "string", "Locked": false }, "AssignedSpaces": Array[ Object{ "ResId": int, "ResName": "string", "SpaceType": "string", "IconPath": "string" "MapId": Array[int,int] } ], "Teams": Array[ Object{ "Id": int, "Name": "string", "TeamLeader": Array[ int (User Id) ], "Members": Array[ Object{ "Id": int, "EmailAddress": "string", "FirstName": "string", "LastName": "string", "UserImage": "string" } ] } ] } ]

Related content