POST {version}/GetProfileTransactionsDownload
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
PaginatedTransactionCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| EntityName | string |
None. |
|
| ElectionPeriodFilter | globally unique identifier |
None. |
|
| TransactionTypeFilter | globally unique identifier |
None. |
|
| IncludeSoftAllocations | boolean |
None. |
|
| PageNum | integer |
None. |
|
| PageSize | integer |
None. |
|
| OrderBy_Field | string |
None. |
|
| IsAscending | boolean |
None. |
|
| EntityType | string |
None. |
|
| Columns | Collection of string |
None. |
|
| UiToDbColMap | Dictionary of string [key] and string [value] |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "4fd38815-da4c-4724-85a8-1479412e0b5c",
"EntityName": "sample string 1",
"ElectionPeriodFilter": "79dbb064-878e-4117-990b-727f265a0bfd",
"TransactionTypeFilter": "787e4f4e-6bd6-4172-999a-80139a6e4c5d",
"IncludeSoftAllocations": true,
"PageNum": 1,
"PageSize": 1,
"OrderBy_Field": "sample string 2",
"IsAscending": true,
"EntityType": "sample string 3",
"Columns": [
"sample string 1",
"sample string 2"
],
"UiToDbColMap": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<PaginatedTransactionCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
<Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Columns>
<ElectionPeriodFilter>79dbb064-878e-4117-990b-727f265a0bfd</ElectionPeriodFilter>
<EntityName>sample string 1</EntityName>
<EntityType>sample string 3</EntityType>
<Id>4fd38815-da4c-4724-85a8-1479412e0b5c</Id>
<IncludeSoftAllocations>true</IncludeSoftAllocations>
<IsAscending>true</IsAscending>
<OrderBy_Field>sample string 2</OrderBy_Field>
<PageNum>1</PageNum>
<PageSize>1</PageSize>
<TransactionTypeFilter>787e4f4e-6bd6-4172-999a-80139a6e4c5d</TransactionTypeFilter>
<UiToDbColMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</UiToDbColMap>
</PaginatedTransactionCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |