1.4.23 Additional Information
Event notification for amendment in additional info of the party.
Additional Info event is published during an amendment process through.
- User Interface (PUT API Request)
- PUT API Request
- PATCH API Request
Table 1-39 Data Segment
Data Segment Code | Data Segment Name | Topic Name | Party Type |
---|---|---|---|
DS0028 | ADDITIONAL_INFO | obpyRetAmendAddInfo | Retail |
User Interface and PUT API Request
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.
PATCH API Request
The PATCH API method, an HTTP request method, is utilized for field-level modifications within a Data Segment of customer information, rather than updating the entire Data Segment Information. This event encompasses modifications such as addition, deletion, modification of party 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 fields can be added, updated, or removed by specifying the attributes requiring modification.
Note:
For PUT API Request, “httpMethod” is populated as “PUT” and for PATCH API Request “httpMethod” is populated as “PATCH”.\
{
"applicationNumber": "OBPYAPP000250767655",
"branchCode": "000",
"userId": "USER1",
"partyId": "PTY00001",
"externalCustomerId": "PTY00001",
"partyType": "I",
"eventType": "AMEND",
"handoffStatus": "SUCCESS",
"sourceProductId": "OBPY",
"datasegmentCode": "DS0028",
"datasegmentName": "ADDITIONAL_INFO",
"httpMethod": "PATCH",
"amendPayload": "{\"externalCustomerNo\":\"PTY00001\",\"sourceProductId\":\"OBPY\",\"PartyAddnInfoMasterModel\": {\"versionNo\": 1,\"createdBy\":\"USER1\",\"createdDate\":\"2020-03-26T15:58:23\",\"updatedBy\":\"USER1\",\"updatedDate\":\"2020-03-26T17:35:47\",\"isInsider\":\"false\",\"insiderRole\":\"Board Member\",\"insiderRemarks\":\"Senior member\",\"isSpeciallyAbled\":\"false\",\"detailsOfSpecialNeed\": null,\"remarksForSpecialNeed\": null,\"isArmedForces\":\"false\",\"serviceBranch\": null,\"remarksForArmedForce\": null,\"employeeId\":\"E1234\",\"isMLA\":\"false\",\"isPEP\":\"false\",\"remarksForPEP\":\"false\",\"isFidm\":\"false\",\"remarksForFIDM\":\"false\",\"fidmDefaultAmount\":\"0\",\"fidmAgency\":\"false\",\"fidmdateOfReport\":\"2002-01-30\" } }",
"amendDateTime": "2025-03-17T12:05:53.229090",
"applicationDate": "2020-03-26"
}
Parent topic: Retail Party Amendment