Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt

Request for User DataSettings.

Details

Type

POST

Endpoint

{{url}}/api/Users/UserGetSettings

Request

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

Example

Code Block
languagejson
{
  "UserIdId": 13int,
  "EmailaddressEmailAddress": "charlotte.hill@email.comstring",
}

Response

Example

Code Block
languagejson
{
  "Id": 13,
  "FirstName": "Charlottestring",
  "LastName": "Hillstring", 
  "EmailAddress": Object{
    "Value": "charlotte.hill@email.comstring", 
    "Locked": false
  },
  "TelNumber": Object{
  "+00000000000"  "Value": "string", 
    "Locked": false
  },
  "JobTitle": Object{
    "Value": "string", 
    "Locked": true
  },
  "UserImage": Object{
    "Value": "string", 
    "Locked": false
  },
  "WorkingDays": {
    "Monday": true,
  "/images/user/charlotte-hill-image.png",  "Tuesday": true,
    "Wednesday": true,
    "Thursday": true,
    "Friday": true,
    "EventsTodaySaturday": intfalse,
 //  number of events user has today"Sunday": false
  },
  "DefaultLocationDefaultWorkPlaces": Object{
    "Monday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "LocationIdPlace": int"string"}
    ],
    "Tuesday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "CountryPlace": "string"}
    ],
    "Wednesday": Array[
  "City     Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Site"Thursday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Building"Friday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Saturday": Array[],
    "Floor": "string",
    "ZoneSunday": Array[],
  }
  "WorkPlaceVisibility": "Organisation", // (Organisation, Department, Team, Only Me)
  "DateFormat": "dd/MM/yyyy",
  "Is24hrFormat": boolean,
  "AccessCode": Object{
    "Value": "string", 
    "Locked": true
  },
  "FirstDayOfWeek": "Monday", // (Monday, Tuesday, ...)
  "AssignedWorkspaceDefaultLocation": [Object{
    "ResIdLocationId": int,
    "Country": "string",
    "City": "string",
    "Site": "string",
     "ResName"Building": "string",
    "Floor": "string",
    "Zone": "string",
    "Locked": false
  ]},
  "Departments": Array[
    Object{
      "Id": 1int,
      "Name": "Salesstring",
      "Manager": "jennifer.robinson@email.com" Array[
          int (User Id)
      ],
      "Members": ["emily.williams@email.com","william.hughes@email.com"int (User Id),int (User Id)],
      "Teams": [1int,2int,3int]
    }
  ],
  "Teams": Array[
    Object{
      "Id": 1int,
      "Name": "The A Teamstring",
      "TeamLeader": "jennifer.robinson@email.com" Array[
          int (User Id)
      ],
      "Members": ["emily.williams@email.com","william.hughes@email.com"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"
    }
  ],
  "DateFormat": "dd/MM/yyyy",
  "24hrTimeFormat": boolean,
  
}