Alerts
Set Alert¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User id of the logged in user. | |
| tsym* | Trading symbol | |
| exch* | Exchange Segment | |
| ai_t* | Alert Type | |
| validity* | DAY or GTT | Validity |
| d* | Data to be compared with LTP | |
| remarks | Any message Entered during order entry. | |
| sms_flag | true or false | SMS flag |
| email_flag | true or false | Email flag |
| push_flag | true or false | Push flag |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | alert success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| al_id | Alert Id | |
| emsg | This will be present only in case of errors. That is : 1) Invalid Input2) Session Expired |
Cancel Alert¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid | User id of the logged in user. | |
| al_id* | Alert Id |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | alert success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| al_id | Alert Id | |
| emsg | This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired |
Modify Alert¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User id of the logged in user. | |
| tsym* | Trading symbol | |
| exch* | Exchange Segment | |
| ai_t* | Alert Type, should be original alert type, can’t be modified. | |
| al_id* | Alert Id | |
| validity* | DAY or GTT Validity | |
| d | Data to be compared with LTP | |
| remarks | Any message Entered during order entry. | |
| sms_flag | true or false | SMS flag |
| email_flag | true or false | Email flag |
| push_flag | true or false | Push flag |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | alert success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| al_id | Alert Id | |
| emsg | This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired |
Get Pending Alert¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User id of the logged in user. |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | alert success or failure indication. | |
| ai_t | Alert type | |
| al_id | Alert Id | |
| tsym | Trading symbol | |
| exch | Exchange Segment | |
| token | Contract token | |
| remarks | Any message Entered during order entry. | |
| validity | DAY or GTT | Validity |
| d Data | to be compared with LTP | |
| sms_flag | true or false SMS flag | |
| email_flag | true or false Email flag | |
| push_flag | true or false Push flag | |
| emsg | This will be present only in case of errors.That is : 1) Invalid Input 2) Session Expired |
Get Enabled Alert Types¶
Request Details :
| Parameter Name | Possiblevalue | Description |
|---|---|---|
| jData* | Should send json object with fields in below list | |
| jKey* | Key Obtained on login success. |
| Json Fields | Possiblevalue | Description |
|---|---|---|
| uid* | User id of the logged in user. |
Response Details :
Response data will have below fields.
| Json Fields | Possiblevalue | Description |
|---|---|---|
| stat | Alert order success or failure indication. | |
| request_time | This will be present only in a successful response. | |
| ai_ts | Array of alert types |