Skip to main content

Breeding Lot

The PostAddBreedingLot endpoint is responsible for registering a new breeding lot in the MIMS system. This registration can be viewed on screen CAD345.


How to register a breeding lot

HTTP POST Request

Request TypeExample URL
POST{{url_base}}/PostAddBreedingLot
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddBreedingLot"

Input Parameters

ParameterTypeRequiredDescription
LotNoString(25)YesExternal code of the breeding lot
FarmNoString(25)YesExternal code of the property
AnimalMaterialNoString(25)YesExternal code of the animal material
AnimalLineageNoString(25)YesExternal code of the animal lineage
ShedQtyIntegerNoQuantity of sheds associated with the lot
AnimalSexTypeAnimalSexTypeYesEnumerator with possible values for Animal Sex Type: astMixed (Mixed), astFemale (Female) or astMale (Male)

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
BreedingLotCodeIntegerYesInternal breeding lot code generated in the MIMS system

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddBreedingLot"' \
--header 'Content-Type: application/json' \
--data '{
"LotNo": "L12345",
"FarmNo": "FARM001",
"AnimalMaterialNo": "MAT125",
"AnimalLineageNo": "LIN1",
"ShedQty": 1,
"AnimalSexType": "astMixed"
}'

Response Example

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"BreedingLotCode": 101
}

🐞 Possible Errors

CodeMessage
BLE‑001The provided Lot parameter (LotNo) already exists!
BLE‑002The provided "AnimalLineageNo" ([value sent in request]) is not linked to the Animal Type of the provided "AnimalMaterialNo" ([value sent in request])!