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 12 Next »

Overview

Request for User Data.

Details

Type

POST

Endpoint

{{url}}/api/User/GetData

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
  },
  "EventsToday": int, // number of events user has today
  "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"
    }
  ],
  "DateFormat": "dd/MM/yyyy",
  "24hrTimeFormat": boolean
}
  • No labels