Catch Supervisor

The PostAddCatchSupervisor endpoint is responsible for registering a new Catch Supervisor in the MIMS system. This registration can be viewed on screen CAD398.

---

How to register a catch supervisor

HTTP POST Request

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

Input Parameters

Parameter	Type	Required	Description
CatchSupervisorNo	String(25)	Yes	External code of the catch supervisor
Name	String(60)	Yes	Catch supervisor name
Email	String(60)	No	Catch supervisor email
Active	Boolean	Yes	Flag indicating that the Supervisor is active (true = active, false = inactive)
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
CatchSupervisorCode	Integer	Yes	Internal Catch Supervisor code generated in the MIMS system

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCatchSupervisor"' \
--header 'Content-Type: application/json' \
--data-raw '{
    "CatchSupervisorNo": "SUP001",
    "Name": "João Silva",
    "Email": "joao.silva@gmail.com",
    "Active": true,
    "OverwriteIfExists": true
}'

---

Response Example

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

---

🐞 Possible Errors

Code	Message
ACP‑001	The provided External Catch Supervisor Code parameter (CatchSupervisorNo) already exists!

---