HerdsChangeOwner (Method)

Description

This method allows the user to update the current owner for a specified CoreOne Herd.

Request (HerdsChangeOwner)

Below are the required parameters to successfully change the owner of a CoreOne Herd. 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.

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

This is an internal CoreOne Herd id. This is the herd that the user wishes to update.

These can be retrieved through using the HerdsIndex (Method).

xml:int

owner_id

This is an internal CoreOne Person id. This is the new ID of the owner for the specified herd.

These can be retrieved through using the PeopleIndex (Method).

xml:int

Response (HerdsChangeOwner_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 herd was successfully updated a message "Update successful." will be returned. If however the herd was not successfully updated a message "Update Failed." will be returned.	xml:string

Remarks