Addendum Notices
This API fetches all Addendum and Notices created by the member based on allowed exchange segments and login type. These notices are typically legal disclaimers or important messages shown to the user on login.
🛣️Path Parameters
| Parameter | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| market_allowed | string | Yes | Exchange segments for which the addendum is required | 268437595 |
| login_type | string | Yes | Type of login for which the addendum applies | PASSWORD |
🔑Header Parameters
| Header | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| Authorization | string | Yes | Bearer token for user authentication and access. | Bearer |
🟢Success Response - 200 OK
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| status | string | Indicates the status of the API call. Default: "success" | "success" |
| code | string | API response code. | "s-101" |
| message | string | Human-readable success message. | "Addendum and notices data fetch successfully", |
| data | array | List of addendum and notice objects. | [See details below] |
📘Addendum Object
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| notice_id | string | Unique identifier for the addendum or notice. | "20" |
| notice_title | string | Title of the notice to be displayed to the user. | "New Circular" |
| notice_desc | string | Full body text/content of the addendum. | ""This is to test the new circular regarding the Risk disclosure",..." |
| action_on_reject | string | Action to be taken if the user rejects the addendum. | "1"[1 = Log off, 0 = No action] |
| show_checkbox | string | Whether to show a checkbox for acknowledgment. | "1"[1 = Yes, 2 = No] |
| checkbox_label | string | Text label for the checkbox, if shown. | "I have read and agree to the terms" |
| log_off_message | string | Message to display if the user is logged off due to rejection. | "You must accept the terms to continue." |
| frequency | string | Frequency at which the notice is to be shown to the user. | "0" |
| segment_allowed | string | Market segment to which this notice is applicable. | "4102" |