Skip to main content

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 TypeExample URL
POST{{url_base}}/PostAddCatchCrew
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCatchCrew"

Input Parameters

ParameterTypeRequiredDescription
CatchCrewNoString(25)YesExternal code of the Catch Crew
NameString(60)YesCatch Crew name
ResponsibleNameString(60)NoName of the person responsible for the Catch Crew
ResponsibleEmailString(60)NoEmail of the person responsible for the Catch Crew
OverwriteIfExistsBooleanNoFlag indicating that data should be overwritten if the record already exists

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
CatchCrewCodeIntegerYesInternal 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

CodeMessage
ACC‑001The provided External Catch Crew Code parameter (CatchCrewNo) already exists!