Catch Crew
The PostAddCatchCrew endpoint is responsible for registering a new catch crew in the MIMS system and can be viewed on screen CAD301.
How to register a catch crew
HTTP POST Request
| Request Type | Example URL |
|---|---|
| POST | {{url_base}}/PostAddCatchCrew |
| Example | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCatchCrew" |
Input Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| CatchCrewNo | String(25) | Yes | External code of the Catch Crew |
| Name | String(60) | Yes | Catch Crew name |
| ResponsibleName | String(60) | No | Name of the person responsible for the Catch Crew |
| ResponsibleEmail | String(60) | No | Email of the person responsible for the Catch Crew |
| 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 |
| CatchCrewCode | Integer | Yes | Internal catch crew code generated in the MIMS system |
Request Example
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCatchCrew"' \
--header 'Content-Type: application/json' \
--data-raw '{
"CatchCrewNo": "EQUI123",
"Name": "Equipe Apanha Teste",
"ResponsibleName": "Carlos Silva",
"ResponsibleEmail": "carlos.silva@gmail.com",
"OverwriteIfExists": true
}'
Response Example
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"CatchCrewCode": 12
}
🐞 Possible Errors
| Code | Message |
|---|---|
| ACC‑001 | The provided External Catch Crew Code parameter (CatchCrewNo) already exists! |