POST 17.0/database/propertyrooms/list

Description

Retrieve a list of Property Rooms

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of PropertyRoomsUpdate
Name Description Type Additional information
PropertyID

integer

None.
ID

integer

None.
Description

string

String length: inclusive between 0 and 50
FullDescription

string

None.
Width

decimal number

None.
WidthSuffix

byte

None.
Length

decimal number

None.
LengthSuffix

byte

None.
FloorArea

decimal number

None.
DisplayOrder

integer

None.

application/json, text/json
Sample: 
[
  {
    "propertyID": 1,
    "id": 1,
    "description": "sample string 1",
    "fullDescription": "sample string 2",
    "width": 1.0,
    "widthSuffix": 64,
    "length": 1.0,
    "lengthSuffix": 64,
    "floorArea": 1.0,
    "displayOrder": 1
  },
  {
    "propertyID": 1,
    "id": 1,
    "description": "sample string 1",
    "fullDescription": "sample string 2",
    "width": 1.0,
    "widthSuffix": 64,
    "length": 1.0,
    "lengthSuffix": 64,
    "floorArea": 1.0,
    "displayOrder": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPropertyRoomsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyRoomsUpdate>
    <PropertyID>1</PropertyID>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <FullDescription>sample string 2</FullDescription>
    <Width>1</Width>
    <WidthSuffix>64</WidthSuffix>
    <Length>1</Length>
    <LengthSuffix>64</LengthSuffix>
    <FloorArea>1</FloorArea>
    <DisplayOrder>1</DisplayOrder>
  </PropertyRoomsUpdate>
  <PropertyRoomsUpdate>
    <PropertyID>1</PropertyID>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <FullDescription>sample string 2</FullDescription>
    <Width>1</Width>
    <WidthSuffix>64</WidthSuffix>
    <Length>1</Length>
    <LengthSuffix>64</LengthSuffix>
    <FloorArea>1</FloorArea>
    <DisplayOrder>1</DisplayOrder>
  </PropertyRoomsUpdate>
</ArrayOfPropertyRoomsUpdate>