GET api/FlipKey/GetProperty?property_id={property_id}

Request Information

URI Parameters

Name	Description	Type	Additional information
property_id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Property

Name	Type	Additional information
PropertyName	string	None.
Address	AddressType	None.
Details	DetailsType	None.
Descriptions	DescriptionsType	None.
Suitability	SuitabilityType	None.
Amenities	Collection of AmenitiesTypeAmenity	None.
Photos	PhotosType	None.
Rates	RatesType	None.
Fees	FeesType	None.
property_id	string	None.
last_update	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PropertyName": "sample string 1",
  "Address": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "ZipCode": "sample string 5",
    "Country": "sample string 6",
    "Latitude": 7.1,
    "LatitudeSpecified": true,
    "Longitude": 9.1,
    "LongitudeSpecified": true
  },
  "Details": {
    "MaximumOccupancy": 1,
    "MaximumOccupancySpecified": true,
    "PropertyType": {
      "type": 0,
      "typeSpecified": true
    },
    "Bedrooms": {
      "Bedroom": [
        {
          "king": 1,
          "kingSpecified": true,
          "queen": 3,
          "queenSpecified": true,
          "full": 5,
          "fullSpecified": true,
          "twin": 7,
          "twinSpecified": true,
          "bunk": 9,
          "bunkSpecified": true,
          "other": 11,
          "otherSpecified": true
        },
        {
          "king": 1,
          "kingSpecified": true,
          "queen": 3,
          "queenSpecified": true,
          "full": 5,
          "fullSpecified": true,
          "twin": 7,
          "twinSpecified": true,
          "bunk": 9,
          "bunkSpecified": true,
          "other": 11,
          "otherSpecified": true
        }
      ],
      "count": 1,
      "countSpecified": true
    },
    "Bathrooms": {
      "Bathroom": [
        {
          "full": 1,
          "fullSpecified": true,
          "half": 3,
          "halfSpecified": true,
          "shower": 5,
          "showerSpecified": true
        },
        {
          "full": 1,
          "fullSpecified": true,
          "half": 3,
          "halfSpecified": true,
          "shower": 5,
          "showerSpecified": true
        }
      ],
      "count": 1,
      "countSpecified": true
    },
    "MinimumStayLength": 3,
    "MinimumStayLengthSpecified": true,
    "CheckIn": "sample string 5",
    "CheckOut": "sample string 6",
    "Currency": "sample string 7",
    "UnitSize": {
      "units": 0,
      "unitsSpecified": true
    }
  },
  "Descriptions": {
    "PropertyDescription": "sample string 1",
    "RateDescription": "sample string 2",
    "LocationDescription": "sample string 3"
  },
  "Suitability": {
    "Pets": {
      "value": "sample string 1"
    },
    "Smoking": {
      "value": "sample string 1"
    },
    "HandicapAccessible": {
      "value": "sample string 1"
    },
    "ElderlyAccessible": {
      "value": "sample string 1"
    },
    "Children": {
      "value": "sample string 1"
    }
  },
  "Amenities": [
    {
      "order": 1,
      "orderSpecified": true,
      "Value": "sample string 3"
    },
    {
      "order": 1,
      "orderSpecified": true,
      "Value": "sample string 3"
    }
  ],
  "Photos": {
    "Photo": [
      {
        "URL": "sample string 1",
        "Description": "sample string 2",
        "order": 3,
        "orderSpecified": true
      },
      {
        "URL": "sample string 1",
        "Description": "sample string 2",
        "order": 3,
        "orderSpecified": true
      }
    ],
    "src_base": "sample string 1"
  },
  "Rates": {
    "Rate": [
      {
        "Label": "sample string 1",
        "StartDate": "2025-12-10T06:04:25.6675745+00:00",
        "StartDateSpecified": true,
        "EndDate": "2025-12-10T06:04:25.6675745+00:00",
        "EndDateSpecified": true,
        "DailyMinRate": 6.0,
        "DailyMinRateSpecified": true,
        "DailyMaxRate": 8.0,
        "DailyMaxRateSpecified": true,
        "DailyWeeknightRate": 10.0,
        "DailyWeeknightRateSpecified": true,
        "DailyWeekendRate": 12.0,
        "DailyWeekendRateSpecified": true,
        "WeeknightMinRate": 14.0,
        "WeeknightMinRateSpecified": true,
        "WeeknightMaxRate": 16.0,
        "WeeknightMaxRateSpecified": true,
        "WeekendMinRate": 18.0,
        "WeekendMinRateSpecified": true,
        "WeekendMaxRate": 20.0,
        "WeekendMaxRateSpecified": true,
        "WeeklyMinRate": 22.0,
        "WeeklyMinRateSpecified": true,
        "WeeklyMaxRate": 24.0,
        "WeeklyMaxRateSpecified": true,
        "MonthlyMinRate": 26.0,
        "MonthlyMinRateSpecified": true,
        "MonthlyMaxRate": 28.0,
        "MonthlyMaxRateSpecified": true,
        "MinimumStayLength": 30,
        "MinimumStayLengthSpecified": true,
        "TurnDay": "sample string 32",
        "WeekendNights": "sample string 33",
        "PerPersonPerNight": "sample string 34",
        "PerPersonPerStay": "sample string 35",
        "FreeGuests": "sample string 36"
      },
      {
        "Label": "sample string 1",
        "StartDate": "2025-12-10T06:04:25.6675745+00:00",
        "StartDateSpecified": true,
        "EndDate": "2025-12-10T06:04:25.6675745+00:00",
        "EndDateSpecified": true,
        "DailyMinRate": 6.0,
        "DailyMinRateSpecified": true,
        "DailyMaxRate": 8.0,
        "DailyMaxRateSpecified": true,
        "DailyWeeknightRate": 10.0,
        "DailyWeeknightRateSpecified": true,
        "DailyWeekendRate": 12.0,
        "DailyWeekendRateSpecified": true,
        "WeeknightMinRate": 14.0,
        "WeeknightMinRateSpecified": true,
        "WeeknightMaxRate": 16.0,
        "WeeknightMaxRateSpecified": true,
        "WeekendMinRate": 18.0,
        "WeekendMinRateSpecified": true,
        "WeekendMaxRate": 20.0,
        "WeekendMaxRateSpecified": true,
        "WeeklyMinRate": 22.0,
        "WeeklyMinRateSpecified": true,
        "WeeklyMaxRate": 24.0,
        "WeeklyMaxRateSpecified": true,
        "MonthlyMinRate": 26.0,
        "MonthlyMinRateSpecified": true,
        "MonthlyMaxRate": 28.0,
        "MonthlyMaxRateSpecified": true,
        "MinimumStayLength": 30,
        "MinimumStayLengthSpecified": true,
        "TurnDay": "sample string 32",
        "WeekendNights": "sample string 33",
        "PerPersonPerNight": "sample string 34",
        "PerPersonPerStay": "sample string 35",
        "FreeGuests": "sample string 36"
      }
    ],
    "DefaultRate": [
      {
        "DailyRate": 1.0,
        "DailyRateSpecified": true,
        "WeeklyRate": 3.0,
        "WeeklyRateSpecified": true,
        "MonthlyRate": 5.0,
        "MonthlyRateSpecified": true,
        "MinimumStayLength": 7,
        "MinimumStayLengthSpecified": true
      },
      {
        "DailyRate": 1.0,
        "DailyRateSpecified": true,
        "WeeklyRate": 3.0,
        "WeeklyRateSpecified": true,
        "MonthlyRate": 5.0,
        "MonthlyRateSpecified": true,
        "MinimumStayLength": 7,
        "MinimumStayLengthSpecified": true
      }
    ]
  },
  "Fees": {
    "Fee": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Cost": {
          "type": 0,
          "typeSpecified": true,
          "Value": "sample string 2"
        },
        "FeeType": {
          "type": 0,
          "typeSpecified": true
        },
        "required": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Cost": {
          "type": 0,
          "typeSpecified": true,
          "Value": "sample string 2"
        },
        "FeeType": {
          "type": 0,
          "typeSpecified": true
        },
        "required": "sample string 3"
      }
    ]
  },
  "property_id": "sample string 2",
  "last_update": "sample string 3"
}

application/xml, text/xml

Sample:

<Property xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" property_id="sample string 2" last_update="sample string 3">
  <PropertyName>sample string 1</PropertyName>
  <Address>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <City>sample string 3</City>
    <State>sample string 4</State>
    <ZipCode>sample string 5</ZipCode>
    <Country>sample string 6</Country>
    <Latitude>7.1</Latitude>
    <Longitude>9.1</Longitude>
  </Address>
  <Details>
    <MaximumOccupancy>1</MaximumOccupancy>
    <PropertyType type="house" />
    <Bedrooms count="1">
      <Bedroom king="1" queen="3" full="5" twin="7" bunk="9" other="11" />
      <Bedroom king="1" queen="3" full="5" twin="7" bunk="9" other="11" />
    </Bedrooms>
    <Bathrooms count="1">
      <Bathroom>
        <BathroomType full="1" half="3" shower="5" />
        <BathroomType full="1" half="3" shower="5" />
      </Bathroom>
    </Bathrooms>
    <MinimumStayLength>3</MinimumStayLength>
    <CheckIn>sample string 5</CheckIn>
    <CheckOut>sample string 6</CheckOut>
    <Currency>sample string 7</Currency>
    <UnitSize units="meters" />
  </Details>
  <Descriptions>
    <PropertyDescription>sample string 1</PropertyDescription>
    <RateDescription>sample string 2</RateDescription>
    <LocationDescription>sample string 3</LocationDescription>
  </Descriptions>
  <Suitability>
    <Pets value="sample string 1" />
    <Smoking value="sample string 1" />
    <HandicapAccessible value="sample string 1" />
    <ElderlyAccessible value="sample string 1" />
    <Children value="sample string 1" />
  </Suitability>
  <Amenities>
    <Amenity order="1">sample string 3</Amenity>
    <Amenity order="1">sample string 3</Amenity>
  </Amenities>
  <Photos src_base="sample string 1">
    <Photo order="3">
      <URL>sample string 1</URL>
      <Description>sample string 2</Description>
    </Photo>
    <Photo order="3">
      <URL>sample string 1</URL>
      <Description>sample string 2</Description>
    </Photo>
  </Photos>
  <Rates>
    <Rate>
      <Label>sample string 1</Label>
      <StartDate>2025-12-10</StartDate>
      <EndDate>2025-12-10</EndDate>
      <DailyMinRate>6</DailyMinRate>
      <DailyMaxRate>8</DailyMaxRate>
      <DailyWeeknightRate>10</DailyWeeknightRate>
      <DailyWeekendRate>12</DailyWeekendRate>
      <WeeknightMinRate>14</WeeknightMinRate>
      <WeeknightMaxRate>16</WeeknightMaxRate>
      <WeekendMinRate>18</WeekendMinRate>
      <WeekendMaxRate>20</WeekendMaxRate>
      <WeeklyMinRate>22</WeeklyMinRate>
      <WeeklyMaxRate>24</WeeklyMaxRate>
      <MonthlyMinRate>26</MonthlyMinRate>
      <MonthlyMaxRate>28</MonthlyMaxRate>
      <MinimumStayLength>30</MinimumStayLength>
      <TurnDay>sample string 32</TurnDay>
      <WeekendNights>sample string 33</WeekendNights>
      <PerPersonPerNight>sample string 34</PerPersonPerNight>
      <PerPersonPerStay>sample string 35</PerPersonPerStay>
      <FreeGuests>sample string 36</FreeGuests>
    </Rate>
    <Rate>
      <Label>sample string 1</Label>
      <StartDate>2025-12-10</StartDate>
      <EndDate>2025-12-10</EndDate>
      <DailyMinRate>6</DailyMinRate>
      <DailyMaxRate>8</DailyMaxRate>
      <DailyWeeknightRate>10</DailyWeeknightRate>
      <DailyWeekendRate>12</DailyWeekendRate>
      <WeeknightMinRate>14</WeeknightMinRate>
      <WeeknightMaxRate>16</WeeknightMaxRate>
      <WeekendMinRate>18</WeekendMinRate>
      <WeekendMaxRate>20</WeekendMaxRate>
      <WeeklyMinRate>22</WeeklyMinRate>
      <WeeklyMaxRate>24</WeeklyMaxRate>
      <MonthlyMinRate>26</MonthlyMinRate>
      <MonthlyMaxRate>28</MonthlyMaxRate>
      <MinimumStayLength>30</MinimumStayLength>
      <TurnDay>sample string 32</TurnDay>
      <WeekendNights>sample string 33</WeekendNights>
      <PerPersonPerNight>sample string 34</PerPersonPerNight>
      <PerPersonPerStay>sample string 35</PerPersonPerStay>
      <FreeGuests>sample string 36</FreeGuests>
    </Rate>
    <DefaultRate>
      <DailyRate>1</DailyRate>
      <WeeklyRate>3</WeeklyRate>
      <MonthlyRate>5</MonthlyRate>
      <MinimumStayLength>7</MinimumStayLength>
    </DefaultRate>
    <DefaultRate>
      <DailyRate>1</DailyRate>
      <WeeklyRate>3</WeeklyRate>
      <MonthlyRate>5</MonthlyRate>
      <MinimumStayLength>7</MinimumStayLength>
    </DefaultRate>
  </Rates>
  <Fees>
    <Fee required="sample string 3">
      <Name>sample string 1</Name>
      <Description>sample string 2</Description>
      <Cost type="Flat">sample string 2</Cost>
      <FeeType type="tax" />
    </Fee>
    <Fee required="sample string 3">
      <Name>sample string 1</Name>
      <Description>sample string 2</Description>
      <Cost type="Flat">sample string 2</Cost>
      <FeeType type="tax" />
    </Fee>
  </Fees>
</Property>