Purpose: This guide explains how to retrieve account sleeve information for a list of registration IDs using the OC application. It helps streamline the process of fetching sleeve data for multiple registrations in one go.
Simple Use Case: A user needs to retrieve account sleeve details for several registrations at once for analysis or reporting. Instead of calling the API individually for each registration, they can send all registration IDs in one batch request.
Process Overview:
1. Get OC Token
2. Navigate to API Path POST /Trading/Sleeve/Registrations/ListWithAccountSleeves
3. Add Request Body
4. Must provide one to many Registration IDs
EX: [ 32898, 32899, 32900, 32901]
Sample Response:
[
{
"accountSleeves": [
{
"modelAllocations": null,
"sweepAssetId": 54321,
"custodialBilling": null,
"sleeveBilling": null,
"minimumCash": null,
"replenishMinCash": false,
"substitutes": null,
"hasSMAModel": false,
"modelAggType": 0,
"minimumInvestmentAmount": null,
"createdFromOciProcess": false,
"accountId": 12345,
"sleeveDescription": null,
"targetAllocation": 0,
"currentAllocation": null,
"currentValue": 0,
"contributionAllocation": 0,
"distributionAllocation": 0,
"corporateActionAllocation": 0,
"toleranceUpper": 0,
"toleranceLower": 0,
"sleeveType": "Custodial account",
"modelAgg": null,
"managementStyle": null,
"subAdvisor": null,
"modelType": null,
"registrationId": 35013,
"subAdvisorId": null,
"modelAggId": null,
"managementStyleId": null,
"createdBy": "qa_admin",
"createdDate": "2024-05-01T09:38:29.833-05:00",
"editedBy": "qa_admin",
"editedDate": "2024-10-15T11:03:23.983-05:00",
"targetBalanceType": "Percent",
"doNotTrade": false,
"riskScore": null,
"regValue": null,
"isCustomized": false,
"sleeveStrategyDetailId": null,
"sleeveStrategyId": null,
"sleeveStrategy": null,
"sleeveStrategyToleranceUpper": 0,
"sleeveStrategyToleranceLower": 0,
"modelAggExcludeRebalanceSleeve": null,
"businessLine": null,
"unitBalanceScale": "",
"assets": null,
"categoryAllocations": null
}
]