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": "dd995f0b-f525-40dd-aac6-9b1baf9afa53", "AffiliateClaimsStatusId": "bc771c3e-e594-4bb7-b60e-47e1f0da662f", "AffiliateReference": "sample string 5", "AffiliateTypeId": "0bbb79ae-4318-4cc2-92b5-766a69933450", "AffiliateSourceId": "d2e9a46f-40dd-4eec-93ac-1bad1d65125c", "AffiliateStatusId": "57cf27aa-54b4-4622-9cb8-a7536990442b", "AffiliateStatusReasonId": "84e995cd-fde4-4aae-aaf1-2c4e4cecd200", "AgriaId": "sample string 6", "AppointedRepresentative": true, "AppointedRepresentativeStatusId": "b0eaced0-1eeb-4925-b01e-67e056169f3c", "AssocRegBefore": true, "BreederMembership": "38ca2dab-1246-4da7-b499-478dddcbde0d", "BreederMembershipNumber": "sample string 7", "BuyingGroupParent": "sample string 8", "CharityId": "e20e6b82-845d-449c-8a45-f64a9d570352", "ClaimsEmailAddress": "sample string 9", "ComplianceCheck": true, "ContactById": "b9d4be94-0e1e-46c8-84d1-18a8cd5ce7eb", "CountryId": "cc3feee0-9b02-41c4-bbbc-069edb072090", "County": "sample string 10", "DateOfBirth": "2025-09-13T03:27:12.1192578+01:00", "DateLiveAsAr": "2025-09-13T03:27:12.1192578+01:00", "DateTrainedAsAr": "2025-09-13T03:27:12.1192578+01:00", "DonateToCharity": true, "EmailAddress": "sample string 11", "EstMonthlyRehomed": 1, "EstPrimaryVaccinations": 1, "ExternalPracticeReference": "sample string 12", "FaxNumber": "sample string 13", "FcaStatusId": "1714e386-194e-498e-be27-d028d5089603", "Forename": "sample string 14", "HouseName": "sample string 15", "HouseNumber": "sample string 16", "Id": "208a6374-bbcd-474c-983a-7d3e22d762c8", "KcAccredited": true, "KcBreederId": "sample string 17", "LitterReady": true, "LitterReadyDate": "2025-09-13T03:27:12.1192578+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": "1b577ff5-4011-4c4f-8bba-680c5ab96da5", "PostCode": "sample string 21", "PracticeManagementSystemUsed": "sample string 22", "PracticePartnerIds": [ "331cd1a9-87ee-4cb1-95af-5a09a6cead20", "3eb57ff7-172d-40d9-8cca-c7625ac1f4d2" ], "PreferredBreeds": [ "5416e311-dc3e-4ca0-add9-c6b4bb00d73d", "6476c864-d268-44c6-a449-754131caa4cf" ], "PreferredEmail": true, "PreferredPost": true, "PreferredPhone": true, "PreferredSms": true, "PreferredSpecies": [ "53ab98e9-a992-4152-b4c4-b31699e1bcf2", "bab3a431-11d5-4ba6-88c2-c05734488355" ], "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": [ "6b0e2415-ed95-470b-97ca-81fa989273ea", "43b0c330-bd29-47b1-9d96-ed588923e170" ], "VetClaimPaymentGroupId": "c0b84611-98a6-45b8-9844-8b72d93e6760", "VetGroupId": "db99badc-0dad-41cf-b71d-5126c5ed977a", "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>dd995f0b-f525-40dd-aac6-9b1baf9afa53</AffiliateBusinessTypeId> <AffiliateClaimsStatusId>bc771c3e-e594-4bb7-b60e-47e1f0da662f</AffiliateClaimsStatusId> <AffiliateReference>sample string 5</AffiliateReference> <AffiliateSourceId>d2e9a46f-40dd-4eec-93ac-1bad1d65125c</AffiliateSourceId> <AffiliateStatusId>57cf27aa-54b4-4622-9cb8-a7536990442b</AffiliateStatusId> <AffiliateStatusReasonId>84e995cd-fde4-4aae-aaf1-2c4e4cecd200</AffiliateStatusReasonId> <AffiliateTypeId>0bbb79ae-4318-4cc2-92b5-766a69933450</AffiliateTypeId> <AgriaId>sample string 6</AgriaId> <AppointedRepresentative>true</AppointedRepresentative> <AppointedRepresentativeStatusId>b0eaced0-1eeb-4925-b01e-67e056169f3c</AppointedRepresentativeStatusId> <AssocRegBefore>true</AssocRegBefore> <BreederMembership>38ca2dab-1246-4da7-b499-478dddcbde0d</BreederMembership> <BreederMembershipNumber>sample string 7</BreederMembershipNumber> <BuyingGroupParent>sample string 8</BuyingGroupParent> <CharityId>e20e6b82-845d-449c-8a45-f64a9d570352</CharityId> <ClaimsEmailAddress>sample string 9</ClaimsEmailAddress> <ComplianceCheck>true</ComplianceCheck> <ContactById>b9d4be94-0e1e-46c8-84d1-18a8cd5ce7eb</ContactById> <CountryId>cc3feee0-9b02-41c4-bbbc-069edb072090</CountryId> <County>sample string 10</County> <DateLiveAsAr>2025-09-13T03:27:12.1192578+01:00</DateLiveAsAr> <DateOfBirth>2025-09-13T03:27:12.1192578+01:00</DateOfBirth> <DateTrainedAsAr>2025-09-13T03:27:12.1192578+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>1714e386-194e-498e-be27-d028d5089603</FcaStatusId> <Forename>sample string 14</Forename> <HouseName>sample string 15</HouseName> <HouseNumber>sample string 16</HouseNumber> <Id>208a6374-bbcd-474c-983a-7d3e22d762c8</Id> <KcAccredited>true</KcAccredited> <KcBreederId>sample string 17</KcBreederId> <LitterReady>true</LitterReady> <LitterReadyDate>2025-09-13T03:27:12.1192578+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>1b577ff5-4011-4c4f-8bba-680c5ab96da5</ParentAffiliateId> <PostCode>sample string 21</PostCode> <PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed> <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>331cd1a9-87ee-4cb1-95af-5a09a6cead20</d2p1:guid> <d2p1:guid>3eb57ff7-172d-40d9-8cca-c7625ac1f4d2</d2p1:guid> </PracticePartnerIds> <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>5416e311-dc3e-4ca0-add9-c6b4bb00d73d</d2p1:guid> <d2p1:guid>6476c864-d268-44c6-a449-754131caa4cf</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>53ab98e9-a992-4152-b4c4-b31699e1bcf2</d2p1:guid> <d2p1:guid>bab3a431-11d5-4ba6-88c2-c05734488355</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>6b0e2415-ed95-470b-97ca-81fa989273ea</d2p1:guid> <d2p1:guid>43b0c330-bd29-47b1-9d96-ed588923e170</d2p1:guid> </TypeIds> <VetClaimPaymentGroupId>c0b84611-98a6-45b8-9844-8b72d93e6760</VetClaimPaymentGroupId> <VetGroupId>db99badc-0dad-41cf-b71d-5126c5ed977a</VetGroupId> <Website>sample string 30</Website> </Affiliate>