GET api/Affiliate/Lookup?agriaId={agriaId}&email={email}&postcode={postcode}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
agriaId | string |
None. |
|
string |
None. |
||
postcode | string |
None. |
Body Parameters
None.
Response Information
Resource Description
AffiliateName | Description | Type | Additional information |
---|---|---|---|
ActivatorEmail | string |
None. |
|
ActualPrimaryVaccinations | integer |
None. |
|
AddressLine1 | string |
None. |
|
AddressLine2 | string |
None. |
|
AddressLine3 | string |
None. |
|
AffiliateBusinessTypeId | globally unique identifier |
None. |
|
AffiliateClaimsStatusId | globally unique identifier |
None. |
|
AffiliateReference | string |
None. |
|
AffiliateTypeId | globally unique identifier |
None. |
|
AffiliateSourceId | globally unique identifier |
None. |
|
AffiliateStatusId | globally unique identifier |
None. |
|
AffiliateStatusReasonId | globally unique identifier |
None. |
|
AgriaId | string |
None. |
|
AppointedRepresentative | boolean |
None. |
|
AppointedRepresentativeStatusId | globally unique identifier |
None. |
|
AssocRegBefore | boolean |
None. |
|
BreederMembership | globally unique identifier |
None. |
|
BreederMembershipNumber | string |
None. |
|
BuyingGroupParent | string |
None. |
|
CharityId | globally unique identifier |
None. |
|
ClaimsEmailAddress | string |
None. |
|
ComplianceCheck | boolean |
None. |
|
ContactById | globally unique identifier |
None. |
|
CountryId | globally unique identifier |
None. |
|
County | string |
None. |
|
DateOfBirth | date |
None. |
|
DateLiveAsAr | date |
None. |
|
DateTrainedAsAr | date |
None. |
|
DonateToCharity | boolean |
None. |
|
EmailAddress | string |
None. |
|
EstMonthlyRehomed | integer |
None. |
|
EstPrimaryVaccinations | integer |
None. |
|
ExternalPracticeReference | string |
None. |
|
FaxNumber | string |
None. |
|
FcaStatusId | globally unique identifier |
None. |
|
Forename | string |
None. |
|
HouseName | string |
None. |
|
HouseNumber | string |
None. |
|
Id | globally unique identifier |
None. |
|
KcAccredited | boolean |
None. |
|
KcBreederId | string |
None. |
|
LitterReady | boolean |
None. |
|
LitterReadyDate | date |
None. |
|
MiddleNames | string |
None. |
|
MobileNumber | string |
None. |
|
Name | string |
None. |
|
NumberOfBitchesQueens | integer |
None. |
|
NumberOfLittersPerYear | integer |
None. |
|
OptOutSms | boolean |
None. |
|
OptOutEmail | boolean |
None. |
|
OptOutPhone | boolean |
None. |
|
OptOutPost | boolean |
None. |
|
ParentAffiliateId | globally unique identifier |
None. |
|
PostCode | string |
None. |
|
PracticeManagementSystemUsed | string |
None. |
|
PracticePartnerIds | Collection of globally unique identifier |
None. |
|
PreferredBreeds | Collection of globally unique identifier |
None. |
|
PreferredEmail | boolean |
None. |
|
PreferredPost | boolean |
None. |
|
PreferredPhone | boolean |
None. |
|
PreferredSms | boolean |
None. |
|
PreferredSpecies | Collection of globally unique identifier |
None. |
|
PrincipalEmail | string |
None. |
|
Rating | string |
None. |
|
RewardAmount | decimal number |
None. |
|
RvcCode | string |
None. |
|
SelfBreedAllLittersSold | boolean |
None. |
|
SubjectToInvestigation | boolean |
None. |
|
Surname | string |
None. |
|
TelephoneNumber | string |
None. |
|
Town | string |
None. |
|
TradingName | string |
None. |
|
TypeIds | Collection of globally unique identifier |
None. |
|
VetClaimPaymentGroupId | globally unique identifier |
None. |
|
VetGroupId | globally unique identifier |
None. |
|
Website | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ActivatorEmail": "sample string 1", "ActualPrimaryVaccinations": 1, "AddressLine1": "sample string 2", "AddressLine2": "sample string 3", "AddressLine3": "sample string 4", "AffiliateBusinessTypeId": "f21f8967-ffe4-4627-8447-40842022e0a1", "AffiliateClaimsStatusId": "c6e50a27-1dbf-4999-9ccf-77854a401de8", "AffiliateReference": "sample string 5", "AffiliateTypeId": "42f32a75-1b69-4a7c-aaba-10eae29097a8", "AffiliateSourceId": "f84ef98f-58be-4640-b7cb-4a324383b76a", "AffiliateStatusId": "6e7fc07b-bb3c-4160-a693-523874875337", "AffiliateStatusReasonId": "6422a0d5-c347-4d10-b781-ab078a9ebbfd", "AgriaId": "sample string 6", "AppointedRepresentative": true, "AppointedRepresentativeStatusId": "e3c5fd0f-8171-43a4-b7af-5a0c143fdc32", "AssocRegBefore": true, "BreederMembership": "fc7c1cb3-43c1-4477-8082-ea9381e479b2", "BreederMembershipNumber": "sample string 7", "BuyingGroupParent": "sample string 8", "CharityId": "cfbde31b-de7d-4c8b-8267-b038e04d6369", "ClaimsEmailAddress": "sample string 9", "ComplianceCheck": true, "ContactById": "bdec33d5-a53f-424f-9cf5-66ae1c0c6039", "CountryId": "756488e5-e9eb-4778-95e3-50bc62836cfd", "County": "sample string 10", "DateOfBirth": "2025-08-27T03:36:03.9210652+01:00", "DateLiveAsAr": "2025-08-27T03:36:03.9210652+01:00", "DateTrainedAsAr": "2025-08-27T03:36:03.9210652+01:00", "DonateToCharity": true, "EmailAddress": "sample string 11", "EstMonthlyRehomed": 1, "EstPrimaryVaccinations": 1, "ExternalPracticeReference": "sample string 12", "FaxNumber": "sample string 13", "FcaStatusId": "dfadb685-0cae-4aed-8338-a13a9302eec1", "Forename": "sample string 14", "HouseName": "sample string 15", "HouseNumber": "sample string 16", "Id": "8706b6fd-a02e-4f08-b17f-a8358cae4b49", "KcAccredited": true, "KcBreederId": "sample string 17", "LitterReady": true, "LitterReadyDate": "2025-08-27T03:36:03.9210652+01:00", "MiddleNames": "sample string 18", "MobileNumber": "sample string 19", "Name": "sample string 20", "NumberOfBitchesQueens": 1, "NumberOfLittersPerYear": 1, "OptOutSms": true, "OptOutEmail": true, "OptOutPhone": true, "OptOutPost": true, "ParentAffiliateId": "4a7d86b1-a25e-4aa2-8698-2da39c565a50", "PostCode": "sample string 21", "PracticeManagementSystemUsed": "sample string 22", "PracticePartnerIds": [ "a6262f58-31a3-4f15-af32-0f5aa0df13a1", "62012a2b-685a-4bd2-bc66-e02661621110" ], "PreferredBreeds": [ "786f9271-2cb2-4d84-8665-06b82d5ca294", "c4ae8125-82a2-4fe5-a7a2-16db3c49bdcc" ], "PreferredEmail": true, "PreferredPost": true, "PreferredPhone": true, "PreferredSms": true, "PreferredSpecies": [ "a7c4641a-030f-48d7-bddf-350031d462c9", "333d872e-6252-49dd-900b-3625579aee22" ], "PrincipalEmail": "sample string 23", "Rating": "sample string 24", "RewardAmount": 1.0, "RvcCode": "sample string 25", "SelfBreedAllLittersSold": true, "SubjectToInvestigation": true, "Surname": "sample string 26", "TelephoneNumber": "sample string 27", "Town": "sample string 28", "TradingName": "sample string 29", "TypeIds": [ "dc4208dc-205c-493c-9a89-1735518b18f0", "0bb83435-b35b-4ce2-a2f5-c6e63e9190d0" ], "VetClaimPaymentGroupId": "55fdaa64-41d4-4d66-a931-b835b2696682", "VetGroupId": "c1954e33-cbc5-4ecb-875e-d02c309ea536", "Website": "sample string 30" }
application/xml, text/xml
Sample:
<Affiliate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tss.Eitr.Customer.Agria.WebApi.Models"> <ActivatorEmail>sample string 1</ActivatorEmail> <ActualPrimaryVaccinations>1</ActualPrimaryVaccinations> <AddressLine1>sample string 2</AddressLine1> <AddressLine2>sample string 3</AddressLine2> <AddressLine3>sample string 4</AddressLine3> <AffiliateBusinessTypeId>f21f8967-ffe4-4627-8447-40842022e0a1</AffiliateBusinessTypeId> <AffiliateClaimsStatusId>c6e50a27-1dbf-4999-9ccf-77854a401de8</AffiliateClaimsStatusId> <AffiliateReference>sample string 5</AffiliateReference> <AffiliateSourceId>f84ef98f-58be-4640-b7cb-4a324383b76a</AffiliateSourceId> <AffiliateStatusId>6e7fc07b-bb3c-4160-a693-523874875337</AffiliateStatusId> <AffiliateStatusReasonId>6422a0d5-c347-4d10-b781-ab078a9ebbfd</AffiliateStatusReasonId> <AffiliateTypeId>42f32a75-1b69-4a7c-aaba-10eae29097a8</AffiliateTypeId> <AgriaId>sample string 6</AgriaId> <AppointedRepresentative>true</AppointedRepresentative> <AppointedRepresentativeStatusId>e3c5fd0f-8171-43a4-b7af-5a0c143fdc32</AppointedRepresentativeStatusId> <AssocRegBefore>true</AssocRegBefore> <BreederMembership>fc7c1cb3-43c1-4477-8082-ea9381e479b2</BreederMembership> <BreederMembershipNumber>sample string 7</BreederMembershipNumber> <BuyingGroupParent>sample string 8</BuyingGroupParent> <CharityId>cfbde31b-de7d-4c8b-8267-b038e04d6369</CharityId> <ClaimsEmailAddress>sample string 9</ClaimsEmailAddress> <ComplianceCheck>true</ComplianceCheck> <ContactById>bdec33d5-a53f-424f-9cf5-66ae1c0c6039</ContactById> <CountryId>756488e5-e9eb-4778-95e3-50bc62836cfd</CountryId> <County>sample string 10</County> <DateLiveAsAr>2025-08-27T03:36:03.9210652+01:00</DateLiveAsAr> <DateOfBirth>2025-08-27T03:36:03.9210652+01:00</DateOfBirth> <DateTrainedAsAr>2025-08-27T03:36:03.9210652+01:00</DateTrainedAsAr> <DonateToCharity>true</DonateToCharity> <EmailAddress>sample string 11</EmailAddress> <EstMonthlyRehomed>1</EstMonthlyRehomed> <EstPrimaryVaccinations>1</EstPrimaryVaccinations> <ExternalPracticeReference>sample string 12</ExternalPracticeReference> <FaxNumber>sample string 13</FaxNumber> <FcaStatusId>dfadb685-0cae-4aed-8338-a13a9302eec1</FcaStatusId> <Forename>sample string 14</Forename> <HouseName>sample string 15</HouseName> <HouseNumber>sample string 16</HouseNumber> <Id>8706b6fd-a02e-4f08-b17f-a8358cae4b49</Id> <KcAccredited>true</KcAccredited> <KcBreederId>sample string 17</KcBreederId> <LitterReady>true</LitterReady> <LitterReadyDate>2025-08-27T03:36:03.9210652+01:00</LitterReadyDate> <MiddleNames>sample string 18</MiddleNames> <MobileNumber>sample string 19</MobileNumber> <Name>sample string 20</Name> <NumberOfBitchesQueens>1</NumberOfBitchesQueens> <NumberOfLittersPerYear>1</NumberOfLittersPerYear> <OptOutEmail>true</OptOutEmail> <OptOutPhone>true</OptOutPhone> <OptOutPost>true</OptOutPost> <OptOutSms>true</OptOutSms> <ParentAffiliateId>4a7d86b1-a25e-4aa2-8698-2da39c565a50</ParentAffiliateId> <PostCode>sample string 21</PostCode> <PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed> <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>a6262f58-31a3-4f15-af32-0f5aa0df13a1</d2p1:guid> <d2p1:guid>62012a2b-685a-4bd2-bc66-e02661621110</d2p1:guid> </PracticePartnerIds> <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>786f9271-2cb2-4d84-8665-06b82d5ca294</d2p1:guid> <d2p1:guid>c4ae8125-82a2-4fe5-a7a2-16db3c49bdcc</d2p1:guid> </PreferredBreeds> <PreferredEmail>true</PreferredEmail> <PreferredPhone>true</PreferredPhone> <PreferredPost>true</PreferredPost> <PreferredSms>true</PreferredSms> <PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>a7c4641a-030f-48d7-bddf-350031d462c9</d2p1:guid> <d2p1:guid>333d872e-6252-49dd-900b-3625579aee22</d2p1:guid> </PreferredSpecies> <PrincipalEmail>sample string 23</PrincipalEmail> <Rating>sample string 24</Rating> <RewardAmount>1</RewardAmount> <RvcCode>sample string 25</RvcCode> <SelfBreedAllLittersSold>true</SelfBreedAllLittersSold> <SubjectToInvestigation>true</SubjectToInvestigation> <Surname>sample string 26</Surname> <TelephoneNumber>sample string 27</TelephoneNumber> <Town>sample string 28</Town> <TradingName>sample string 29</TradingName> <TypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>dc4208dc-205c-493c-9a89-1735518b18f0</d2p1:guid> <d2p1:guid>0bb83435-b35b-4ce2-a2f5-c6e63e9190d0</d2p1:guid> </TypeIds> <VetClaimPaymentGroupId>55fdaa64-41d4-4d66-a931-b835b2696682</VetClaimPaymentGroupId> <VetGroupId>c1954e33-cbc5-4ecb-875e-d02c309ea536</VetGroupId> <Website>sample string 30</Website> </Affiliate>