PATCH applications/{appId}/realproperty/scenarios/{scenarioId}

Request Information

URI Parameters

Name	Description	Type	Additional information
appId		string	Required
scenarioId		string	Required

Body Parameters

RPScenarioUpdateData

Name	Description	Type	Additional information
name		string	None.
study_area_key		string	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "study_area_key": "sample string 2"
}

multipart/form-data

Sample:

{"name":"sample string 1","study_area_key":"sample string 2"}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RPScenarioDetails

Name	Type	Additional information
id	globally unique identifier	None.
name	string	None.
study_area_type	string	None.
study_area	string	None.
created	integer	None.
created_by	string	None.
updated	integer	None.
updated_by	string	None.
property_count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "7e447896-1f22-4d7c-a5dc-f660c0a5c2c7",
  "name": "sample string 2",
  "study_area_type": "sample string 3",
  "study_area": "sample string 4",
  "created": 5,
  "created_by": "sample string 6",
  "updated": 7,
  "updated_by": "sample string 8",
  "property_count": 9
}

multipart/form-data

Sample:

{"id":"7e447896-1f22-4d7c-a5dc-f660c0a5c2c7","name":"sample string 2","study_area_type":"sample string 3","study_area":"sample string 4","created":5,"created_by":"sample string 6","updated":7,"updated_by":"sample string 8","property_count":9}

application/xml, text/xml

Sample:

<RPScenarioDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.RealPropertyScenarios">
  <Created>5</Created>
  <CreatedBy>sample string 6</CreatedBy>
  <Id>7e447896-1f22-4d7c-a5dc-f660c0a5c2c7</Id>
  <Name>sample string 2</Name>
  <PropertyCount>9</PropertyCount>
  <StudyArea>sample string 4</StudyArea>
  <StudyAreaType>sample string 3</StudyAreaType>
  <Updated>7</Updated>
  <UpdatedBy>sample string 8</UpdatedBy>
</RPScenarioDetails>