POST api/crmconnect/property/getrooms
Get the rooms as a RoomDescriptionSaveDataContract so that they can be added to a property after creation in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
A value usable to identify the item in the crm, this key is generated by the selected domain service
ObjectNone.
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{}
Response Information
Resource Description
The response returned after the operation completes.
RoomDescriptionSaveDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Rooms |
The collection of rooms. |
Collection of RoomSaveDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Notes |
The notes value. |
string |
None. |
| PropertyId |
The unique identifier of the related property resource. |
integer |
None. |
| RoleId |
The unique identifier of the related role resource. |
integer |
None. |
| ForceUpdate |
Indicates whether force update is true. |
boolean |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Rooms": [
{
"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
}
],
"Id": 4
},
{
"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
}
],
"Id": 4
}
],
"Name": "sample string 1",
"Notes": "sample string 2",
"PropertyId": 3,
"RoleId": 4,
"ForceUpdate": true,
"Id": 6
}