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": "fc020665-5c9d-4560-9076-83b081f961b8", "AffiliateClaimsStatusId": "c66fffe5-bdc7-4853-88fb-2e9c6ccecd5f", "AffiliateReference": "sample string 5", "AffiliateTypeId": "ee0e5a21-5585-4e18-9ef0-2eb582ca8f72", "AffiliateSourceId": "de1157f1-fe0f-4cf3-9513-2c1baddaaf69", "AffiliateStatusId": "e5af5676-1434-4c19-8eee-1308d9bb249b", "AffiliateStatusReasonId": "6b050d85-bd55-4543-98ce-9fde6e8411b2", "AgriaId": "sample string 6", "AppointedRepresentative": true, "AppointedRepresentativeStatusId": "74281c72-87cf-4953-962c-34f51cc133be", "AssocRegBefore": true, "BreederMembership": "8e21885d-92e5-4e9e-b88c-a2e7abe545a9", "BreederMembershipNumber": "sample string 7", "BuyingGroupParent": "sample string 8", "CharityId": "96f08902-e5de-4676-85de-92c1363e449a", "ClaimsEmailAddress": "sample string 9", "ComplianceCheck": true, "ContactById": "3fb41dcc-91d0-4a61-9a49-880e10da0697", "CountryId": "d5b3f192-3367-48a2-80db-f40a29549a89", "County": "sample string 10", "DateOfBirth": "2025-07-07T15:24:44.5695586+01:00", "DateLiveAsAr": "2025-07-07T15:24:44.5695586+01:00", "DateTrainedAsAr": "2025-07-07T15:24:44.5695586+01:00", "DonateToCharity": true, "EmailAddress": "sample string 11", "EstMonthlyRehomed": 1, "EstPrimaryVaccinations": 1, "ExternalPracticeReference": "sample string 12", "FaxNumber": "sample string 13", "FcaStatusId": "09ef0e24-11d5-413b-83c8-7d03104a5449", "Forename": "sample string 14", "HouseName": "sample string 15", "HouseNumber": "sample string 16", "Id": "773c96b6-8862-4f11-bfaa-5a80073f6e31", "KcAccredited": true, "KcBreederId": "sample string 17", "LitterReady": true, "LitterReadyDate": "2025-07-07T15:24:44.5695586+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": "c8bcdb91-b95b-4395-a81c-adb97d1157c8", "PostCode": "sample string 21", "PracticeManagementSystemUsed": "sample string 22", "PracticePartnerIds": [ "9e35d3b9-0a39-4f41-82a1-a18e8ec43d43", "cc86da1d-f170-4b72-9d22-6b8d63a0ad68" ], "PreferredBreeds": [ "c2241c9a-c45d-4272-98e8-2146960afd32", "f9dce891-79a9-46ea-b493-74aa8726bb5b" ], "PreferredEmail": true, "PreferredPost": true, "PreferredPhone": true, "PreferredSms": true, "PreferredSpecies": [ "9d3c4411-956a-49ae-972f-5d3c2c760ac9", "f887d26a-6d19-4d4c-9b25-b123443efe85" ], "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": [ "ac2f25b0-4a81-4e14-b6e3-145eb958b16e", "f5d52ca8-3e1c-4652-81d0-874ff23305f6" ], "VetClaimPaymentGroupId": "8577d151-62fa-404a-8218-1ea4f329c0cc", "VetGroupId": "9e77e5c5-bb44-4586-9aee-af338222169c", "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>fc020665-5c9d-4560-9076-83b081f961b8</AffiliateBusinessTypeId> <AffiliateClaimsStatusId>c66fffe5-bdc7-4853-88fb-2e9c6ccecd5f</AffiliateClaimsStatusId> <AffiliateReference>sample string 5</AffiliateReference> <AffiliateSourceId>de1157f1-fe0f-4cf3-9513-2c1baddaaf69</AffiliateSourceId> <AffiliateStatusId>e5af5676-1434-4c19-8eee-1308d9bb249b</AffiliateStatusId> <AffiliateStatusReasonId>6b050d85-bd55-4543-98ce-9fde6e8411b2</AffiliateStatusReasonId> <AffiliateTypeId>ee0e5a21-5585-4e18-9ef0-2eb582ca8f72</AffiliateTypeId> <AgriaId>sample string 6</AgriaId> <AppointedRepresentative>true</AppointedRepresentative> <AppointedRepresentativeStatusId>74281c72-87cf-4953-962c-34f51cc133be</AppointedRepresentativeStatusId> <AssocRegBefore>true</AssocRegBefore> <BreederMembership>8e21885d-92e5-4e9e-b88c-a2e7abe545a9</BreederMembership> <BreederMembershipNumber>sample string 7</BreederMembershipNumber> <BuyingGroupParent>sample string 8</BuyingGroupParent> <CharityId>96f08902-e5de-4676-85de-92c1363e449a</CharityId> <ClaimsEmailAddress>sample string 9</ClaimsEmailAddress> <ComplianceCheck>true</ComplianceCheck> <ContactById>3fb41dcc-91d0-4a61-9a49-880e10da0697</ContactById> <CountryId>d5b3f192-3367-48a2-80db-f40a29549a89</CountryId> <County>sample string 10</County> <DateLiveAsAr>2025-07-07T15:24:44.5695586+01:00</DateLiveAsAr> <DateOfBirth>2025-07-07T15:24:44.5695586+01:00</DateOfBirth> <DateTrainedAsAr>2025-07-07T15:24:44.5695586+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>09ef0e24-11d5-413b-83c8-7d03104a5449</FcaStatusId> <Forename>sample string 14</Forename> <HouseName>sample string 15</HouseName> <HouseNumber>sample string 16</HouseNumber> <Id>773c96b6-8862-4f11-bfaa-5a80073f6e31</Id> <KcAccredited>true</KcAccredited> <KcBreederId>sample string 17</KcBreederId> <LitterReady>true</LitterReady> <LitterReadyDate>2025-07-07T15:24:44.5695586+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>c8bcdb91-b95b-4395-a81c-adb97d1157c8</ParentAffiliateId> <PostCode>sample string 21</PostCode> <PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed> <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>9e35d3b9-0a39-4f41-82a1-a18e8ec43d43</d2p1:guid> <d2p1:guid>cc86da1d-f170-4b72-9d22-6b8d63a0ad68</d2p1:guid> </PracticePartnerIds> <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>c2241c9a-c45d-4272-98e8-2146960afd32</d2p1:guid> <d2p1:guid>f9dce891-79a9-46ea-b493-74aa8726bb5b</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>9d3c4411-956a-49ae-972f-5d3c2c760ac9</d2p1:guid> <d2p1:guid>f887d26a-6d19-4d4c-9b25-b123443efe85</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>ac2f25b0-4a81-4e14-b6e3-145eb958b16e</d2p1:guid> <d2p1:guid>f5d52ca8-3e1c-4652-81d0-874ff23305f6</d2p1:guid> </TypeIds> <VetClaimPaymentGroupId>8577d151-62fa-404a-8218-1ea4f329c0cc</VetClaimPaymentGroupId> <VetGroupId>9e77e5c5-bb44-4586-9aee-af338222169c</VetGroupId> <Website>sample string 30</Website> </Affiliate>