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": "833685ca-467b-4a39-bbdf-043a4fd6bb28",
"AffiliateClaimsStatusId": "c7c4eda9-f5c9-4787-af49-7dc17eef47e7",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "d2980322-3ad1-43d3-b2e0-1c5ddfbc41ca",
"AffiliateSourceId": "d6cbb8fa-0d9f-43af-a25f-3ac3b7e3edd1",
"AffiliateStatusId": "2f9c6285-b950-4b14-aecc-fb05d2c69120",
"AffiliateStatusReasonId": "5a8a136c-75f5-45bf-affa-ef3a8e1641f2",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "fd3c4605-8be5-4044-9983-913403482ece",
"AssocRegBefore": true,
"BreederMembership": "a6d2a886-cb54-4aaf-bd1d-fc9ae64661e7",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "cb159e8a-b3ba-468e-964a-52d1e57df3b1",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "562eed87-3e87-49f7-b125-215e0afefe53",
"CountryId": "9764496d-a24a-44a0-a307-9124bcbbee8f",
"County": "sample string 10",
"DateOfBirth": "2026-03-23T20:16:28.9691295+00:00",
"DateLiveAsAr": "2026-03-23T20:16:28.9691295+00:00",
"DateTrainedAsAr": "2026-03-23T20:16:28.9691295+00:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "637bffe5-e26f-4b3d-bd66-41c7f7072f2a",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "954b24a1-37d4-42b2-bd48-3fd14b3a7623",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-03-23T20:16:28.9691295+00: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": "e67d6775-8fd3-4ce5-a752-af95125939bd",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"571ea6a2-289d-4f44-b363-b4c6aca5c7f0",
"8f3aeae3-de76-4b9a-b455-adbca06ffc58"
],
"PreferredBreeds": [
"4a3c1702-3558-42b9-a009-8f1373920408",
"091c642c-48c7-4f23-86f5-933b6517aa4a"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"c417585d-6940-4aad-b055-adf3c957f766",
"b0a1e50f-b903-4d25-b3e9-3cd061b1d447"
],
"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": [
"74cda0ff-1935-4767-8634-2f07404a1dfe",
"299f0687-f0ba-4c87-bc18-fc0ff5d33899"
],
"VetClaimPaymentGroupId": "db0c874e-b6bc-490a-bac5-60c976fcb784",
"VetGroupId": "e1ff5384-b146-48a2-9342-924f32d40ae3",
"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>833685ca-467b-4a39-bbdf-043a4fd6bb28</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>c7c4eda9-f5c9-4787-af49-7dc17eef47e7</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>d6cbb8fa-0d9f-43af-a25f-3ac3b7e3edd1</AffiliateSourceId>
<AffiliateStatusId>2f9c6285-b950-4b14-aecc-fb05d2c69120</AffiliateStatusId>
<AffiliateStatusReasonId>5a8a136c-75f5-45bf-affa-ef3a8e1641f2</AffiliateStatusReasonId>
<AffiliateTypeId>d2980322-3ad1-43d3-b2e0-1c5ddfbc41ca</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>fd3c4605-8be5-4044-9983-913403482ece</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>a6d2a886-cb54-4aaf-bd1d-fc9ae64661e7</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>cb159e8a-b3ba-468e-964a-52d1e57df3b1</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>562eed87-3e87-49f7-b125-215e0afefe53</ContactById>
<CountryId>9764496d-a24a-44a0-a307-9124bcbbee8f</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-03-23T20:16:28.9691295+00:00</DateLiveAsAr>
<DateOfBirth>2026-03-23T20:16:28.9691295+00:00</DateOfBirth>
<DateTrainedAsAr>2026-03-23T20:16:28.9691295+00: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>637bffe5-e26f-4b3d-bd66-41c7f7072f2a</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>954b24a1-37d4-42b2-bd48-3fd14b3a7623</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-03-23T20:16:28.9691295+00: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>e67d6775-8fd3-4ce5-a752-af95125939bd</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>571ea6a2-289d-4f44-b363-b4c6aca5c7f0</d2p1:guid>
<d2p1:guid>8f3aeae3-de76-4b9a-b455-adbca06ffc58</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>4a3c1702-3558-42b9-a009-8f1373920408</d2p1:guid>
<d2p1:guid>091c642c-48c7-4f23-86f5-933b6517aa4a</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>c417585d-6940-4aad-b055-adf3c957f766</d2p1:guid>
<d2p1:guid>b0a1e50f-b903-4d25-b3e9-3cd061b1d447</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>74cda0ff-1935-4767-8634-2f07404a1dfe</d2p1:guid>
<d2p1:guid>299f0687-f0ba-4c87-bc18-fc0ff5d33899</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>db0c874e-b6bc-490a-bac5-60c976fcb784</VetClaimPaymentGroupId>
<VetGroupId>e1ff5384-b146-48a2-9342-924f32d40ae3</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>