POST applications/{appId}/realproperty/studyareas

Request Information

URI Parameters

NameDescriptionTypeAdditional information
appId

string

Required

Body Parameters

RPStudyAreaType
NameDescriptionTypeAdditional information
type

string

None.

search_phrase

string

None.

Request Formats

application/json, text/json

Sample:
{
  "type": "sample string 1",
  "search_phrase": "sample string 2"
}

multipart/form-data

Sample:
{"type":"sample string 1","search_phrase":"sample string 2"}

application/xml, text/xml

Sample:
<RPStudyAreaType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.RealPropertyScenarios">
  <SearchPhrase>sample string 2</SearchPhrase>
  <Type>sample string 1</Type>
</RPStudyAreaType>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RPStudyAreaData
NameDescriptionTypeAdditional information
study_areas

Collection of RPStudyArea

None.

Response Formats

application/json, text/json

Sample:
{
  "study_areas": [
    {
      "study_area_id": "sample string 1",
      "name": "sample string 2"
    },
    {
      "study_area_id": "sample string 1",
      "name": "sample string 2"
    }
  ]
}

multipart/form-data

Sample:
{"study_areas":[{"study_area_id":"sample string 1","name":"sample string 2"},{"study_area_id":"sample string 1","name":"sample string 2"}]}

application/xml, text/xml

Sample:
<RPStudyAreaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.RealPropertyScenarios">
  <StudyAreas>
    <RPStudyArea>
      <Name>sample string 2</Name>
      <StudyAreaID>sample string 1</StudyAreaID>
    </RPStudyArea>
    <RPStudyArea>
      <Name>sample string 2</Name>
      <StudyAreaID>sample string 1</StudyAreaID>
    </RPStudyArea>
  </StudyAreas>
</RPStudyAreaData>