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": "47f87bae-b0cf-453e-9768-9c422b643eeb",
"AffiliateClaimsStatusId": "d3912a7b-7b1a-4b05-b731-53fcb4f5dcde",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "e06dbd7a-6d48-412f-8c1b-f585dbc9f4e8",
"AffiliateSourceId": "7d26532f-672a-4de8-9500-084c3c300418",
"AffiliateStatusId": "06ed00d3-19b0-4a4e-b416-9fe65e546f55",
"AffiliateStatusReasonId": "c540831a-e192-4dd6-9d78-93a62fafb5ce",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "e2b6eba1-4fd1-45d4-8871-fbbe1ddd9c57",
"AssocRegBefore": true,
"BreederMembership": "90fd82f5-596e-42ab-8344-2700f72b7900",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "f22d6ae7-1644-4557-ba89-fd1d1de13e27",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "53e2a758-6320-4e7c-bc3d-f5dd97687df1",
"CountryId": "9ca5b40b-5fa9-4dea-8e9f-eeea08de78f8",
"County": "sample string 10",
"DateOfBirth": "2026-05-09T13:01:31.2917702+01:00",
"DateLiveAsAr": "2026-05-09T13:01:31.2917702+01:00",
"DateTrainedAsAr": "2026-05-09T13:01:31.2917702+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "3726d9b8-242b-45fd-b203-8e6f14d49741",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "c2ea8980-44a0-42bf-998c-f822395fd70d",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-05-09T13:01:31.2917702+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": "e4d90945-a0f2-4ab7-8215-290e97c12d2e",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"42eefa20-3dd3-405f-9e63-668f2a7029da",
"3241f8da-6bef-428f-ba3c-893cf0e58d55"
],
"PreferredBreeds": [
"b6eb938d-df56-439b-8272-4e17481b403a",
"9bc3f67b-30d2-4e38-8d1d-e5db1554de3e"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"517aa462-2bc8-48e7-aa51-1facd2c5b0d8",
"ac539bf5-817d-40ff-bf43-e7d0a2360328"
],
"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": [
"4412624e-37fb-4898-97ed-e9f9b13376ed",
"9fae14f3-bfc2-4ba5-9071-3f0af8399f91"
],
"VetClaimPaymentGroupId": "0223d35f-b961-4ae6-9e49-cb30281c9eac",
"VetGroupId": "173e70c5-e71c-4d80-bec2-7a0c65eadaa7",
"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>47f87bae-b0cf-453e-9768-9c422b643eeb</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>d3912a7b-7b1a-4b05-b731-53fcb4f5dcde</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>7d26532f-672a-4de8-9500-084c3c300418</AffiliateSourceId>
<AffiliateStatusId>06ed00d3-19b0-4a4e-b416-9fe65e546f55</AffiliateStatusId>
<AffiliateStatusReasonId>c540831a-e192-4dd6-9d78-93a62fafb5ce</AffiliateStatusReasonId>
<AffiliateTypeId>e06dbd7a-6d48-412f-8c1b-f585dbc9f4e8</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>e2b6eba1-4fd1-45d4-8871-fbbe1ddd9c57</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>90fd82f5-596e-42ab-8344-2700f72b7900</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>f22d6ae7-1644-4557-ba89-fd1d1de13e27</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>53e2a758-6320-4e7c-bc3d-f5dd97687df1</ContactById>
<CountryId>9ca5b40b-5fa9-4dea-8e9f-eeea08de78f8</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-05-09T13:01:31.2917702+01:00</DateLiveAsAr>
<DateOfBirth>2026-05-09T13:01:31.2917702+01:00</DateOfBirth>
<DateTrainedAsAr>2026-05-09T13:01:31.2917702+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>3726d9b8-242b-45fd-b203-8e6f14d49741</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>c2ea8980-44a0-42bf-998c-f822395fd70d</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-05-09T13:01:31.2917702+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>e4d90945-a0f2-4ab7-8215-290e97c12d2e</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>42eefa20-3dd3-405f-9e63-668f2a7029da</d2p1:guid>
<d2p1:guid>3241f8da-6bef-428f-ba3c-893cf0e58d55</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>b6eb938d-df56-439b-8272-4e17481b403a</d2p1:guid>
<d2p1:guid>9bc3f67b-30d2-4e38-8d1d-e5db1554de3e</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>517aa462-2bc8-48e7-aa51-1facd2c5b0d8</d2p1:guid>
<d2p1:guid>ac539bf5-817d-40ff-bf43-e7d0a2360328</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>4412624e-37fb-4898-97ed-e9f9b13376ed</d2p1:guid>
<d2p1:guid>9fae14f3-bfc2-4ba5-9071-3f0af8399f91</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>0223d35f-b961-4ae6-9e49-cb30281c9eac</VetClaimPaymentGroupId>
<VetGroupId>173e70c5-e71c-4d80-bec2-7a0c65eadaa7</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>