POST {version}/GetProfileTransactionsDownload

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

PaginatedTransactionCriteria
NameDescriptionTypeAdditional 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": "04e338ef-a44a-468d-920f-f5ae36c2ebce",
  "EntityName": "sample string 1",
  "ElectionPeriodFilter": "0fbf5eff-bb04-4952-b643-ee05e2573d34",
  "TransactionTypeFilter": "1f2ba1bd-b662-4cfb-9445-2678e4ef35c6",
  "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>0fbf5eff-bb04-4952-b643-ee05e2573d34</ElectionPeriodFilter>
  <EntityName>sample string 1</EntityName>
  <EntityType>sample string 3</EntityType>
  <Id>04e338ef-a44a-468d-920f-f5ae36c2ebce</Id>
  <IncludeSoftAllocations>true</IncludeSoftAllocations>
  <IsAscending>true</IsAscending>
  <OrderBy_Field>sample string 2</OrderBy_Field>
  <PageNum>1</PageNum>
  <PageSize>1</PageSize>
  <TransactionTypeFilter>1f2ba1bd-b662-4cfb-9445-2678e4ef35c6</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
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.