User details
User Details¶
Request Details :
Parameter Name | Possible value | Description |
---|---|---|
jData* | Should send json object with fields in below list | |
jKey* | Key Obtained on login success. |
Json Fields | Possible value | Description |
---|---|---|
uid* | Logged in User Id |
Response Details : Response data will be in json format with below fields.
Json Fields | Possible value | Description |
---|---|---|
stat | Ok or Not_Ok | User details success or failure indication. |
exarr | Json array of strings with enabled exchange names | |
orarr | Json array of strings with enabled price types for user | |
prarr | Json array of Product Obj with enabled products, as defined below. | |
brkname | Broker id | |
brnchid | Branch id | |
actid | Account Id | |
uid | User Id | |
m_num | Mobile Number | |
uprev | Always it will be an INVESTOR, other types of user not allowed to login using this API. | |
request_time | It will be present only in a successful response. | |
emsg | This will be present only in case of errors. |
Product Obj format
Json Fields of object in values Array | Possiblevalue | Description |
---|---|---|
prd | Product name | |
s_prdt_ali | Product display name | |
exch | Json array of strings with enabled, allowed exchange names |
Sample Success Response:
The "response" in an API call refers to the data sent back by the server post-request processing. Typically in JSON format, this structured data can contain a data payload, metadata like status codes or timestamps, and error messages. HTTP status codes, such as 200 for success or 404 for not found, often accompany the response. A sample JSON response might include fields like "status", "message", and "result"
{
"request_time": "09:20:09 17-05-2024",
"uname": "JOHN VENISON",
"m_num": "97867xxxxx",
"exarr": [
"NSE",
"NFO",
"CDS",
"MCX",
"NIPO"
],
"prarr": [
{
"prd": "C",
"s_prdt_ali": "CNC",
"exch": [
"NSE",
"NIPO"
]
},
{
"prd": "I",
"s_prdt_ali": "MIS",
"exch": [
"NSE",
"NFO",
"CDS",
"MCX"
]
},
{
"prd": "M",
"s_prdt_ali": "NRML",
"exch": [
"NFO",
"CDS",
"MCX"
]
},
{
"prd": "H",
"s_prdt_ali": "CO",
"exch": [
"NSE",
"NFO",
"CDS",
"MCX"
]
},
{
"prd": "B",
"s_prdt_ali": "BO",
"exch": [
"NSE",
"NFO",
"CDS",
"MCX"
]
}
],
"orarr": [
"MKT",
"LMT",
"SL-LMT",
"SL-MKT",
"DS"
],
"brkname": "SKY",
"uid": "J171",
"brnchid": "HO",
"email": "[email protected]",
"actid": "J171",
"uprev": "INVESTOR",
"stat": "Ok"
}
Sample Failure Response:
Client Details¶
Request Details :
Parameter Name | Possible value | Description |
---|---|---|
jData* | Should send json object with fields in below list | |
jKey* | Key Obtained on login success. |
Json Fields | Possible value | Description |
---|---|---|
uid* | Logged in User Id | |
actid* | Login users account ID |
Response Details : Response data will be in json format with below fields.
Json Fields | Possible value | Description |
---|---|---|
stat | Ok or Not_Ok | User details success or failure indication. |
actid | Account ID | |
creatdte | Creation date | |
creattme | Creation time | |
m_num | Mobile Number | |
Email ID | ||
pan | PAN | |
dob | Date of birth in DDMMYYYY format | |
act_sts | Account Status | |
addr | Address | |
addroffice | Office address | |
addrcity | City | |
addrstate | State | |
bankdetails | Array Object, details given below | |
dp_acct_num | Array Object, details given below | |
exarr | "CDS","NSE", "NFO","MCX","BSE","NCX","BSTAR","BCD" | Json array of strings with enabled exchange names |
mandate_id_list | Mandate Id List [ Array Object, details given below.] | |
request_time | It will be present only in a successful response. | |
emsg | This will be present only in case of errors |
bankdetails Obj format
Json Fields | Possiblevalue | Description |
---|---|---|
bankn | Bank name | |
acctnum | Account number |
dp_acct_num Obj format
Json Fields | Possiblevalue | Description |
---|---|---|
dpnum | Dp account number |
mandate_id_list Obj format
Json Fields | Possiblevalue | Description |
---|---|---|
mandate_id | Mandate Id |
Save FCM token¶
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 | |
fcmtkn* | FCM token collected from device |
Response Details : Response data will be in json format with below fields
Parameter Name | Possiblevalue | Description |
---|---|---|
stat | Ok or Not_Ok | If save FCM token is Success Or failure status |
request_time | This will be present only if password change succeeds. | |
emsg | This will be present only if save token fails |
sample responce