Versions Compared

Key

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

Overview

Excerpt

Request for a the basic User DataSettings.

Details

This request is similar to the Get User DataSettings 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/UserUsers/GetDataBasicGetSettingsBasic

Request

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

Example

Code Block
languagejson
{
  "Id": Array[int],
  "EmailaddressEmailAddress": "string",
}

Response

An array of user objects should be returned.

Example

Code Block
languagejson
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
    },
    "DepartmentsAssignedSpaces": Array[
      Object{
        "IdResId": int,
        "NameResName": "string",
        "ManagerSpaceType": int (User Id),"string",
        "MembersIconPath": Array[int (User Id),int (User Id)],"string"
        "TeamsMapId": Array[int,int,int]
      }
    ],
    "Teams": Array[
      Object{
        "Id": int,
        "Name": "string",
        "TeamLeader": Array[
          int (User Id)
        ],
        "Members": Array[
          Object{
            "Id": int (User Id),int (User Id)],
            "EmailAddress": "string",
            "FirstName": "string",
            "LastName": "string",
            "UserImage": "string"
          }
        ]
      }
    ]
  }
]