Controls

Set gb control

Set gb control. This method will set the value of a gb control to the data provided in the JSON payload.

PUT

/gb/controls/{module}/{name}/{effective_from}

Set gb control

curl --request PUT \
  --url https://api.catch-e.com/gb/controls/{module}/{name}/{effective_from} \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "encrypted_flag": "no",
  "override_warnings_flag": "no",
  "super_flag": "no",
  "value": "<any>"
}
'

{
  "effective_from": "0000-00-00",
  "encrypted_flag": "no",
  "module": "gb",
  "name": "becs_details",
  "super_flag": "no",
  "value": {
    "aba_file_description": "BECSPAYMENT",
    "company_name_short": "DemoBecs",
    "identification_number": "999999",
    "user_credits_only": "no"
  }
}

This method requires the GbControls:Update permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

moduleenum<string>required

Available options: gb, fm, qt, gl, sl, pl, qq, sp, bk

namestringrequired

effective_fromstringdefault:0000-00-00required

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

JSON payload

encrypted_flagenum<string>default:no

Should the gb control value be encrypted?

Available options: no, yes

override_warnings_flagenum<string>

Override warning validation. If not specified, defaults to 'no'

Available options: yes, no

Example: no

super_flagenum<string>default:no

Should the gb control value be restricted to super users?

Available options: no, yes

valueany

Response

Success

effective_fromstring

encrypted_flagenum<string>default:no

Available options: no, yes

moduleenum<string>

Available options: gb, fm, qt, gl, sl, pl, qq, sp, bk

namestring

Maximum string length: 255

super_flagenum<string>default:no

Available options: no, yes

valueany

Still need help? Ask the team