Description
This method allows the user to create a CoreOne Restriction at a herd level.
Request (RestrictionsCreateHerd)
Below are the required parameters to successfully create a CoreOne Restriction at a herd level. If any 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 Herd id. It is the herd the user wishes to create the restriction from.
| xml:int | ||
| master_restriction | These are the input parameters necessary for a successful creation of a Restriction. | ws_master_restriction_c | ||
| herd_options | These are options to declare the scope/extent of the created restriction. | herd_options |
Response (RestrictionsCreateHerd_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 creation of a restriction was successful a message "Create successful." will be returned. If the creation of a restriction was not successful a message "Create Failed." will be returned. | xml:string |
Remarks
See Also