Description
This method allows the user to edit attributes for a specified CoreOne Premises.
Request (HoldingsEdit)
Below are the parameters to successfully update a specified CoreOne Premises. If any required parameter is omitted an error message will be displayed alerting the user.
Request Body Parameters
| Name | Description | Data Type | ||
|---|---|---|---|---|
| token | This is a 40-character hexadecimal string.
| xml:string | ||
| id | This is an internal CoreOne Holding id. This is the premises the user wishes to update.
| xml:int | ||
| holding | These are the premises input parameters necessary for a successful edit of a Premises. | ws_holding_c | ||
| holding_species | This is an array of CoreOne Species id. These are the species that are in the premises. | xml:int |
Response (HoldingsEdit_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
| Name | Description | Data Type |
|---|---|---|
| status | If the Premises was successfully updated a message "Update successful." will be returned. If however the Premises was not successfully updated a message "Update Failed." will be returned. | xml:string |
Remarks
|
All data elements within the record will be updated and overwritten. Therefore any input fields left blank will overwrite any data present. |
See Also