Web Service Documentation / Categories / Property Use Services / Edit Property Use

Edit Property Use

Updated on July 17, 2013

Description

This web service updates a specific property use under a given property based on the information provided in the XML request. Only the name of the property use can be updated with this web service. It returns the unique identifier to the property use and a link to the corresponding web service to retrieve it. The corresponding property must already be shared with you.

Version

23.0

HTTP Method

PUT

Resource URL

/propertyUse/(propertyUseId)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
propertyUseId Id of the property use

XML Schemas

Request/Response Schema Name
Request propertyUse.xsd
Response response.xsd

Example Request

The following example updates a property use that has an id of 14.

PUT  /propertyUse/14

<?xml version="1.0" encoding="UTF-8"?>
<propertyUse>
    <name>Broadway K-12 School</name>
</propertyUse>

Example Response

The following example indicates that the space was successfully created. The response also includes the new space id of 14 and a link to web service to retrieve the space.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>14</id>
    <links>
        <link httpMethod="GET" link="/propertyUse/14" linkDescription="This is the GET url for this property use."/>
    </links>
</response>
TEST