Directory

Get All Directory Entries

GET: http://<ServerIP>/unifiedgui/webapi/DirectoryEntry
Example Response
{
    "@odata.context": "https://localhost/unifiedgui/webapi/$metadata#DirectoryEntry",
    "value": [
        {
            "Id": "63a12568-f976-eb11-80f8-0050568f18f2",
            "Name": "Hot Desk 1",
            "Code": "1704",
            "Location": "",
            "Latitude": 45.51823011705024,
            "Longitude": -122.6839846153478,
            "Elevation": null
        },
        {
            "Id": "64a81568-f976-eb11-80f8-0050568f18f4",
            "Name": "James Smith",
            "Code": "4136",
            "Location": "Chicago, IL office",
            "Latitude": null,
            "Longitude": null,
            "Elevation": 135
        },
        ……
    ]
}

Delete Directory Entries

POST: http://<ServerIP>/unifiedgui/webapi/DirectoryEntry/DeleteEntries
Example Request

This POST deletes directory entries with the below IDs.

{ "ids" : ["50075344-be35-ec11-810a-0050568f18f4", "a15cb8fa-8a1c-ec11-8108-0050568f18f4"] }

Add/Update Directory Entries

POST: http://<ServerIP>/unifiedgui/webapi/DirectoryEntry/AddUpdate

Bulk update endpoints and directory entries or add new directory entries.

Request body fields:

  • Match

    • Set this to the name of the column on which to match existing values:

    • “DestinationCode”

    • “IpAddress” (matches endpoints only)

    • “MAC” (matches endpoints only)

    • “URN” (matches endpoints only)

  • UpdateEndpoints (default false)

    • Set to true to update any matching endpoints

  • UpdateDirectory (default false)

    • Set to true to update any matching directory entries

  • AddDirectory (default false)

    • Set to true to create new directory entries if no matches are found

  • Data

    • A list of values, each representing an endpoint/directory entry to update or create

    • The following fields can be included:

      • Name (Custom Name)

      • Destination Code

      • Location

      • Latitude

      • Longitude

      • Elevation

      • IpAddress (affects endpoints only)

      • MAC (affects endpoints only)

      • URN (affects endpoints only)

      • Site (affects endpoints only)

Example Request
{
    "Match": "DestinationCode",
    "UpdateEndpoints": true,
    "UpdateDirectory": true,
    "AddDirectory": true,
    "Data": [
        {
            "Name": "John Doe",
            "DestinationCode": "1234",
            "Location": "Portland, OR office",
            "Elevation": "150"
        },
        {
            "DestinationCode": "400*1",
            "Location": "Building A Floor 5",
            "IpAddress": "192.168.10.50"
        },
        {
            "Name": "Hot Desk 3",
            "DestinationCode": "7",
            "Latitude": "45.51823011705024",
            "Longitude": "-122.6839846153478"
        }
    ]
}