GET {version}/Individuals/{sourceId}/TotalContributionsCore?receiptyear={receiptyear}&excludedsource={excludedsource}
Returns an Individual's Total Contribution from receipts. Expects a valid Source ID as the parameter. Returns 404 Error if Source ID is invalid. Expects input for receiptyear, or returns empty object.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
sourceId | string |
Required |
|
receiptyear | string |
Required |
|
excludedsource | string |
Default value is |
|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns JSON object containing array of objects, each describing contributions. If providing receiptyear as input, provides receipt year total. If providing excludesource, excludes that source from calculation.
Collection of Aristotle.P6.ViewModels.Entity.EntityAggregateStatisticsCoreName | Description | Type | Additional information |
---|---|---|---|
FieldName | string |
None. |
|
FieldValue | decimal number |
None. |
|
ReceiptYear | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "FieldName": "sample string 1", "FieldValue": 1.0, "ReceiptYear": "sample string 2" }, { "FieldName": "sample string 1", "FieldValue": 1.0, "ReceiptYear": "sample string 2" } ]
application/xml, text/xml
Sample:
<ArrayOfEntityAggregateStatisticsCore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.P6.ViewModels.Entity"> <EntityAggregateStatisticsCore> <FieldName>sample string 1</FieldName> <FieldValue>1</FieldValue> <ReceiptYear>sample string 2</ReceiptYear> </EntityAggregateStatisticsCore> <EntityAggregateStatisticsCore> <FieldName>sample string 1</FieldName> <FieldValue>1</FieldValue> <ReceiptYear>sample string 2</ReceiptYear> </EntityAggregateStatisticsCore> </ArrayOfEntityAggregateStatisticsCore>