Sync Position Conversion
🚀 Sync Position Conversion Request​
| Field | Details |
|---|---|
| API Name | SyncPositionConversionOrders |
| URL Format | <protocol>://<domain name:port>/<VirtualDir>/<URL> |
| Example URL | https://localhost:8080/OTPA/V1/SyncPositionConverion |
| Description | This request retrieves all Position Conversion orders available in the system. When the server receives this request, it sends state‑based Position Conversion Order information messages. The request must include the jToken received from the Authentication API. |
📖 Sync Position Conversion Request Parameters​
| Parameter | Data Type | Description |
|---|---|---|
| jMessageType | varchar(15) | Must be sent as SYNC_POS_CON |
| jManagerID | varchar(50) | Manager Identification Number |
| jCustomerId | varchar(50) | Customer ID assigned to the user |
| jExchange | int | Exchange identifier |
| jToken | varchar(512) | Authentication token received from Authentication API |
| jEntrySequenceNumber | int64 | Last received sequence number (default is 0 if not provided) |
| jRequestID | varchar(255) | Echo‑back field |
Example Sync Position Conversion Request​
{
"jMessageType": "SYNC_POS_CONV",
"jManagerID": "<MANAGER1>",
"jCustomerId": "<MEMBER>",
"jToken": "<Token received in the Authentication Response>",
"jEntrySequenceNumber": "<max sequence no>",
"jRequestID": "<Echo back field>"
}
📦 Sync Position Conversion Response​
The response contains the following parameters:
| Parameter | Data Type | Description |
|---|---|---|
| jManagerId | varchar(50) | User ID assigned to the user |
| jCustomerId | varchar(50) | Customer ID assigned to the user |
| jLastSyncedPacket | int | Indicates if this is the last packet (1 = last packet) |
| jNoOfRecords | int | Number of Position Conversion records |
| jOrderMessage | Position Conversion Detail Structure (array) | Array of Position Conversion messages (size = jNoOfRecords) |
| jRequestID | varchar(255) | Echo back field |
| jResponseID | varchar(255) | System‑generated alphanumeric ID |
📝 Sync Position Conversion Detail Structure​
Each entry inside jOrderMessage contains:
| Parameter (Key) | Data Type | Description |
|---|---|---|
| Order Number | int | NA |
| Cli Order Number | int | Position Conversion Serial Number |
| Exchange | varchar(10) | Exchange |
| Scrip Token | int | Scrip token |
| Symbol | float | Exchange‑provided security scrip name |
| Series | varchar(3) | Exchange‑provided security series |
| InstrumentName | varchar(20) | Instrument name. Valid values: • Equity = blank • Future Index = FUTIDX • Interest Rate Future = FUTINT • Future Stock = FUTSTK • Option Index = OPTIDX • Option Stock = OPTSTK • MCX/NCDEX Futures = FUTCOM • MCX Spot = COM • NCDEX Spot = COMDTY • NSE Currency Future = FUTCUR, FUTIRD, FUTIRT, OPTCUR • NSE Currency Spot = INDEX, UNDCUR, UNDIRD, UNDIRT |
| Expiry Date | varchar(10) | Expiry date (ddMMMyyyy, e.g., 24JUN2004). Applicable for F&O only; blank otherwise. |
| Strike Price | float | Exchange‑provided strike price (in rupees). Applicable for options only; otherwise -1. |
| Option Type | varchar(2) | Option type. Applicable for options only; blank otherwise. |
| Buy Sell | int | Buy/Sell flag: • 1 → Buy• 2 → Sell |
| Order Original Qty | int | Original order quantity |
| Pending Qty | int | NA |
| TradedQTY | int | NA |
| DQ | int | NA |
| Order Price | float | NA |
| Trigger Price | float | NA |
| Order Type | varchar(10) | Order type |
| Order Status | varchar(15) | Order status |
| Reason | varchar(300) | Rejection reason |
| Order Validity | varchar(100) | NA |
| Pro/Cli | int | Participant type: • 1 → CLI• 2 → PRO |
| User ID | varchar(10) | NA |
| DealerCode | varchar(5) | Unique user identification code |
| Part Code | varchar(12) | NA |
| Order Entry Time | varchar(10) | NA |
| Last Modified Time | varchar(10) | Order last modified timestamp (e.g., 15Jun2018 15.25.15) |
| Alias | varchar(5) | Alias ID; blank if not applicable |
| Product | varchar(5) | Position Conversion product type |
| Initiated By | varchar(25) | Application that initiated the request (e.g., ADMIN, NET) |
| Modified By | varchar(25) | Application that modified the request |
| Initiated By User Id | varchar(10) | User ID that initiated the request |
| Modified By User Id | varchar(10) | User ID that modified the request |
| Leg Indicator | int | NA |
| LocationID | varchar(5) | Location Identifier (PIN + NSECTCLBRANCH ID + NSECTCLID + ALGO FLAG + VENDOR CODE) |
| User Remarks | varchar(50) | NA |
| Misc | varchar(50) | NA |
| SpreadFlag | int | NA |
| Spread Price | float | NA |
| AMO Order ID | varchar(50) | NA |
| SequenceNo | int64 | Incremental sequence number |
| ManagerId | int | Manager ID |
| Days | int | NA |
| UniqueCode | varchar(12) | Alphanumeric value with special characters |
Example Response​
{
"jData": {
"ManagerID": "KOTAL_10.0.0.1",
"CustomerId": "KOTAK",
"NoOfRecords": 6,
"OrderDetail": [
{ "MessageCode": 2000, "OrderNumber": 1, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 2, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 3, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 4, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 5, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 6, "...": "..." }
]
}
}