GET api/{context}/partner/Email/{text}

Retrieve a partner by using their primary email address as the look-up value.

PLEASE NOTE: This method has the potential to return the unintended partner because there is not a unique constraint on Email in the Aegis CRM database.
This means that multiple partners can potentially have the same Email address.
We recommend enforcing uniqueness during new partner registrations by first looking up a partner before creating them via the API.

Request Information

ParameterDescriptionAdditional information
text 
The Email of the partner to look up.

Define this parameter in the request URI.

Requirements

NumberNotes
#1 
New partners must have either a Name or Company.
#2 
New partners must have some form of contact info: an Address, Phone Number, or Email.

Special Field Notes

Field NameNotes
EmailPreference 
Valid choices should be limited to either 'HTML', 'Text', or empty.
ID 
Primary key for all Aegis CRM records.  New IDs are auto-assigned.  If you'd like to store a 3rd party ID, please use a custom data field.
MemberDate 
Auto-assigned by the Aegis CRM application and indicates when the database record was created.

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "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",
  "Email2": "sample string 19",
  "Email3": "sample string 20",
  "Email4": "sample string 21",
  "EmailPreference": "sample string 22",
  "WebURL": "sample string 23",
  "BirthDate": "2024-04-16T07:51:53.2984784-06:00",
  "WeddingDate": "2024-04-16T07:51:53.2984784-06:00",
  "MemberDate": "2024-04-16T07:51:53.2984784-06:00",
  "OriginSource": "sample string 24",
  "RequiresQC": true,
  "Deceased": true,
  "NoResponseLetters": true,
  "NoDirectMail": true,
  "NoTaxStatements": true,
  "NoPhoneSolicitation": true,
  "NoEmailSolicitation": true,
  "NoTextSolicitation": true,
  "NoRentOrExchange": true,
  "NoVisits": true,
  "UndeliverableAddress": true,
  "NoMerge": true,
  "VIP": true,
  "Prospect": true,
  "UndeliverableEmail": true,
  "NoResponseEmails": true,
  "NoAddressStandardization": true,
  "WebUsername": "sample string 26",
  "WebPassword": "sample string 27",
  "WebMustChangePassword": true,
  "WebPasswordRecoveryToken": "df37f4b5-435d-4767-866e-8bb9fe38c0f2",
  "WebPasswordTokenExpiration": "2024-04-16T07:51:53.2984784-06:00",
  "CustomFlags": [
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-04-16T07:51:53.2984784-06:00",
      "ExpireDate": "2024-04-16T07:51:53.2984784-06:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-04-16T07:51:53.2984784-06:00",
      "ExpireDate": "2024-04-16T07:51:53.2984784-06:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-04-16T07:51:53.2984784-06:00",
      "ExpireDate": "2024-04-16T07:51:53.2984784-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: 
<PartnerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <Address1>sample string 12</Address1>
  <Address2>sample string 13</Address2>
  <BirthDate>2024-04-16T07:51:53.2984784-06:00</BirthDate>
  <City>sample string 14</City>
  <Company>sample string 11</Company>
  <CountryCode>sample string 17</CountryCode>
  <CustomDataFields>
    <PartnerModel.CustomDataModel>
      <FieldName>sample string 1</FieldName>
      <FieldType>sample string 3</FieldType>
      <FieldValue>sample string 2</FieldValue>
    </PartnerModel.CustomDataModel>
    <PartnerModel.CustomDataModel>
      <FieldName>sample string 1</FieldName>
      <FieldType>sample string 3</FieldType>
      <FieldValue>sample string 2</FieldValue>
    </PartnerModel.CustomDataModel>
    <PartnerModel.CustomDataModel>
      <FieldName>sample string 1</FieldName>
      <FieldType>sample string 3</FieldType>
      <FieldValue>sample string 2</FieldValue>
    </PartnerModel.CustomDataModel>
  </CustomDataFields>
  <CustomFlags>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2024-04-16T07:51:53.2984784-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-04-16T07:51:53.2984784-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2024-04-16T07:51:53.2984784-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-04-16T07:51:53.2984784-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2024-04-16T07:51:53.2984784-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-04-16T07:51:53.2984784-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
  </CustomFlags>
  <Deceased>true</Deceased>
  <Email>sample string 18</Email>
  <Email2>sample string 19</Email2>
  <Email3>sample string 20</Email3>
  <Email4>sample string 21</Email4>
  <EmailPreference>sample string 22</EmailPreference>
  <FirstName>sample string 4</FirstName>
  <ID>sample string 2</ID>
  <LastName>sample string 6</LastName>
  <MemberDate>2024-04-16T07:51:53.2984784-06:00</MemberDate>
  <MiddleName>sample string 5</MiddleName>
  <NoAddressStandardization>true</NoAddressStandardization>
  <NoDirectMail>true</NoDirectMail>
  <NoEmailSolicitation>true</NoEmailSolicitation>
  <NoMerge>true</NoMerge>
  <NoPhoneSolicitation>true</NoPhoneSolicitation>
  <NoRentOrExchange>true</NoRentOrExchange>
  <NoResponseEmails>true</NoResponseEmails>
  <NoResponseLetters>true</NoResponseLetters>
  <NoTaxStatements>true</NoTaxStatements>
  <NoTextSolicitation>true</NoTextSolicitation>
  <NoVisits>true</NoVisits>
  <OriginSource>sample string 24</OriginSource>
  <PartnerAskArrays>
    <PartnerModel.PartnerAskModel>
      <AskAmount>sample string 2</AskAmount>
      <AskID>1</AskID>
    </PartnerModel.PartnerAskModel>
    <PartnerModel.PartnerAskModel>
      <AskAmount>sample string 2</AskAmount>
      <AskID>1</AskID>
    </PartnerModel.PartnerAskModel>
    <PartnerModel.PartnerAskModel>
      <AskAmount>sample string 2</AskAmount>
      <AskID>1</AskID>
    </PartnerModel.PartnerAskModel>
  </PartnerAskArrays>
  <PostalCode>sample string 16</PostalCode>
  <Prefix>sample string 3</Prefix>
  <Prospect>true</Prospect>
  <RequiresQC>true</RequiresQC>
  <Salutation>sample string 8</Salutation>
  <Spouse>sample string 9</Spouse>
  <SpouseLastName>sample string 10</SpouseLastName>
  <StateProv>sample string 15</StateProv>
  <Suffix>sample string 7</Suffix>
  <UndeliverableAddress>true</UndeliverableAddress>
  <UndeliverableEmail>true</UndeliverableEmail>
  <UniqueID>cff71b2a-fe2b-4ad9-9c8d-b1f13684ccb5</UniqueID>
  <VIP>true</VIP>
  <WebMustChangePassword>true</WebMustChangePassword>
  <WebPassword>sample string 27</WebPassword>
  <WebPasswordRecoveryToken>df37f4b5-435d-4767-866e-8bb9fe38c0f2</WebPasswordRecoveryToken>
  <WebPasswordSalt>sample string 28</WebPasswordSalt>
  <WebPasswordTokenExpiration>2024-04-16T07:51:53.2984784-06:00</WebPasswordTokenExpiration>
  <WebURL>sample string 23</WebURL>
  <WebUsername>sample string 26</WebUsername>
  <WeddingDate>2024-04-16T07:51:53.2984784-06:00</WeddingDate>
</PartnerModel>