AnimalsRegisterBirth (Method)

Description

This method allows a user to record a birth event for a CoreOne Animal by entering in the relevant information.

Request (AnimalsRegisterBirth)

Below are the required parameters to successfully register the birth of a CoreOne Animal. 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 Animal id. This is the animal in which the user wishes to register a birth event.

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

xml:int

Response (AnimalsRegisterBirth_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 animal birth was successfully registered a message "Register Successful." will be returned. If however the animal birth event was not successfully registered a message "Record Failed." will be returned.	xml:string

Remarks