GET api/room/{id}

Get a room by its Id Processes this room API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the room to get. Pass 0 to be returned an empty data contract.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The room or null if it does not exist

RoomDataContract
NameDescriptionTypeAdditional information
Order

The order value.

integer

None.

Name

The name value.

string

None.

Text

The text value.

string

None.

RoomDescriptionType

The room description type value.

EnumDataContract

None.

RoomMeasurements

The collection of room measurements.

Collection of RoomMeasurementDataContract

None.

CreatedDate

The created date, expressed as a date and time.

date

None.

CreatedBy

The created by value.

CreatedByDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Order": 1,
  "Name": "sample string 2",
  "Text": "sample string 3",
  "RoomDescriptionType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RoomMeasurements": [
    {
      "MeasurementUnitType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Width": 1.1,
      "Length": 2.1,
      "OriginalMeasurement": true,
      "Id": 4
    },
    {
      "MeasurementUnitType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Width": 1.1,
      "Length": 2.1,
      "OriginalMeasurement": true,
      "Id": 4
    }
  ],
  "CreatedDate": "2026-07-23T10:34:46.4397914Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 5
}