Holdings Web Service
MethodHoldingsChangeOwner
Description
This method allows the user to update the current owner for a specified CoreOne Premises.
Request (HoldingsChangeOwner)

Below are the required parameters to successfully change the owner of a CoreOne Premises. If any required parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
xml:string
id

This is an internal CoreOne Holding id. This is the premises the user wishes to change the current owner.

These can be retrieved through using the HoldingsIndex (Method).
xml:int
owner_id

This is an internal CoreOne Person id. This is the new owner for the specified premises.

These can be retrieved through using the PeopleIndex (Method).
xml:int
Response (HoldingsChangeOwner_response)

This is the returned status message to tell the user the result of the method.

An error message will be displayed instead of the status message if any of the input parameters fail any validation rule. For example if the user's token is invalid or the record doesn't exist. It will alert the user on what parameter failed validation and the reason why.

Response Body Parameters

NameDescriptionData Type
statusIf the owner of the premises was successfully updated a message "Update successful." will be returned. If however the owner of the premises was not successfully updated a message "Update Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupHoldings Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.