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": "20e32849-c883-43ea-9707-b787563ff866",
"AffiliateClaimsStatusId": "2bd381bf-8af3-4b1d-b3a2-9aa935041bb7",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "8a6512fa-c145-4c52-bc6a-4bbb64a4a76c",
"AffiliateSourceId": "6612ef25-76d2-44d6-b1eb-3bb330a28517",
"AffiliateStatusId": "c28574c0-430a-489a-a06e-013e5a877dc7",
"AffiliateStatusReasonId": "7239d83c-c480-4a01-92a2-b212b2e55db7",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "e9ea9e59-022b-47c2-9eaa-a48e3ac556f9",
"AssocRegBefore": true,
"BreederMembership": "25df7d67-640b-4990-bb2a-76edaf311290",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "2571a31c-54e6-43bc-9b19-f7244a8e9f3c",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "4a51afe5-f3ae-4564-8328-a2d6685b6d1b",
"CountryId": "3648b49e-8318-4abd-99b0-e49f08fc2902",
"County": "sample string 10",
"DateOfBirth": "2026-02-04T01:11:00.3635072+00:00",
"DateLiveAsAr": "2026-02-04T01:11:00.3635072+00:00",
"DateTrainedAsAr": "2026-02-04T01:11:00.3635072+00:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "8c5ea6e9-246a-471e-bd30-7f21f66f1d26",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "917c8e0d-b6f7-4f7c-9c70-64c8e7471570",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-02-04T01:11:00.3635072+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": "867ef3e5-84e1-42e2-906a-b9902ff1ea27",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"068c896e-b7b1-404b-bcc4-b82c2bfac8a2",
"70e09f6b-7555-4200-b474-1de077fa4f31"
],
"PreferredBreeds": [
"40b701db-f4e1-4b79-86dd-bf8df40ac2aa",
"6edd5d16-a54f-445e-8a53-ead7cb0af2d1"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"10c1090d-81d2-419c-be53-ac593e83f07c",
"c158e8ed-0b13-426f-bed3-4c92b207c758"
],
"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": [
"a8e3c216-9bac-49b0-9aa4-b6884b924d8d",
"e40dde42-6112-429f-a97e-7201022a6506"
],
"VetClaimPaymentGroupId": "0d0f2395-cbb4-4315-9f92-718d1656b5e2",
"VetGroupId": "77ed8d5a-a02e-4c46-b350-1a40d4df8388",
"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>20e32849-c883-43ea-9707-b787563ff866</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>2bd381bf-8af3-4b1d-b3a2-9aa935041bb7</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>6612ef25-76d2-44d6-b1eb-3bb330a28517</AffiliateSourceId>
<AffiliateStatusId>c28574c0-430a-489a-a06e-013e5a877dc7</AffiliateStatusId>
<AffiliateStatusReasonId>7239d83c-c480-4a01-92a2-b212b2e55db7</AffiliateStatusReasonId>
<AffiliateTypeId>8a6512fa-c145-4c52-bc6a-4bbb64a4a76c</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>e9ea9e59-022b-47c2-9eaa-a48e3ac556f9</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>25df7d67-640b-4990-bb2a-76edaf311290</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>2571a31c-54e6-43bc-9b19-f7244a8e9f3c</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>4a51afe5-f3ae-4564-8328-a2d6685b6d1b</ContactById>
<CountryId>3648b49e-8318-4abd-99b0-e49f08fc2902</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-02-04T01:11:00.3635072+00:00</DateLiveAsAr>
<DateOfBirth>2026-02-04T01:11:00.3635072+00:00</DateOfBirth>
<DateTrainedAsAr>2026-02-04T01:11:00.3635072+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>8c5ea6e9-246a-471e-bd30-7f21f66f1d26</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>917c8e0d-b6f7-4f7c-9c70-64c8e7471570</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-02-04T01:11:00.3635072+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>867ef3e5-84e1-42e2-906a-b9902ff1ea27</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>068c896e-b7b1-404b-bcc4-b82c2bfac8a2</d2p1:guid>
<d2p1:guid>70e09f6b-7555-4200-b474-1de077fa4f31</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>40b701db-f4e1-4b79-86dd-bf8df40ac2aa</d2p1:guid>
<d2p1:guid>6edd5d16-a54f-445e-8a53-ead7cb0af2d1</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>10c1090d-81d2-419c-be53-ac593e83f07c</d2p1:guid>
<d2p1:guid>c158e8ed-0b13-426f-bed3-4c92b207c758</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>a8e3c216-9bac-49b0-9aa4-b6884b924d8d</d2p1:guid>
<d2p1:guid>e40dde42-6112-429f-a97e-7201022a6506</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>0d0f2395-cbb4-4315-9f92-718d1656b5e2</VetClaimPaymentGroupId>
<VetGroupId>77ed8d5a-a02e-4c46-b350-1a40d4df8388</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>