Breeding Lot Information

The GetBreedingLotInfo endpoint returns breeding lot information in the MIMS system.

---

How to query a Breeding Lot

HTTP POST Request

Request Type	Example URL
POST	{{url_base}}/GetBreedingLotInfo
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetBreedingLotInfo"

Input Parameters

Parameter	Type	Required	Description
LotNo	String(25)	Yes	External code of the breeding lot
FarmNo	String(25)	Yes	External code of the property

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
BreedingLotInfo	GetBreedingLotInfoReturn	Yes	Object containing breeding lot information

📝 GetBreedingLotInfoReturn Object

The GetBreedingLotInfoReturn object represents a list of breeding lot information

Return Parameters

Parameter	Type	Required	Description
BreedingLotCode	Integer	Yes	Internal code of the breeding lot
BreedingLotNo	String(25)	Yes	External code of the breeding lot
ComposedLot	String(80)	Yes	Composed lot
AnimalLineageNo	String(25)	Yes	External code of the animal lineage
FarmNo	String(25)	Yes	External code of the property
AnimalMaterialNo	String(25)	Yes	External code of the animal material
ShedNumber	String(10)	Yes	Shed number
BoxNumber	String(10)	Yes	Box number (pen.)
InitialSeal	Integer	Yes	Initial seal
FinalSeal	Integer	Yes	Final seal
CurrentSeal	Boolean	Yes	Current seal
HousingDate	DataHora	Yes	Housing date
DocumentNumber	String(25)	Yes	Document number
FarmDeadAnimalsQty	Integer	Yes	Quantity of dead animals in the field
AnimalsFeedConversion	Integer	Yes	Feed conversion
AnimalsDailyWgtGain	Integer	Yes	Daily weight gain
HousedAnimalsQty	Integer	Yes	Quantity of housed animals
AnimalSexType	AnimalSexType	Yes	Enumerator with possible values for the animal sex type: astMixed (Mixed), astFemale (Female) or astMale (Male)
PostRemunarationData	Boolean	Yes	Flag indicating if remuneration is posted
ActiveLot	Boolean	Yes	Flag indicating if the breeding lot is active
ShedList	GetShedItemInfoList	Yes	List of sheds linked to the breeding lot

📝 GetShedItemInfoList Object

The GetShedItemInfoList object represents a List of sheds linked to the breeding lot

Return Parameters

Parameter	Type	Required	Description
ShedName	String(40)	Yes	Shed description
AnimalBornDate	DataHora	Yes	Animal birth date
AnimalSexType	AnimalSexType	Yes	Enumerator with possible values for the animal sex type: astMixed (Mixed), astFemale (Female) or astMale (Male)

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetBreedingLotInfo"' \
--header 'Content-Type: application/json' \
--data '{
    "LotNo": "18",
    "FarmNo": "122907"
}'

---

Response Example

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "BreedingLotInfo": {
        "BreedingLotCode": 269,
        "BreedingLotNo": "18",
        "ComposedLot": "122907-18",
        "AnimalLineageNo": "1",
        "AnimalSexType": "astMale",
        "FarmNo": "122907",
        "AnimalMaterialNo": "MAT125",
        "ShedNumber": "",
        "BoxNumber": "",
        "ActiveLot": true,
        "InitialSeal": 0,
        "FinalSeal": 0,
        "CurrentSeal": false,
        "HousingDate": "2025-06-05",
        "DocumentNumber": "",
        "FarmDeadAnimalsQty": 0,
        "AnimalsFeedConversion": 0,
        "AnimalsDailyWgtGain": 0,
        "HousedAnimalsQty": 0,
        "PostRemunarationData": false,
        "ShedList": [
            {
                "ShedName": "1",
                "AnimalSexType": "astMale",
                "AnimalBornDate": "2025-06-17"
            }
        ]
    }
}

---

🐞 Possible Errors

Code	Message
GBL‑001	There is no breeding lot ([value sent in request]) registered for the informed property ([value sent in request])!
GBL‑002	The informed Lot (LotNo) was not found!

---