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": "7f35432a-ad21-4acf-8d6a-1646fc47464e",
"AffiliateClaimsStatusId": "886de80a-4109-4f57-bb0e-66859a5b33c3",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "87b51efd-0b75-4eb4-b466-55e3c7a478ce",
"AffiliateSourceId": "f3489aae-ce4b-4c8d-9aa5-3e08268f1679",
"AffiliateStatusId": "c4f1d492-3a82-478b-a7a3-eda801163e9f",
"AffiliateStatusReasonId": "604ad6a3-e8a8-4214-9bed-0b1a74d6b2dd",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "db5cb430-6cc5-4f2b-90fb-e339b3318c13",
"AssocRegBefore": true,
"BreederMembership": "f7efa301-2281-4df8-8e2b-dc5634945f52",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "48678f56-55f1-4ac3-8863-aa606cec178c",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "828898fb-75e5-4b95-9411-b8a9d1bb1f52",
"CountryId": "03a22af9-47c5-4d94-b9aa-faba968ef624",
"County": "sample string 10",
"DateOfBirth": "2026-08-15T11:00:21.8707833+01:00",
"DateLiveAsAr": "2026-08-15T11:00:21.8707833+01:00",
"DateTrainedAsAr": "2026-08-15T11:00:21.8707833+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "8033a297-5ec5-4f29-a91a-7765a587946a",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "f9bac4e8-6702-489e-a5e3-7e103df9864a",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-08-15T11:00:21.8707833+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": "e96bec03-76b2-41f4-872a-5607cc0948c4",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"f540020b-005c-40b5-9526-ce158bcb3485",
"e3dc1212-54cd-4c2a-b5de-68734527e7ea"
],
"PreferredBreeds": [
"2231cbf6-6443-48a3-b3df-633f57b8c511",
"e1ba6718-878f-4bd2-9ed1-4aa7e2452b6a"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"4c35d615-df45-493c-a7b3-9a1d77b9494e",
"77b7d43c-6fff-43bb-a1e5-14797b899c72"
],
"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": [
"d96c904b-8dab-401c-a361-fc0fd6cd432d",
"0416fc99-ba0a-4bdc-a216-f06a195cc8e3"
],
"VetClaimPaymentGroupId": "f140a13d-5ef1-4972-ba46-b561b5d23add",
"VetGroupId": "f75d09ed-ef91-4283-a2c4-56cac570e889",
"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>7f35432a-ad21-4acf-8d6a-1646fc47464e</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>886de80a-4109-4f57-bb0e-66859a5b33c3</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>f3489aae-ce4b-4c8d-9aa5-3e08268f1679</AffiliateSourceId>
<AffiliateStatusId>c4f1d492-3a82-478b-a7a3-eda801163e9f</AffiliateStatusId>
<AffiliateStatusReasonId>604ad6a3-e8a8-4214-9bed-0b1a74d6b2dd</AffiliateStatusReasonId>
<AffiliateTypeId>87b51efd-0b75-4eb4-b466-55e3c7a478ce</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>db5cb430-6cc5-4f2b-90fb-e339b3318c13</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>f7efa301-2281-4df8-8e2b-dc5634945f52</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>48678f56-55f1-4ac3-8863-aa606cec178c</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>828898fb-75e5-4b95-9411-b8a9d1bb1f52</ContactById>
<CountryId>03a22af9-47c5-4d94-b9aa-faba968ef624</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-08-15T11:00:21.8707833+01:00</DateLiveAsAr>
<DateOfBirth>2026-08-15T11:00:21.8707833+01:00</DateOfBirth>
<DateTrainedAsAr>2026-08-15T11:00:21.8707833+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>8033a297-5ec5-4f29-a91a-7765a587946a</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>f9bac4e8-6702-489e-a5e3-7e103df9864a</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-08-15T11:00:21.8707833+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>e96bec03-76b2-41f4-872a-5607cc0948c4</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f540020b-005c-40b5-9526-ce158bcb3485</d2p1:guid>
<d2p1:guid>e3dc1212-54cd-4c2a-b5de-68734527e7ea</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>2231cbf6-6443-48a3-b3df-633f57b8c511</d2p1:guid>
<d2p1:guid>e1ba6718-878f-4bd2-9ed1-4aa7e2452b6a</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>4c35d615-df45-493c-a7b3-9a1d77b9494e</d2p1:guid>
<d2p1:guid>77b7d43c-6fff-43bb-a1e5-14797b899c72</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>d96c904b-8dab-401c-a361-fc0fd6cd432d</d2p1:guid>
<d2p1:guid>0416fc99-ba0a-4bdc-a216-f06a195cc8e3</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>f140a13d-5ef1-4972-ba46-b561b5d23add</VetClaimPaymentGroupId>
<VetGroupId>f75d09ed-ef91-4283-a2c4-56cac570e889</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>