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": "eababaa4-8ff2-4cc2-8346-c60d74629f89",
"AffiliateClaimsStatusId": "1c380fb1-b614-4f85-9df7-ef412f599042",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "42e6268c-f090-46cb-81b1-171fae677cac",
"AffiliateSourceId": "b571428a-c102-4e5a-be84-363f61c4235c",
"AffiliateStatusId": "88d62ed0-98c5-45c4-995e-cd19f77df23d",
"AffiliateStatusReasonId": "a03a03c6-a7d2-487f-b9a0-74b7b0556964",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "a9e6905e-ad0b-42cd-bc9a-429d19f51853",
"AssocRegBefore": true,
"BreederMembership": "48bdf217-7df0-4547-9997-328b9bcdd04d",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "c1b1cc02-4f84-4d6c-b361-683d9ad0c0ef",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "4ce885f2-e77b-4ee1-91f6-a36a0bb9bd3d",
"CountryId": "0a14384b-f5b7-478a-8672-fbe9a42709d0",
"County": "sample string 10",
"DateOfBirth": "2025-09-13T03:25:55.0101334+01:00",
"DateLiveAsAr": "2025-09-13T03:25:55.0101334+01:00",
"DateTrainedAsAr": "2025-09-13T03:25:55.0101334+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "ab891da1-8987-4356-a3d7-211dbdc3c4d1",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "106b1ee1-f2ca-4a29-aa58-22e91b7aa8c9",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2025-09-13T03:25:55.0101334+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": "5e76b805-02ea-4ef9-a185-e83d7afdc713",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"6afd9a9d-f0e9-4e33-b7c0-8b740378cfe3",
"c2b29971-37b7-494e-beb8-328a27d767fe"
],
"PreferredBreeds": [
"b3830580-7658-46e9-a543-08d129a6083a",
"f6e6b110-8641-4b81-9974-eb384dd98dd4"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"b57f7595-af3a-43be-9c1e-8f6e226a195f",
"ccdedb16-fbea-4dbc-bc47-ebc3013a1152"
],
"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": [
"09c57638-4eed-45d4-b7aa-adb08cd41eeb",
"cf230eb6-1dff-4066-95f2-412d0dc642dd"
],
"VetClaimPaymentGroupId": "48560640-0733-4aa5-936c-015c69fbf7a0",
"VetGroupId": "118c1833-b935-417d-bdd0-b9b8ef768567",
"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>eababaa4-8ff2-4cc2-8346-c60d74629f89</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>1c380fb1-b614-4f85-9df7-ef412f599042</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>b571428a-c102-4e5a-be84-363f61c4235c</AffiliateSourceId>
<AffiliateStatusId>88d62ed0-98c5-45c4-995e-cd19f77df23d</AffiliateStatusId>
<AffiliateStatusReasonId>a03a03c6-a7d2-487f-b9a0-74b7b0556964</AffiliateStatusReasonId>
<AffiliateTypeId>42e6268c-f090-46cb-81b1-171fae677cac</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>a9e6905e-ad0b-42cd-bc9a-429d19f51853</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>48bdf217-7df0-4547-9997-328b9bcdd04d</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>c1b1cc02-4f84-4d6c-b361-683d9ad0c0ef</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>4ce885f2-e77b-4ee1-91f6-a36a0bb9bd3d</ContactById>
<CountryId>0a14384b-f5b7-478a-8672-fbe9a42709d0</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2025-09-13T03:25:55.0101334+01:00</DateLiveAsAr>
<DateOfBirth>2025-09-13T03:25:55.0101334+01:00</DateOfBirth>
<DateTrainedAsAr>2025-09-13T03:25:55.0101334+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>ab891da1-8987-4356-a3d7-211dbdc3c4d1</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>106b1ee1-f2ca-4a29-aa58-22e91b7aa8c9</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2025-09-13T03:25:55.0101334+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>5e76b805-02ea-4ef9-a185-e83d7afdc713</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6afd9a9d-f0e9-4e33-b7c0-8b740378cfe3</d2p1:guid>
<d2p1:guid>c2b29971-37b7-494e-beb8-328a27d767fe</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>b3830580-7658-46e9-a543-08d129a6083a</d2p1:guid>
<d2p1:guid>f6e6b110-8641-4b81-9974-eb384dd98dd4</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>b57f7595-af3a-43be-9c1e-8f6e226a195f</d2p1:guid>
<d2p1:guid>ccdedb16-fbea-4dbc-bc47-ebc3013a1152</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>09c57638-4eed-45d4-b7aa-adb08cd41eeb</d2p1:guid>
<d2p1:guid>cf230eb6-1dff-4066-95f2-412d0dc642dd</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>48560640-0733-4aa5-936c-015c69fbf7a0</VetClaimPaymentGroupId>
<VetGroupId>118c1833-b935-417d-bdd0-b9b8ef768567</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>