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

Retrieve a partner by using their username 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 Username in the Aegis CRM database.
This means that multiple partners can potentially have the same Username.
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 WebUserName 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",
  "EmailPreference": "sample string 19",
  "WebURL": "sample string 20",
  "BirthDate": "2020-08-04T11:05:39.798349-06:00",
  "WeddingDate": "2020-08-04T11:05:39.798349-06:00",
  "MemberDate": "2020-08-04T11:05:39.798349-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": "6d2fc5f1-9bfe-42f0-9090-7c37b20d13d7",
  "WebPasswordTokenExpiration": "2020-08-04T11:05:39.798349-06:00",
  "CustomFlags": [
    {
      "FlagName": "sample string 1",
      "StartDate": "2020-08-04T11:05:39.798349-06:00",
      "ExpireDate": "2020-08-04T11:05:39.798349-06:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2020-08-04T11:05:39.798349-06:00",
      "ExpireDate": "2020-08-04T11:05:39.798349-06:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2020-08-04T11:05:39.798349-06:00",
      "ExpireDate": "2020-08-04T11:05:39.798349-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>2020-08-04T11:05:39.798349-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>2020-08-04T11:05:39.798349-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2020-08-04T11:05:39.798349-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2020-08-04T11:05:39.798349-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2020-08-04T11:05:39.798349-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2020-08-04T11:05:39.798349-06:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2020-08-04T11:05:39.798349-06:00</StartDate>
    </PartnerModel.CustomFlagModel>
  </CustomFlags>
  <Deceased>true</Deceased>
  <Email>sample string 18</Email>
  <EmailPreference>sample string 19</EmailPreference>
  <FirstName>sample string 4</FirstName>
  <ID>sample string 2</ID>
  <LastName>sample string 6</LastName>
  <MemberDate>2020-08-04T11:05:39.798349-06:00</MemberDate>
  <MiddleName>sample string 5</MiddleName>
  <NoAddressStandardization>true</NoAddressStandardization>
  <NoDirectMail>true</NoDirectMail>
  <NoEmailSolicitation>true</NoEmailSolicitation>
  <NoMerge>true</NoMerge>
  <NoPhoneSolicitation>true</NoPhoneSolicitation>
  <NoResponseEmails>true</NoResponseEmails>
  <NoResponseLetters>true</NoResponseLetters>
  <NoTaxStatements>true</NoTaxStatements>
  <OriginSource>sample string 21</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>7f778873-4281-438b-81ab-9a17f8d1929f</UniqueID>
  <VIP>true</VIP>
  <WebMustChangePassword>true</WebMustChangePassword>
  <WebPassword>sample string 37</WebPassword>
  <WebPasswordRecoveryToken>6d2fc5f1-9bfe-42f0-9090-7c37b20d13d7</WebPasswordRecoveryToken>
  <WebPasswordSalt>sample string 38</WebPasswordSalt>
  <WebPasswordTokenExpiration>2020-08-04T11:05:39.798349-06:00</WebPasswordTokenExpiration>
  <WebURL>sample string 20</WebURL>
  <WebUsername>sample string 36</WebUsername>
  <WeddingDate>2020-08-04T11:05:39.798349-06:00</WeddingDate>
</PartnerModel>