POST {version}/DownloadMergeGroups

Downloads merge matches with duplicate records.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The download request containing the search filter and column names

MergeGroupsDownloadRequest
NameDescriptionTypeAdditional information
Columns

string

None.

MergeFilter

MergeFilter

None.

Request Formats

application/json, text/json

Sample:
{
  "Columns": "sample string 1",
  "MergeFilter": {
    "IsIndividual": true,
    "IsOrganization": true,
    "Name": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "StartDate": "10/16/2024",
    "EndDate": "10/16/2024",
    "TransactionStartDate": "10/16/2024",
    "TransactionEndDate": "10/16/2024",
    "ThresholdDate": "10/16/2024",
    "Amount": 1.0,
    "HasTransactions": true,
    "FilingCommittees": "sample string 6",
    "Line1": "sample string 7",
    "Line2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "Zip": "sample string 11",
    "Phone": "sample string 12",
    "NameMatch": true,
    "FirstMatch": true,
    "MiddleMatch": true,
    "LastMatch": true,
    "SuffixMatch": true,
    "EmailMatch": true,
    "Line1Match": true,
    "Line2Match": true,
    "CityMatch": true,
    "StateMatch": true,
    "ZipMatch": true,
    "PhoneMatch": true,
    "NameMatchLength": 1,
    "FirstMatchLength": 1,
    "MiddleMatchLength": 1,
    "LastMatchLength": 1,
    "SuffixMatchLength": 1,
    "EmailMatchLength": 1,
    "Line1MatchLength": 1,
    "Line2MatchLength": 1,
    "CityMatchLength": 1,
    "StateMatchLength": 1,
    "ZipMatchLength": 1,
    "PhoneMatchLength": 1,
    "PageNum": 13,
    "PageLength": 14,
    "EmailMatchOption": "sample string 15",
    "PhoneMatchOption": "sample string 16",
    "Line1MatchOption": "sample string 17",
    "Line2MatchOption": "sample string 18",
    "CityMatchOption": "sample string 19",
    "StateMatchOption": "sample string 20",
    "ZipMatchOption": "sample string 21"
  }
}

application/xml, text/xml

Sample:
<MergeGroupsDownloadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Columns>sample string 1</Columns>
  <MergeFilter>
    <Amount>1</Amount>
    <City>sample string 9</City>
    <CityMatch>true</CityMatch>
    <CityMatchLength>1</CityMatchLength>
    <CityMatchOption>sample string 19</CityMatchOption>
    <EmailMatch>true</EmailMatch>
    <EmailMatchLength>1</EmailMatchLength>
    <EmailMatchOption>sample string 15</EmailMatchOption>
    <EndDate>2024-10-16T12:30:30.9911697-04:00</EndDate>
    <FilingCommittees>sample string 6</FilingCommittees>
    <FirstMatch>true</FirstMatch>
    <FirstMatchLength>1</FirstMatchLength>
    <FirstName>sample string 4</FirstName>
    <HasTransactions>true</HasTransactions>
    <IsIndividual>true</IsIndividual>
    <IsOrganization>true</IsOrganization>
    <LastMatch>true</LastMatch>
    <LastMatchLength>1</LastMatchLength>
    <LastName>sample string 5</LastName>
    <Line1>sample string 7</Line1>
    <Line1Match>true</Line1Match>
    <Line1MatchLength>1</Line1MatchLength>
    <Line1MatchOption>sample string 17</Line1MatchOption>
    <Line2>sample string 8</Line2>
    <Line2Match>true</Line2Match>
    <Line2MatchLength>1</Line2MatchLength>
    <Line2MatchOption>sample string 18</Line2MatchOption>
    <MiddleMatch>true</MiddleMatch>
    <MiddleMatchLength>1</MiddleMatchLength>
    <Name>sample string 3</Name>
    <NameMatch>true</NameMatch>
    <NameMatchLength>1</NameMatchLength>
    <PageLength>14</PageLength>
    <PageNum>13</PageNum>
    <Phone>sample string 12</Phone>
    <PhoneMatch>true</PhoneMatch>
    <PhoneMatchLength>1</PhoneMatchLength>
    <PhoneMatchOption>sample string 16</PhoneMatchOption>
    <StartDate>2024-10-16T12:30:30.9911697-04:00</StartDate>
    <State>sample string 10</State>
    <StateMatch>true</StateMatch>
    <StateMatchLength>1</StateMatchLength>
    <StateMatchOption>sample string 20</StateMatchOption>
    <SuffixMatch>true</SuffixMatch>
    <SuffixMatchLength>1</SuffixMatchLength>
    <ThresholdDate>2024-10-16T12:30:30.9911697-04:00</ThresholdDate>
    <TransactionEndDate>2024-10-16T12:30:30.9911697-04:00</TransactionEndDate>
    <TransactionStartDate>2024-10-16T12:30:30.9911697-04:00</TransactionStartDate>
    <Zip>sample string 11</Zip>
    <ZipMatch>true</ZipMatch>
    <ZipMatchLength>1</ZipMatchLength>
    <ZipMatchOption>sample string 21</ZipMatchOption>
  </MergeFilter>
</MergeGroupsDownloadRequest>

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.