Skip to main content

Animal Lineage

The PostAddAnimalLineage endpoint is responsible for registering a new lineage in the MIMS system. This registration can be viewed on screen CAD060.


How to register a lineage​

HTTP POST Request

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

Input Parameters​

ParameterTypeRequiredDescription
AnimalLineageNoString(20)YesExternal code of the Lineage
NameString(40)YesLineage description
OverwriteIfExistsBooleanNoFlag indicating that data should be overwritten if the record already exists

Return​

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
AnimalLineageCodeIntegerYesInternal Lineage code generated in the MIMS system

Request Example​

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddAnimalLineage"' \
--header 'Content-Type: application/json' \
--data '{
"AnimalLineageNo": "L001",
"Name": "Linhagem Exemplo",
"OverwriteIfExists": true
}'

Response Example​

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

🐞 Possible Errors​

CodeMessage
AAL‑001The provided External Lineage Code parameter (AnimalLineageNo) already exists!