GET Household/{householdId}/Holding/AssetSummary?asOfDate={asOfDate}
Gets the asset summary for a household.
Request Information
Header Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Authorization |
The authorization token prefixed with 'Bearer' |
string |
Required |
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
householdId |
The household identifier. |
integer |
Required |
asOfDate |
As of date. |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a collection of AssetSummaryModel objects.
Type: Collection of AssetSummaryModelName | Description | Type | Additional information |
---|---|---|---|
AssetType |
The name of the asset type |
string |
None. |
Amount |
The amount of money available in this asset |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AssetType": "Equities", "Amount": 100.0 }, { "AssetType": "Option", "Amount": 250.0 } ]
application/xml, text/xml
Sample:
<ArrayOfAssetSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client"> <AssetSummaryModel> <Amount>100</Amount> <AssetType>Equities</AssetType> </AssetSummaryModel> <AssetSummaryModel> <Amount>250</Amount> <AssetType>Option</AssetType> </AssetSummaryModel> </ArrayOfAssetSummaryModel>