DP Holdings

PURPOSE

The API is used to fetch DP holding details of the client and require a logged in session. In a successfully logged in session, client or partner can fetch the details of DP Holdings by just passing the client code in the request. It provides an array of DP holdings in the response which include fields like scrip symbol, ISIN, scrip type, as on date, quantity and face value. The response array will have DP holdings as of beginning of the day.

Request URL

https://dataservice.iifl.in/openapi/prod/BackoffDPHolding

Request Method: POST

Request format: JSON

Request Header:

Content-Type: application/json

Ocp-Apim-Subscription-Key:
to be provided after registration

REQUEST BODY

HEADER

Field Name	Description	Data Type (max length)	Validation	Sample Value
appName	App Name provided at the time of registration	String	Cannot be empty.	IIFLMarDEMO
appVer	Developer App Version	String	Cannot be empty.	1.0
key	UserKey generated at the time of registration	String	Cannot be empty.	ABpyyGUh1nsbesSlup3VKURkI4tQDe8y
osName	Channel of order	String	Cannot be empty.	WEB, Android, iOS
requestCode	Request Code of the API called	String	Cannot be empty.	IIFLMarRQBackoffDPHolding
userId	User ID generated at the time of registration	String	Cannot be empty.	ZkhghN5uKj
password	Password generated at the time of registration	String	Cannot be empty.	lfjnfS7rHGj

BODY

Field Name	Description	Data Type (max length)	Validation	Sample Value
ClientCode	This the clientcode of particular client	String (8)	Cannot be empty	Dummy123

REQUEST:

{
  "head": {
    "appName": "IIFLMarDEMO",
    "appVer": "1.0",
    "key": "ABpyyGUh1nsbesSlup3VKURkI4tQDe8y",
    "osName": "Android",
    "requestCode": "IIFLMarRQBackoffDPHolding",
    "userId": "mocZueK622W",
    "password": "UjR1ElLwSzr"
  },
  "body": {
    "ClientCode": "Dummy123"
  }
}

RESPONSE BODY

HEADER

Field Name	Description	Data Type (max length)	List of Values	Sample Value
responseCode	This is the response code of API	String	-	IIFLMarRPBackoffDPHolding
status	This is the response code of API	String	0 – Success 2 – Invalid Head Parameters	0
statusDescription	This is the response code of API	String	0 - Success 2 - Invalid head parameters	Success

BODY

Field Name	Description	Data Type (max length)	List Values	Sample Value
Status	Returns the status of the response.	Integer	0 - Success 1 - No data found 2 - Not a valid parameters -1 - Issue while process your request on Server -2 - 403 : Access denied. 9 - Invalid Session	0
Message	Returns the message of the response.	String	A. Invalid Head Parameters B. Invalid Body Parameters C. Success D. Error while processing your request E. 403 : Access denied F. Invalid Session	Success
DPHolding	This the list of DP Holding	list	-	-

DPHolding

Field Name	Data Type	Description
ClientCode	String (50)	This the client login id
Symbol	String (15)	It is a client traded scrip name
ISIN	String (12)	ISIN of the traded scrip
AsOnDate	String (8)	As On Date
Quantity	Double	Trading quantity
ScripType	String (6)	Type of the scrip (Equity, MF, etc.)
FaceValue	Double (80)	Face value of the scrip

Success Response

{
  "body": {
    "DPHolding": [
      {
        "AsOnDate": "20190606",
        "ClientCode": "Dummy123",
        "FaceValue": 0,
        "ISIN": "INF204K01UN9",
        "Quantity": 0,
        "ScripType": "MF",
        "Symbol": "RELLIQTPIG"
      },
      {
        "AsOnDate": "20190606",
        "ClientCode": "Dummy123",
        "FaceValue": 100,
        "ISIN": "INE263A01024",
        "Quantity": 14,
        "ScripType": "MF",
        "Symbol": "BEL"
      }
    ],
    "message": "Success",
    "status": 0
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffDPHolding",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": {
    "Message": "Invalid Input Parameters.",
    "Status": 2,
    "_details": []
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffDPHolding",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": {
    "Message": "No record found.",
    "Status": 1,
    "_details": []
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffDPHolding",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": {
    "Margin": 0,
    "Message": "Invalid Input Parameters.",
    "Status": 2
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffDPHolding",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": null,
  "head": {
    "responseCode": "IIFLMarRPBackoffDPHolding",
    "status": "-2",
    "statusDescription": "403 : Access denied."
  }
}