Herds Web Service
MethodHerdsCreate
Description
This method allows a user to create a new CoreOne Herd by entering in the relevant information.
Request (HerdsCreate)

Below are the parameters to successfully create a 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
herdThese are the input parameters necessary for a successful creation of a Herd.ws_herd_c
herd_usage

This is an array of CoreOne herd usage ids found in the Lookups table. More than one herd usage can be entered at a time.

These can be retrieved through using the Lookups table searching for "HerdUsage"

xml:int
Response (HerdsCreate_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 created a message "Create Successful." will be returned. If however the herd was not successfully created a message "Create 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.