GET api/room/{id}

Get a room by its Id

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

Dezrez.Core.DataContracts.External.Api.Rooms.Query.RoomDataContract
NameDescriptionTypeAdditional information
Order

integer

None.

Name

string

None.

Text

string

None.

RoomDescriptionType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

RoomMeasurements

Collection of Dezrez.Core.DataContracts.External.Api.Rooms.Query.RoomMeasurementDataContract

None.

CreatedDate

date

None.

CreatedBy

Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract

None.

Id

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": "2024-10-11T18:02:55.0649418Z",
  "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
}