PUT api/CUSTODIANS/{id}?foreigns={foreigns}

Update a single CUSTODIANS record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Obligatory. The CUSTODIAN_ID value of the record passed that need to be updated

integer

Required

foreigns

Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply

boolean

Default value is False

Body Parameters

Obligatory. The new updated CUSTODIANS object that need to be updated

CUSTODIANS
NameDescriptionTypeAdditional information
CUSTODIAN_ID

integer

None.

CUSTODIAN_NAME

string

Required

String length: inclusive between 0 and 100

CUSTODIAN_TYPE

0=> parent/notify receiver, 1=> bus driver/notify sender

byte

None.

LOGIN_NAME

string

Required

String length: inclusive between 0 and 20

LOGIN_PASSWORD

string

Required

String length: inclusive between 0 and 50

ACTIVE

boolean

None.

NOTES

string

String length: inclusive between 0 and 500

LAST_NOTIFY_DELETE

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ACTIVE": true,
  "CUSTODIAN_TYPE": 64,
  "CUSTODIAN_ID": 1,
  "LAST_NOTIFY_DELETE": "2025-12-07T09:10:20.5952425Z",
  "NOTES": "sample string 7",
  "LOGIN_PASSWORD": "sample string 5",
  "LOGIN_NAME": "sample string 4",
  "CUSTODIAN_NAME": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CUSTODIANS_CMD_RESPONSE
NameDescriptionTypeAdditional information
Status

Status

None.

DATA

Collection of CUSTODIANS

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": {
    "Success": true,
    "Code": "0",
    "DetailedMessage": "sample string 3",
    "Message": "sample string 2"
  },
  "DATA": [
    {
      "ACTIVE": true,
      "CUSTODIAN_TYPE": 64,
      "CUSTODIAN_ID": 1,
      "LAST_NOTIFY_DELETE": "2025-12-07T09:10:20.6001312Z",
      "NOTES": "sample string 7",
      "LOGIN_PASSWORD": "sample string 5",
      "LOGIN_NAME": "sample string 4",
      "CUSTODIAN_NAME": "sample string 2"
    },
    {
      "ACTIVE": true,
      "CUSTODIAN_TYPE": 64,
      "CUSTODIAN_ID": 1,
      "LAST_NOTIFY_DELETE": "2025-12-07T09:10:20.6001312Z",
      "NOTES": "sample string 7",
      "LOGIN_PASSWORD": "sample string 5",
      "LOGIN_NAME": "sample string 4",
      "CUSTODIAN_NAME": "sample string 2"
    }
  ]
}