Entry Weighing

---

Entry Weighing Registration

The PostAnimalReceiving endpoint is responsible for registering a new entry weighing (animal receiving) in the MIMS system and can be viewed on screen BLR008.

---

How to register an entry weighing

HTTP POST Request

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

Input Parameters

Parameter	Type	Required	Description
ReceivingNo	String(25)	Yes	External code of the live animal receiving
BranchNo	String(25)	Yes	External code of the branch
AnimalWeighingOrderNo	String(25)	Yes	External code of the weighing order
LotNo	String(25)	No	Poultry lot
ReceivingDate	DataHora	Yes	Truck entry date
VehiclePlateNo	String(10)	No	Vehicle plate
VehicleComplementyPlateNo	String(10)	No	Vehicle complementary plate
SupplierNo	String(25)	No	External code of the integrated (supplier)
FarmNo	String(25)	No	External code of the property
AnimalLineageNo	String(25)	No	External code of the lineage
TransporterNo	String(25)	No	External code of the transporter
DriverNo	String(25)	No	External code of the driver
AnimalMaterialNo	String(25)	No	External code of the animal material
CatchMethodNo	String(25)	No	External code of the catch method
CatchCrewNo	String(25)	No	External code of the catch crew
SecondCatchCrewNo	String(25)	No	External code of the second catch crew
AnimalQty	Integer	Yes	Quantity of animal heads in load
VehicleGrossWeight	Float	Yes	Truck gross weight
CageQty	Integer	No	Cage quantity
AnimalAge	Integer	No	Live animal age in days
Notes	String(200)	No	Animal receiving notes
AnimalSexType	AnimalSexType	No	Enumerator with possible values for Animal Sex: asNotAssigned (Not Assigned), astMixed (Mixed), astFemale (Female) or astMale (Male)
LeavingFarmDate	DataHora	No	Date/time when the truck left the integrated
SlaughterDate	DataHora	No	Slaughter date/time
CatchStartDate	DataHora	No	Catch start date/time
CatchEndDate	DataHora	No	Catch end date/time
InvoiceNumber	Integer	No	Animal receiving invoice number
GtaNumber	Integer	No	GTA code
GtaSeries	String(25)	No	GTA series number
ShedList	ShedItemList	No	List of sheds

📝 ShedList Object

The ShedList object represents an item in the list of sheds associated with an animal receiving in the MIMS system.

Input Parameters

Parameter	Type	Required	Description
ShedNo	String(15)	No	External code of the shed
AnimalQty	Integer	Yes	Quantity of animal heads in the shed
FoodRemovalDate	DataHora	No	Food removal date/time

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
ReceivingCode	Integer	Yes	Internal animal receiving code generated in the MIMS system

---

Request Example

curl --location --request POST '{{url_base}}/PostAnimalReceiving' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "ReceivingNo": "REC001",
    "BranchNo": "101",
    "AnimalWeighingOrderNo": "REC001234",
    "LotNo": "150481-222",
    "DocumentNo": "1234",
    "ReceivingDate": "2024-02-07T08:00:00",
    "VehiclePlateNo": "ABC1234",
    "VehicleComplementyPlateNo": "XYZ5678",
    "SupplierNo": "F12345",
    "FarmNo": "1",
    "AnimalLineageNo": "LIN001",
    "TransporterNo": "TRP001",
    "DriverNo": "DRV001",
    "AnimalMaterialNo": "MAT001",
    "AnimalQty": 1000,
    "VehicleGrossWeight": 15000.5,
    "CageQty": 50,
    "AnimalAge": 45,
    "Notes": "Recebimento sem intercorrências.",
    "CatchMethodNo": "CM001",
    "CatchCrewNo": "CC001",
    "AnimalSexType": "astMixed",
    "LeavingFarmDate": "2024-02-07T04:30:00",
    "SlaughterDate": "2024-02-07T12:00:00",
    "ItemList": [
        {
            "MaterialNo": "1000",
            "Qty": 500
        },
        {
            "MaterialNo": "1001",
            "Qty": 500
        }
    ]
}

---

Response Example

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "ReceivingCode": 98765
}

---

🐞 Possible Errors

Code	Message
AAR‑001	The provided External Live Animal Receiving Code parameter (ReceivingNo) already exists!
AAR‑002	External Supplier Code parameter (SupplierNo) belongs to a supplier that is not of type "Integrated". Operation not allowed!
AAR‑003	External Transporter Code parameter (TransporterNo) belongs to a supplier that is not of type "Transporter". Operation not allowed!
AAR‑004	The status of the informed "AnimalWeighingOrderNo" ("[value sent in request]") does not allow a Receiving. Operation not allowed!

Entry Weighing Deletion

The PostDeleteAnimalReceiving endpoint is responsible for executing the deletion of an entry weighing in the MIMS system.

---

How to delete an entry weighing

HTTP POST Request

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

Input Parameters

Parameter	Type	Required	Description
ReceivingNo	String(25)	Yes	External code of the animal receiving
ErrorIfNotFound	Boolean	No	Returns error if the informed animal receiving does not exist in the database

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution

---

Request Example

curl --location --request POST '{{url_base}}/PostDeleteAnimalReceiving' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "ReceivingNo": "12345",
    "ErrorIfNotFound": true
}'

---

Response Example

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

---