Versions Compared

Key

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

...

{{url}}/api/Search/Resources

Request

The request will include all filter options valid for resources; such as location, space type, equipment etc.
The option to specify available resources only is needed, this will then require the start and end time option.

Example

Code Block
languagejson
{
  "SearchText": "string",
  "Location": Object{
    "Country": "string",
    "City": "string",
    "Site": "string",
    "Building": "string",
    "Floor": "string",
    "Zone": "string"
  },
  "SpaceTypes": Array["Roomstring", "Conference Roomstring"],
  "Equipment": Array["Phonestring", "TVstring"],
  "Tags": Array[],
  "MinOccupancy": 4int,
  "Available": trueboolean, // available based on StartTime and EndTime
  "StartTime": "dd/MM/yyyy HH:mm",
  "EndTime": "dd/MM/yyyy HH:mm"
}

...

The response will include the user's bookingsa list of all resources that match the requested search criteria.

Full booking data for each resource is not required.

Example

Code Block
languagejson
{
  "SearchResults": Array[
    Object{
      "ResIdId": 1int,
      "Name": "Meeting Roomstring",
      "Status": 1int,
      "Location": Object{
        "Country": "string",
        "City": "string",
        "Site": "string",
        "Building": "string",
        "Floor": "string",
        "Zone": "string"
      },
      "SpaceType": "Roomstring",
      "IconPath": "string",
      "Occupancy": 4int,
      "MapId": 1234int,
    },
    Object{
      "ResIdId": 2int,
      "Name": "Conference Roomstring",
      "Status": 1int,
      "Location": Object{
        "Country": "string",
        "City": "string",
        "Site": "string",
        "Building": "string",
        "Floor": "string",
        "Zone": "string"
      },
      "SpaceType": "Conference Roomstring",
      "IconPath": "/ResourceFiles/images/conference-room-icon.svgstring",
      "Occupancy": 8int,
      "MapId": 1234int,
    }
  ]
}

Use case

...

...