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 Type | Example URL |
|---|---|
| POST | {{url_base}}/PostAddAnimalLineage |
| Example | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddAnimalLineage" |
Input Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| AnimalLineageNo | String(20) | Yes | External code of the Lineage |
| Name | String(40) | Yes | Lineage description |
| OverwriteIfExists | Boolean | No | Flag indicating that data should be overwritten if the record already exists |
Return
| Parameter | Type | Required | Description |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Yes | Standard WebService response information in method execution |
| AnimalLineageCode | Integer | Yes | Internal 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
| Code | Message |
|---|---|
| AAL‑001 | The provided External Lineage Code parameter (AnimalLineageNo) already exists! |