GET api/{context}/partner/Search

parameters:   ?firstName={firstName}&lastName={lastName}&address={address}&city={city}&state={state}&postalCode={postalCode}&country={country}&company={company}&title={title}&phone={phone}&email={email}&page={page}&pageSize={pageSize}

Search for all partners using the field values provided.

Request Information

ParameterDescriptionAdditional information
firstName
Where the First Name field BEGINS WITH this value

Define this parameter in the request URI.

lastName
Where the Last Name field BEGINS WITH this value

Define this parameter in the request URI.

address
Where the Address field BEGINS WITH this value

Define this parameter in the request URI.

city
Where the City field BEGINS WITH this value

Define this parameter in the request URI.

state
Where the State/Province field BEGINS WITH this value

Define this parameter in the request URI.

postalCode
Where the Postal Code field BEGINS WITH this value

Define this parameter in the request URI.

country
Where the Country Code field BEGINS WITH this value

Define this parameter in the request URI.

company
Where the Company field CONTAINS this value

Define this parameter in the request URI.

title
Where the Title/Prefix field CONTAINS this value

Define this parameter in the request URI.

phone
Where the partner has a Phone Number which CONTAINS this value

Define this parameter in the request URI.

email
If formed as '_@__.__', then: Where BEGINS WITH, else: Where CONTAINS this value

Define this parameter in the request URI.

page
Optional page number.  If not included, page 1 will be returned.

Define this parameter in the request URI.

pageSize
Optional page size, limit of 100.  If not included, the default page size will be 25.

Define this parameter in the request URI.

Requirements

NumberNotes
#1
You must pass at least 1 value to search by.

Special Field Notes

Field NameNotes
NextPageLink
Contains the full URL necessary to retrieve the next page of records.
PageCount
The number of pages contained in the result set, based on the PageSize passed in the API request.
PreviousPageLink
Contains the full URL necessary to retrieve the previous page of records.
TotalCount
The total number of records contained in the result set.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "NextPageLink": "sample string 1",
  "PreviousPageLink": "sample string 2",
  "PageCount": 3,
  "TotalCount": 4,
  "Partners": [
    {
      "ID": "sample string 2",
      "Prefix": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "Suffix": "sample string 7",
      "Salutation": "sample string 8",
      "Spouse": "sample string 9",
      "SpouseLastName": "sample string 10",
      "Company": "sample string 11",
      "Address1": "sample string 12",
      "Address2": "sample string 13",
      "City": "sample string 14",
      "StateProv": "sample string 15",
      "PostalCode": "sample string 16",
      "CountryCode": "sample string 17",
      "PartnerPhones": [
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        }
      ],
      "PartnerAskArrays": [
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        }
      ],
      "Email": "sample string 18",
      "EmailPreference": "sample string 19",
      "WebURL": "sample string 20",
      "BirthDate": "2020-08-04T11:54:43.0739209-06:00",
      "WeddingDate": "2020-08-04T11:54:43.0739209-06:00",
      "MemberDate": "2020-08-04T11:54:43.0739209-06:00",
      "OriginSource": "sample string 21",
      "RequiresQC": true,
      "Deceased": true,
      "NoResponseLetters": true,
      "NoDirectMail": true,
      "NoTaxStatements": true,
      "NoPhoneSolicitation": true,
      "NoEmailSolicitation": true,
      "UndeliverableAddress": true,
      "NoMerge": true,
      "VIP": true,
      "Prospect": true,
      "UndeliverableEmail": true,
      "NoResponseEmails": true,
      "NoAddressStandardization": true,
      "WebUsername": "sample string 36",
      "WebPassword": "sample string 37",
      "WebMustChangePassword": true,
      "WebPasswordRecoveryToken": "f0703c8c-f78b-4139-bfec-b0db76685bf2",
      "WebPasswordTokenExpiration": "2020-08-04T11:54:43.0739209-06:00",
      "CustomFlags": [
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        }
      ],
      "CustomDataFields": [
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        }
      ]
    },
    {
      "ID": "sample string 2",
      "Prefix": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "Suffix": "sample string 7",
      "Salutation": "sample string 8",
      "Spouse": "sample string 9",
      "SpouseLastName": "sample string 10",
      "Company": "sample string 11",
      "Address1": "sample string 12",
      "Address2": "sample string 13",
      "City": "sample string 14",
      "StateProv": "sample string 15",
      "PostalCode": "sample string 16",
      "CountryCode": "sample string 17",
      "PartnerPhones": [
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        }
      ],
      "PartnerAskArrays": [
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        }
      ],
      "Email": "sample string 18",
      "EmailPreference": "sample string 19",
      "WebURL": "sample string 20",
      "BirthDate": "2020-08-04T11:54:43.0739209-06:00",
      "WeddingDate": "2020-08-04T11:54:43.0739209-06:00",
      "MemberDate": "2020-08-04T11:54:43.0739209-06:00",
      "OriginSource": "sample string 21",
      "RequiresQC": true,
      "Deceased": true,
      "NoResponseLetters": true,
      "NoDirectMail": true,
      "NoTaxStatements": true,
      "NoPhoneSolicitation": true,
      "NoEmailSolicitation": true,
      "UndeliverableAddress": true,
      "NoMerge": true,
      "VIP": true,
      "Prospect": true,
      "UndeliverableEmail": true,
      "NoResponseEmails": true,
      "NoAddressStandardization": true,
      "WebUsername": "sample string 36",
      "WebPassword": "sample string 37",
      "WebMustChangePassword": true,
      "WebPasswordRecoveryToken": "f0703c8c-f78b-4139-bfec-b0db76685bf2",
      "WebPasswordTokenExpiration": "2020-08-04T11:54:43.0739209-06:00",
      "CustomFlags": [
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        }
      ],
      "CustomDataFields": [
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        }
      ]
    },
    {
      "ID": "sample string 2",
      "Prefix": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "Suffix": "sample string 7",
      "Salutation": "sample string 8",
      "Spouse": "sample string 9",
      "SpouseLastName": "sample string 10",
      "Company": "sample string 11",
      "Address1": "sample string 12",
      "Address2": "sample string 13",
      "City": "sample string 14",
      "StateProv": "sample string 15",
      "PostalCode": "sample string 16",
      "CountryCode": "sample string 17",
      "PartnerPhones": [
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "Priority": 1,
          "Number": "sample string 2"
        }
      ],
      "PartnerAskArrays": [
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        },
        {
          "AskID": 1,
          "AskAmount": "sample string 2"
        }
      ],
      "Email": "sample string 18",
      "EmailPreference": "sample string 19",
      "WebURL": "sample string 20",
      "BirthDate": "2020-08-04T11:54:43.0739209-06:00",
      "WeddingDate": "2020-08-04T11:54:43.0739209-06:00",
      "MemberDate": "2020-08-04T11:54:43.0739209-06:00",
      "OriginSource": "sample string 21",
      "RequiresQC": true,
      "Deceased": true,
      "NoResponseLetters": true,
      "NoDirectMail": true,
      "NoTaxStatements": true,
      "NoPhoneSolicitation": true,
      "NoEmailSolicitation": true,
      "UndeliverableAddress": true,
      "NoMerge": true,
      "VIP": true,
      "Prospect": true,
      "UndeliverableEmail": true,
      "NoResponseEmails": true,
      "NoAddressStandardization": true,
      "WebUsername": "sample string 36",
      "WebPassword": "sample string 37",
      "WebMustChangePassword": true,
      "WebPasswordRecoveryToken": "f0703c8c-f78b-4139-bfec-b0db76685bf2",
      "WebPasswordTokenExpiration": "2020-08-04T11:54:43.0739209-06:00",
      "CustomFlags": [
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        },
        {
          "FlagName": "sample string 1",
          "StartDate": "2020-08-04T11:54:43.0739209-06:00",
          "ExpireDate": "2020-08-04T11:54:43.0739209-06:00"
        }
      ],
      "CustomDataFields": [
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        },
        {
          "FieldName": "sample string 1",
          "FieldValue": "sample string 2",
          "FieldType": "sample string 3"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<PartnerSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <NextPageLink>sample string 1</NextPageLink>
  <PageCount>3</PageCount>
  <PreviousPageLink>sample string 2</PreviousPageLink>
  <TotalCount>4</TotalCount>
</PartnerSearchModel>