Herds Web Service
MethodHerdsChangeHerdManager
Description
This method allows the user to update the current herd manager for a specified CoreOne Herd.
Request (HerdsChangeHerdManager)

Below are the required parameters to successfully change the herd manager of a specified CoreOne Herd. 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 Herd id. This is the herd that the user wishes to update.

These can be retrieved through using the HerdsIndex (Method).
xml:int
keeper_id

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

These can be retrieved through using the PeopleIndex (Method).
xml:int
Response (HerdsChangeHerdManager_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 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

See Also
All Operations Resource GroupHerds Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.