GET api/Affiliate/GetAffiliate?affiliateId={affiliateId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Affiliate| Name | 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": "48d475ae-46c1-4ab9-af8a-739c4ebf6c4e",
"AffiliateClaimsStatusId": "2d2bdf02-ca42-4ca7-88c4-219fe1910c0b",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "85c99516-3fa6-4b8a-b409-9e0c57be1d3b",
"AffiliateSourceId": "de62bba6-d221-4f63-8eae-f07f7c8a045b",
"AffiliateStatusId": "477f7415-30c8-4602-84a9-9de20bd04bfd",
"AffiliateStatusReasonId": "0150608b-af2d-4b4a-8ca2-2267699db433",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "e239b79f-4d06-4c03-8abe-1a237d05dfa1",
"AssocRegBefore": true,
"BreederMembership": "c2e45d98-2748-4abe-9a50-9f40a18ff4bd",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "1d4fcaad-3e10-4a22-8080-8b15f0ce413d",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "df3f3657-aaf4-4e22-abb5-831932207572",
"CountryId": "4b1a408f-4bae-4be0-8bb5-67ac37a9fcd4",
"County": "sample string 10",
"DateOfBirth": "2026-06-24T20:44:29.6574785+01:00",
"DateLiveAsAr": "2026-06-24T20:44:29.6574785+01:00",
"DateTrainedAsAr": "2026-06-24T20:44:29.6574785+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "7b32bc1e-7344-412f-b93c-ad61cb535686",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "9487c63d-3209-447d-afb1-dd3ff38e3b55",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-06-24T20:44:29.6574785+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": "7508fbaf-e215-4d91-a768-04ee365b9028",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"1f1d30b9-e73e-4593-b923-7779d593429c",
"c5563f2e-11d8-4b25-bfc6-d0f2fa00570d"
],
"PreferredBreeds": [
"5e18c3b8-7a69-4719-a4be-314938c44b18",
"e1c93d1d-34ff-48c2-8792-d3f3d8fc1a84"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"5ffdcacd-b9d2-4921-a66e-f2eb30870516",
"cabd996c-3bcb-4414-a5f1-2df6daccabba"
],
"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": [
"7bc05edc-3eeb-4035-8faf-63cff4a6da21",
"8a8b42bb-a045-434e-bc6a-66aa568d9d03"
],
"VetClaimPaymentGroupId": "63682cc2-ce3c-4150-97a3-eb236c976c82",
"VetGroupId": "7ba21f94-1448-4f2a-9ccb-47fbb6f0a69c",
"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>48d475ae-46c1-4ab9-af8a-739c4ebf6c4e</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>2d2bdf02-ca42-4ca7-88c4-219fe1910c0b</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>de62bba6-d221-4f63-8eae-f07f7c8a045b</AffiliateSourceId>
<AffiliateStatusId>477f7415-30c8-4602-84a9-9de20bd04bfd</AffiliateStatusId>
<AffiliateStatusReasonId>0150608b-af2d-4b4a-8ca2-2267699db433</AffiliateStatusReasonId>
<AffiliateTypeId>85c99516-3fa6-4b8a-b409-9e0c57be1d3b</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>e239b79f-4d06-4c03-8abe-1a237d05dfa1</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>c2e45d98-2748-4abe-9a50-9f40a18ff4bd</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>1d4fcaad-3e10-4a22-8080-8b15f0ce413d</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>df3f3657-aaf4-4e22-abb5-831932207572</ContactById>
<CountryId>4b1a408f-4bae-4be0-8bb5-67ac37a9fcd4</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-06-24T20:44:29.6574785+01:00</DateLiveAsAr>
<DateOfBirth>2026-06-24T20:44:29.6574785+01:00</DateOfBirth>
<DateTrainedAsAr>2026-06-24T20:44:29.6574785+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>7b32bc1e-7344-412f-b93c-ad61cb535686</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>9487c63d-3209-447d-afb1-dd3ff38e3b55</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-06-24T20:44:29.6574785+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>7508fbaf-e215-4d91-a768-04ee365b9028</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>1f1d30b9-e73e-4593-b923-7779d593429c</d2p1:guid>
<d2p1:guid>c5563f2e-11d8-4b25-bfc6-d0f2fa00570d</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>5e18c3b8-7a69-4719-a4be-314938c44b18</d2p1:guid>
<d2p1:guid>e1c93d1d-34ff-48c2-8792-d3f3d8fc1a84</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>5ffdcacd-b9d2-4921-a66e-f2eb30870516</d2p1:guid>
<d2p1:guid>cabd996c-3bcb-4414-a5f1-2df6daccabba</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>7bc05edc-3eeb-4035-8faf-63cff4a6da21</d2p1:guid>
<d2p1:guid>8a8b42bb-a045-434e-bc6a-66aa568d9d03</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>63682cc2-ce3c-4150-97a3-eb236c976c82</VetClaimPaymentGroupId>
<VetGroupId>7ba21f94-1448-4f2a-9ccb-47fbb6f0a69c</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>