POST api/BlastSearch?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}
Searches for residents based on search criteria
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VendorID | string |
Required |
|
VendorPassword | string |
Required |
|
APIGUID | string |
Required |
Body Parameters
Search Request
BlastCommunicationSearchName | Description | Type | Additional information |
---|---|---|---|
BlastMode | integer |
None. |
|
CommitteeKey | integer |
None. |
|
CommitteeType | integer |
None. |
|
ACH | integer |
None. |
|
BeginBalance | decimal number |
None. |
|
EndBalance | decimal number |
None. |
|
ExcludeInvoiceDistribution | boolean |
None. |
|
AvoidDuplicateEmails | boolean |
None. |
|
UseSystemDefinition | boolean |
None. |
|
UserDefined | boolean |
None. |
|
EmailOnly | boolean |
None. |
|
OptOut | integer |
None. |
|
AccountStatusSearchFor | Collection of BlastAccountStatusSearch |
None. |
|
AccountTypeSearchFor | Collection of BlastAccountTypeSearch |
None. |
|
CommunitySearchFor | Collection of BlastCommunitySearch |
None. |
|
ContactTypeSearchFor | Collection of BlastContactTypeSearch |
None. |
|
CompanySearchFor | Collection of CompanySearch |
None. |
Request Formats
application/json, text/json
Sample:
{ "BlastMode": 1, "CommitteeKey": 2, "CommitteeType": 3, "ACH": 4, "BeginBalance": 5.0, "EndBalance": 6.0, "ExcludeInvoiceDistribution": true, "AvoidDuplicateEmails": true, "UseSystemDefinition": true, "UserDefined": true, "EmailOnly": true, "OptOut": 12, "AccountStatusSearchFor": [ { "r_Key": "sample string 1" }, { "r_Key": "sample string 1" } ], "AccountTypeSearchFor": [ { "rat_Type": 1 }, { "rat_Type": 1 } ], "CommunitySearchFor": [ { "CommunityKey": 1 }, { "CommunityKey": 1 } ], "ContactTypeSearchFor": [ { "rc_Type": 1 }, { "rc_Type": 1 } ], "CompanySearchFor": [ { "CompanyKey": 1 }, { "CompanyKey": 1 } ] }
application/xml, text/xml
Sample:
<BlastCommunicationSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident"> <ACH>4</ACH> <AccountStatusSearchFor> <BlastAccountStatusSearch> <r_Key>sample string 1</r_Key> </BlastAccountStatusSearch> <BlastAccountStatusSearch> <r_Key>sample string 1</r_Key> </BlastAccountStatusSearch> </AccountStatusSearchFor> <AccountTypeSearchFor> <BlastAccountTypeSearch> <rat_Type>1</rat_Type> </BlastAccountTypeSearch> <BlastAccountTypeSearch> <rat_Type>1</rat_Type> </BlastAccountTypeSearch> </AccountTypeSearchFor> <AvoidDuplicateEmails>true</AvoidDuplicateEmails> <BeginBalance>5</BeginBalance> <BlastMode>1</BlastMode> <CommitteeKey>2</CommitteeKey> <CommitteeType>3</CommitteeType> <CommunitySearchFor> <BlastCommunitySearch> <CommunityKey>1</CommunityKey> </BlastCommunitySearch> <BlastCommunitySearch> <CommunityKey>1</CommunityKey> </BlastCommunitySearch> </CommunitySearchFor> <CompanySearchFor> <CompanySearch> <CompanyKey>1</CompanyKey> </CompanySearch> <CompanySearch> <CompanyKey>1</CompanyKey> </CompanySearch> </CompanySearchFor> <ContactTypeSearchFor> <BlastContactTypeSearch> <rc_Type>1</rc_Type> </BlastContactTypeSearch> <BlastContactTypeSearch> <rc_Type>1</rc_Type> </BlastContactTypeSearch> </ContactTypeSearchFor> <EmailOnly>true</EmailOnly> <EndBalance>6</EndBalance> <ExcludeInvoiceDistribution>true</ExcludeInvoiceDistribution> <OptOut>12</OptOut> <UseSystemDefinition>true</UseSystemDefinition> <UserDefined>true</UserDefined> </BlastCommunicationSearch>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | 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. |