GET api/RoomDescription/{id}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Descriptions.Query.RoomDescriptionDataContractName | Description | Type | Additional information |
---|---|---|---|
Rooms | Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.RoomDescriptionSelectedRoomDataContract |
None. |
|
Name | string |
None. |
|
Order | integer |
None. |
|
Type | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
PropertyId | integer |
None. |
|
Notes | string |
None. |
|
Roles | Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.DescriptionRoleDataContract |
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:
{ "Rooms": [ { "Images": [ { "Order": 1, "Url": "sample string 2", "RequiresAuthentication": true, "ExpiryDate": "2024-10-06T05:18:52.0447233Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 4", "ContentType": "sample string 5", "FileExtension": "sample string 6", "Description": "sample string 7", "FileSize": "sample string 8", "CreatedDate": "2024-10-06T05:18:52.0447233Z", "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": 10 }, { "Order": 1, "Url": "sample string 2", "RequiresAuthentication": true, "ExpiryDate": "2024-10-06T05:18:52.0447233Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 4", "ContentType": "sample string 5", "FileExtension": "sample string 6", "Description": "sample string 7", "FileSize": "sample string 8", "CreatedDate": "2024-10-06T05:18:52.0447233Z", "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": 10 } ], "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-06T05:18:52.0447233Z", "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 }, { "Images": [ { "Order": 1, "Url": "sample string 2", "RequiresAuthentication": true, "ExpiryDate": "2024-10-06T05:18:52.0447233Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 4", "ContentType": "sample string 5", "FileExtension": "sample string 6", "Description": "sample string 7", "FileSize": "sample string 8", "CreatedDate": "2024-10-06T05:18:52.0447233Z", "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": 10 }, { "Order": 1, "Url": "sample string 2", "RequiresAuthentication": true, "ExpiryDate": "2024-10-06T05:18:52.0447233Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 4", "ContentType": "sample string 5", "FileExtension": "sample string 6", "Description": "sample string 7", "FileSize": "sample string 8", "CreatedDate": "2024-10-06T05:18:52.0447233Z", "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": 10 } ], "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-06T05:18:52.0447233Z", "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 } ], "Name": "sample string 1", "Order": 2, "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PropertyId": 3, "Notes": "sample string 4", "Roles": [ { "Name": "sample string 1", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 2 }, { "Name": "sample string 1", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 2 } ], "CreatedDate": "2024-10-06T05:18:52.0447233Z", "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": 6 }