URI parameters (2)

Include Optional Parameter

* Please contact Aegis Premier Technologies if you have not been assigned your unique {context} parameter.

Headers | Add header

: Delete

Body

Samples:

Status

Headers

Body

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

Retrieve a partner by using their ID as the look-up value.

Request Information

Parameter	Description	Additional information
text	The ID of the partner to look up.	Define this parameter in the request URI.

Requirements

Number	Notes
#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 Name	Notes
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.

Field Name

Notes

EmailPreference

Valid choices should be limited to either 'HTML', 'Text', or empty.

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",
      "Status": "sample string 3"
    },
    {
      "Type": "sample string 1",
      "Priority": 1,
      "Number": "sample string 2",
      "Status": "sample string 3"
    },
    {
      "Type": "sample string 1",
      "Priority": 1,
      "Number": "sample string 2",
      "Status": "sample string 3"
    }
  ],
  "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",
  "EmailStatus": "sample string 22",
  "EmailStatus2": "sample string 23",
  "EmailStatus3": "sample string 24",
  "EmailStatus4": "sample string 25",
  "EmailType": "sample string 26",
  "EmailType2": "sample string 27",
  "EmailType3": "sample string 28",
  "EmailType4": "sample string 29",
  "EmailPreference": "sample string 30",
  "WebURL": "sample string 31",
  "BirthDate": "2024-11-21T02:58:44.0884177-07:00",
  "WeddingDate": "2024-11-21T02:58:44.0884177-07:00",
  "MemberDate": "2024-11-21T02:58:44.0884177-07:00",
  "OriginSource": "sample string 32",
  "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 34",
  "WebPassword": "sample string 35",
  "WebMustChangePassword": true,
  "WebPasswordRecoveryToken": "e502e3e0-6fb6-4542-a659-ff514b14fc1f",
  "WebPasswordTokenExpiration": "2024-11-21T02:58:44.0884177-07:00",
  "CustomFlags": [
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-11-21T02:58:44.0884177-07:00",
      "ExpireDate": "2024-11-21T02:58:44.0884177-07:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-11-21T02:58:44.0884177-07:00",
      "ExpireDate": "2024-11-21T02:58:44.0884177-07:00"
    },
    {
      "FlagName": "sample string 1",
      "StartDate": "2024-11-21T02:58:44.0884177-07:00",
      "ExpireDate": "2024-11-21T02:58:44.0884177-07: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-11-21T02:58:44.0884177-07: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-11-21T02:58:44.0884177-07:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-11-21T02:58:44.0884177-07:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2024-11-21T02:58:44.0884177-07:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-11-21T02:58:44.0884177-07:00</StartDate>
    </PartnerModel.CustomFlagModel>
    <PartnerModel.CustomFlagModel>
      <ExpireDate>2024-11-21T02:58:44.0884177-07:00</ExpireDate>
      <FlagName>sample string 1</FlagName>
      <StartDate>2024-11-21T02:58:44.0884177-07: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 30</EmailPreference>
  <EmailStatus>sample string 22</EmailStatus>
  <EmailStatus2>sample string 23</EmailStatus2>
  <EmailStatus3>sample string 24</EmailStatus3>
  <EmailStatus4>sample string 25</EmailStatus4>
  <EmailType>sample string 26</EmailType>
  <EmailType2>sample string 27</EmailType2>
  <EmailType3>sample string 28</EmailType3>
  <EmailType4>sample string 29</EmailType4>
  <FirstName>sample string 4</FirstName>
  <ID>sample string 2</ID>
  <LastName>sample string 6</LastName>
  <MemberDate>2024-11-21T02:58:44.0884177-07: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 32</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>f1017faf-c993-45f6-b6af-9ee3da99bbf3</UniqueID>
  <VIP>true</VIP>
  <WebMustChangePassword>true</WebMustChangePassword>
  <WebPassword>sample string 35</WebPassword>
  <WebPasswordRecoveryToken>e502e3e0-6fb6-4542-a659-ff514b14fc1f</WebPasswordRecoveryToken>
  <WebPasswordSalt>sample string 36</WebPasswordSalt>
  <WebPasswordTokenExpiration>2024-11-21T02:58:44.0884177-07:00</WebPasswordTokenExpiration>
  <WebURL>sample string 31</WebURL>
  <WebUsername>sample string 34</WebUsername>
  <WeddingDate>2024-11-21T02:58:44.0884177-07:00</WeddingDate>
</PartnerModel>