1.5.12 Trustee

Event notification for amendment in trustee relationship of the party.

Trustee Relationship event is published during an amendment process through.

• User Interface (PUT API)
• PUT API Request
• PATCH API Request

Table 1-69 Data Segment

Data Segment Code	Data Segment Name	Topic Name	Party Type
DS0108	TRUSTEE_REL	obpySmbAmendTrusteeRel	SMB

Event for PUT API

The PUT API method, an HTTP request method, is utilized for updating the entire Data Segment of customer information. PUT method replaces the entire Data Segment with the new data provided in the request.

Using the PUT API method for amendments, event publishing will not be contingent on the information provided in the request and will include all the attributes of the data segment.

Note:

For PUT API Request “httpMethod” is populated as “PUT”.

Event Payload

{
    "applicationNumber": "SBAT17157581812",
    "branchCode": "100006",
    "userId": "USER1",
    "partyId": "PTY00001",
    "externalCustomerId": "PTY00001",
    "partyType": "S",
    "eventType": "AMEND",
    "handoffStatus": "SUCCESS",
    "sourceProductId": "OBPY",
    "datasegmentCode": "DS0108",
    "datasegmentName": "TRUSTEE_REL",
    "httpMethod": "PUT",
    "amendPayload": "{\"recordId\":\"1346036152394772481\",\"parentId\":\"1346036138259968001\",\"partyId\":\"PTY00001\",\"versionNo\":2,\"recordStat\":\"O\",\"createdBy\":\"USER1\",\"createdDate\":\"2021-01-20T02:26:56\",\"updatedBy\":\"USER1\",\"updatedDate\":\"2021-01-20T02:27:21\",\"trusteeDetailsList\":[{\"id\":\"1346036212457205761\",\"parentId\":\"1346036152394772481\",\"associatePartyId\":\"PTY00002\",\"relationshipType\":\"TST\",\"versionNo\":1,\"recordStat\":\"O\",\"createdBy\":\"USER1\",\"createdDate\":\"2021-01-20T02:27:21\",\"updatedBy\":\"USER1\",\"updatedDate\":\"2021-01-20T02:27:21\"}],\"links\":[]}",
    "amendDateTime": "2025-03-03T08:27:32.732730",
    "applicationDate": "2021-01-20"
}

Event for PATCH API

The PATCH API method, an HTTP request method, is utilized for record and field-level modifications within a Data Segment of customer information, rather than updating the entire Data Segment Information.

Using PATCH API method for amendments, event publishing will be contingent on the information provided in the request and will solely include the attributes that have been modified. Through PATCH API method specific records can be added, updated, or deleted. During record update specific fields can be added, updated, or removed by specifying the attributes requiring modification.

Structure of the Event generated through PATCH API

The Event body is divided into the following key sections:

• "op": Defines the applicable operation to identify the nature of the action as
  • Update of existing record ("op": "replace"): Update of specific fields in an existing record.
  • New record ("op": "add"): New record added to the data segment.
  • Delete of existing Record ("op": "remove"): Delete of an existing record from the data segment.
• "param": A combination of Party ID and Associated Party ID to identify unique identifier trustee relationship records.
• "values": Contains the attributes that are modified within the uniquely identified record.

Note:

For PATCH API Request “httpMethod” is populated as “PATCH”.

Table 1-70 Param and Value availability with respect to Operation

Operation	param	values
"op": "replace"	Combination of Party ID and Associated Party ID used to uniquely identify the record	Modified fields
"op": "add"	Empty	New record added to the data segment.
"op": "remove"	Combination of Party ID and Associated Party ID used to uniquely identify the record	Empty

Event Payload

{
    "applicationNumber": "000CN1APP25062149253",
    "branchCode": "CN1",
    "userId": "USER1",
    "partyId": "PTY0001",
    "externalCustomerId": "PTY0001",
    "partyType": "S",
    "eventType": "AMEND",
    "handoffStatus": "SUCCESS",
    "sourceProductId": "OBPY",
    "datasegmentCode": "DS0108",
    "datasegmentName": "TRUSTEE_REL",
    "httpMethod": "PATCH",
    "amendPayload": "{\"applicationNumber\":\"\",\"sourceProductId\":\"OBPY\",\"externalCustomerNo\":\"PTY0001\",\"trusteeDetailsList\":[{\"op\":\"replace\",\"params\":{\"partyId\":\"PTY0001\",\"associatePartyId\":\"PTY0002\"},\"values\":{\"relationshipType\":\"TST\",\"versionNo\":2,\"createdBy\":\"USER1\",\"createdDate\":\"2020-03-26T20:47:00\",\"updatedBy\":\"USER1\",\"updatedDate\":\"2020-03-26T20:47:52\"}},{\"op\":\"add\",\"params\":{},\"values\":{\"partyId\":\"PTY0001\",\"associatePartyId\":\"PTY0003\",\"relationshipType\":\"TST\",\"versionNo\":2,\"createdBy\":\"USER1\",\"createdDate\":\"2020-03-26T20:47:00\",\"updatedBy\":\"USER1\",\"updatedDate\":\"2020-03-26T20:47:52\"}}]}",
    "amendDateTime": "2025-03-03T15:01:41.449051",
    "applicationDate": "2022-10-11"
}