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

Overview

Search request for People.

Details

Type

POST

Endpoint

{{url}}/api/Search/People

Request

The request will include all filter options valid for people, including, team, department and locations.

The Location option will be based on the user's default location or set location based on the date/time option.

The Working Location will be based on the date/time option.

Example

{
  "SearchText": "string",
  "TeamId": int,
  "DepartmentId": int,
  "WorkingLocation": "string",
  "Location": {
    "Country": "string",
    "City": "string",
    "Site": "string",
    "Building": "string",
    "Floor": "string",
    "Zone": "string"
  },
  "Date": "dd/MM/yyyy",
  "StartTime": "dd/MM/yyyy HH:mm",
  "EndTime": "dd/MM/yyyy HH:mm"
}

Response

The response will include a list of people and their basic information based on the requested date and time.

User booking information is not required for each user.

Example

{
  "SearchResults": [
    {
      "Id": 1,
      "Name": "Abigail Simmons",
      "EmailAddress": "AbigailSimmons@email.com"
      "Status": "Available",
      "WorkingLocation": "Office",
      "DefaultLocation": {
        "Country": "string",
        "City": "string",
        "Site": "string",
        "Building": "string",
        "Floor": "string",
        "Zone": "string"
      },
      "Team": "string",
      "TeamId": int,
      "Department": "string",
      "DepartmentId": int,
      "IconPath": "/ResourceFiles/images/UserAvatar/AbigailSimmons.png"
    },
    {
      "Id": 2,
      "Name": "Aiden Moore",
      "EmailAddress": "AidenMoore@email.com"
      "Status": "Busy",
      "WorkingLocation": "Office",
      "DefaultLocation": {
        "Country": "string",
        "City": "string",
        "Site": "string",
        "Building": "string",
        "Floor": "string",
        "Zone": "string"
      },
      "Team": "string",
      "TeamId": int,
      "Department": "string",
      "DepartmentId": int,
      "IconPath": "/ResourceFiles/images/UserAvatar/AidenMoore.png"
    },
    {
      "Id": 3,
      "Name": "Alexander Baker",
      "EmailAddress": "AlexanderBaker@email.com"
      "Status": "Available",
      "WorkingLocation": "Remote",
      "DefaultLocation": {
        "Country": "string",
        "City": "string",
        "Site": "string",
        "Building": "string",
        "Floor": "string",
        "Zone": "string"
      },
      "Team": "string",
      "TeamId": int,
      "Department": "string",
      "DepartmentId": int,
      "IconPath": "/ResourceFiles/images/UserAvatar/AlexanderBaker.png"
    }
  ]
}

Use case

https://www.figma.com/file/PYl87VrybgtPIqMQr34kJ6/RX-Outlook-Add-in?type=design&node-id=196-159467&mode=dev

  • No labels