GET api/referrals/attorneys/{affiliateCode}
This method will retrieve real estate professional's data by their affiliate code
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateCode |
Affiliate code assigned to each attorney/real estate agent |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Instance of
RealEstateProfessionalPo| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Role | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| CountyId | integer |
None. |
|
| CountyName | string |
None. |
|
| CompanyName | string |
None. |
|
| AddressLine1 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Fax | string |
None. |
|
| CellPhone | string |
None. |
|
| Avatar | string |
None. |
|
| Logo | string |
None. |
|
| string |
None. |
||
| WebsiteUrl | string |
None. |
|
| PracticeArea | string |
None. |
|
| PracticeStartYear | integer |
None. |
|
| IsPreferred | boolean |
None. |
|
| Bio | string |
None. |
|
| StarRating | integer |
None. |
|
| AddedDate | date |
None. |
|
| LastModifiedDate | date |
None. |
|
| AppealFeeOverride | decimal number |
None. |
|
| DiscountPercent | decimal number |
None. |
|
| AffiliateCode | string |
None. |
|
| ContingencyFee | decimal number |
None. |
|
| IndvidualGiftDiscount | decimal number |
None. |
|
| IsBannerVisible | boolean |
None. |
|
| ClientColor | string |
None. |
|
| ClientLogo | string |
None. |
|
| AppealFeeAmount | decimal number |
None. |
|
| AnalysisFeeAmount | decimal number |
None. |
|
| ReferralFeeAmount | decimal number |
None. |
|
| ForwardSiteReferrals | boolean |
None. |
|
| ReferralFeeToPtfAmount | decimal number |
None. |
|
| UserReportIdentifier | string |
None. |
|
| DisplayAppealDiscountBox | boolean |
None. |
|
| DisplayHowToStartInstructions | boolean |
None. |
|
| RequireUserRegistration | boolean |
None. |
|
| CollectAnalysisFee | boolean |
None. |
|
| IFrameBannerImageUrl | string |
None. |
|
| IsActiveSubscriber | boolean |
None. |
|
| IFrameEmailReportToWebUser | boolean |
None. |
|
| IFrameEnabledAppeal | boolean |
None. |
|
| IFrameEnabledAppealGuarantee | boolean |
None. |
|
| DigitalSignaturePackageUrl | string |
None. |
|
| AuthorizationRequiredPopupText | string |
None. |
|
| DocumentsRequestedPopupText | string |
None. |
|
| SignatureRequiredPopupText | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"role": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"countyId": 5,
"countyName": "sample string 6",
"companyName": "sample string 7",
"addressLine1": "sample string 8",
"city": "sample string 9",
"state": "sample string 10",
"zip": "sample string 11",
"phoneNumber": "sample string 12",
"fax": "sample string 13",
"cellPhone": "sample string 14",
"avatar": "sample string 15",
"logo": "sample string 16",
"email": "sample string 17",
"websiteUrl": "sample string 18",
"practiceArea": "sample string 19",
"practiceStartYear": 1,
"isPreferred": true,
"bio": "sample string 21",
"starRating": 22,
"addedDate": "2025-11-01T05:55:53.9837849-05:00",
"lastModifiedDate": "2025-11-01T05:55:53.9837849-05:00",
"appealFeeOverride": 1.0,
"discountPercent": 1.0,
"affiliateCode": "sample string 24",
"contingencyFee": 1.0,
"indvidualGiftDiscount": 1.0,
"isBannerVisible": true,
"clientColor": "sample string 26",
"clientLogo": "sample string 27",
"appealFeeAmount": 28.0,
"analysisFeeAmount": 29.0,
"referralFeeAmount": 30.0,
"forwardSiteReferrals": true,
"referralFeeToPtfAmount": 32.0,
"userReportIdentifier": "sample string 33",
"displayAppealDiscountBox": true,
"displayHowToStartInstructions": true,
"requireUserRegistration": true,
"collectAnalysisFee": true,
"iFrameBannerImageUrl": "sample string 38",
"isActiveSubscriber": true,
"iFrameEmailReportToWebUser": true,
"iFrameEnabledAppeal": true,
"iFrameEnabledAppealGuarantee": true,
"digitalSignaturePackageUrl": "sample string 43",
"authorizationRequiredPopupText": "sample string 44",
"documentsRequestedPopupText": "sample string 45",
"signatureRequiredPopupText": "sample string 46"
}
text/html
Sample:
{"id":1,"role":"sample string 2","firstName":"sample string 3","lastName":"sample string 4","countyId":5,"countyName":"sample string 6","companyName":"sample string 7","addressLine1":"sample string 8","city":"sample string 9","state":"sample string 10","zip":"sample string 11","phoneNumber":"sample string 12","fax":"sample string 13","cellPhone":"sample string 14","avatar":"sample string 15","logo":"sample string 16","email":"sample string 17","websiteUrl":"sample string 18","practiceArea":"sample string 19","practiceStartYear":1,"isPreferred":true,"bio":"sample string 21","starRating":22,"addedDate":"2025-11-01T05:55:53.9837849-05:00","lastModifiedDate":"2025-11-01T05:55:53.9837849-05:00","appealFeeOverride":1.0,"discountPercent":1.0,"affiliateCode":"sample string 24","contingencyFee":1.0,"indvidualGiftDiscount":1.0,"isBannerVisible":true,"clientColor":"sample string 26","clientLogo":"sample string 27","appealFeeAmount":28.0,"analysisFeeAmount":29.0,"referralFeeAmount":30.0,"forwardSiteReferrals":true,"referralFeeToPtfAmount":32.0,"userReportIdentifier":"sample string 33","displayAppealDiscountBox":true,"displayHowToStartInstructions":true,"requireUserRegistration":true,"collectAnalysisFee":true,"iFrameBannerImageUrl":"sample string 38","isActiveSubscriber":true,"iFrameEmailReportToWebUser":true,"iFrameEnabledAppeal":true,"iFrameEnabledAppealGuarantee":true,"digitalSignaturePackageUrl":"sample string 43","authorizationRequiredPopupText":"sample string 44","documentsRequestedPopupText":"sample string 45","signatureRequiredPopupText":"sample string 46"}
application/xml, text/xml
Sample:
<RealEstateProfessionalPo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos"> <AddedDate>2025-11-01T05:55:53.9837849-05:00</AddedDate> <AddressLine1>sample string 8</AddressLine1> <AffiliateCode>sample string 24</AffiliateCode> <AnalysisFeeAmount>29</AnalysisFeeAmount> <AppealFeeAmount>28</AppealFeeAmount> <AppealFeeOverride>1</AppealFeeOverride> <AuthorizationRequiredPopupText>sample string 44</AuthorizationRequiredPopupText> <Avatar>sample string 15</Avatar> <Bio>sample string 21</Bio> <CellPhone>sample string 14</CellPhone> <City>sample string 9</City> <ClientColor>sample string 26</ClientColor> <ClientLogo>sample string 27</ClientLogo> <CollectAnalysisFee>true</CollectAnalysisFee> <CompanyName>sample string 7</CompanyName> <ContingencyFee>1</ContingencyFee> <CountyId>5</CountyId> <CountyName>sample string 6</CountyName> <DigitalSignaturePackageUrl>sample string 43</DigitalSignaturePackageUrl> <DiscountPercent>1</DiscountPercent> <DisplayAppealDiscountBox>true</DisplayAppealDiscountBox> <DisplayHowToStartInstructions>true</DisplayHowToStartInstructions> <DocumentsRequestedPopupText>sample string 45</DocumentsRequestedPopupText> <Email>sample string 17</Email> <Fax>sample string 13</Fax> <FirstName>sample string 3</FirstName> <ForwardSiteReferrals>true</ForwardSiteReferrals> <IFrameBannerImageUrl>sample string 38</IFrameBannerImageUrl> <IFrameEmailReportToWebUser>true</IFrameEmailReportToWebUser> <IFrameEnabledAppeal>true</IFrameEnabledAppeal> <IFrameEnabledAppealGuarantee>true</IFrameEnabledAppealGuarantee> <Id>1</Id> <IndvidualGiftDiscount>1</IndvidualGiftDiscount> <IsActiveSubscriber>true</IsActiveSubscriber> <IsBannerVisible>true</IsBannerVisible> <IsPreferred>true</IsPreferred> <LastModifiedDate>2025-11-01T05:55:53.9837849-05:00</LastModifiedDate> <LastName>sample string 4</LastName> <Logo>sample string 16</Logo> <PhoneNumber>sample string 12</PhoneNumber> <PracticeArea>sample string 19</PracticeArea> <PracticeStartYear>1</PracticeStartYear> <ReferralFeeAmount>30</ReferralFeeAmount> <ReferralFeeToPtfAmount>32</ReferralFeeToPtfAmount> <RequireUserRegistration>true</RequireUserRegistration> <Role>sample string 2</Role> <SignatureRequiredPopupText>sample string 46</SignatureRequiredPopupText> <StarRating>22</StarRating> <State>sample string 10</State> <UserReportIdentifier>sample string 33</UserReportIdentifier> <WebsiteUrl>sample string 18</WebsiteUrl> <Zip>sample string 11</Zip> </RealEstateProfessionalPo>