Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

Overview

Request for a the basic User Data.

Details

This request is similar to the Get User Data 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/User/GetDataBasic

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", 
    "DefaultLocation": Object{
      "LocationId": int,
      "Country": "string",
      "City": "string",
      "Site": "string",
      "Building": "string",
      "Floor": "string",
      "Zone": "string",
      "Locked": false
    },
    "AssignedSpace": {
      "ResId": int,
      "ResName": "string",
      "SpaceType": "string",
      "IconPath": "string"
      "MapId": Array[int,int]
    }
    "Departments": Array[
      Object{
        "Id": int,
        "Name": "string",
        "Manager": int (User Id),
        "Members": Array[int (User Id),int (User Id)],
        "Teams": Array[int,int,int]
      }
    ],
    "Teams": Array[
      Object{
        "Id": int,
        "Name": "string",
        "TeamLeader": int (User Id),
        "Members": Array[int (User Id),int (User Id)]
      }
    ]
  }
]
  • No labels