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": "7ef9d605-7040-4aab-9f30-10bc7a06ff5c",
"AffiliateClaimsStatusId": "d3175e06-8c22-440e-be07-546a42fbfab6",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "74bb31f7-3d51-48d9-aaf4-d89cc42a0f0f",
"AffiliateSourceId": "29beed3d-8ac1-47b4-a0c9-37873d29521a",
"AffiliateStatusId": "b58d7a77-6fa7-4708-a200-935b7037910d",
"AffiliateStatusReasonId": "e1f3b15e-1917-4171-97f1-035cd315fdf5",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "ff2fdabb-5e02-473e-9c6f-c9798da80d2e",
"AssocRegBefore": true,
"BreederMembership": "e00e0dcb-4cba-48a3-a005-047093a19c4d",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "853159ed-10b7-40d1-b85a-eeebf9e6637d",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "15a3188d-c7a8-4157-bfc4-ca9bbc8b28b6",
"CountryId": "feac9254-fe80-4b85-9b72-8a65c2b597a2",
"County": "sample string 10",
"DateOfBirth": "2025-07-07T14:49:57.3976214+01:00",
"DateLiveAsAr": "2025-07-07T14:49:57.3976214+01:00",
"DateTrainedAsAr": "2025-07-07T14:49:57.3976214+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "5381fd0c-80f5-410f-a79d-3deb6e2a61b2",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "075290d7-013a-4e68-bb37-6b9a679bca93",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2025-07-07T14:49:57.3976214+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": "86324906-8496-47d8-b341-57111c7ae5e9",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"03e22634-97b9-43eb-83ac-49fef2291d33",
"ac2989fc-d958-49bf-a15b-12fd2e9b7f3f"
],
"PreferredBreeds": [
"85b426ea-a303-417f-83cc-dcefb65d38a9",
"09860e7c-41ee-44aa-be18-7c79bb26a1f1"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"19619d51-88f8-4413-a521-bef0a6d85ee1",
"f7871234-b74d-4816-a84e-200edd318234"
],
"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": [
"4b72d8f2-ce51-4470-8300-e71d0634dddb",
"7a1583ad-eed4-4b13-8619-a5788937ac18"
],
"VetClaimPaymentGroupId": "8c6a6d2a-516c-4699-a225-2b56a0af6d36",
"VetGroupId": "5f12d447-bb16-466f-898b-06b12d8af828",
"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>7ef9d605-7040-4aab-9f30-10bc7a06ff5c</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>d3175e06-8c22-440e-be07-546a42fbfab6</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>29beed3d-8ac1-47b4-a0c9-37873d29521a</AffiliateSourceId>
<AffiliateStatusId>b58d7a77-6fa7-4708-a200-935b7037910d</AffiliateStatusId>
<AffiliateStatusReasonId>e1f3b15e-1917-4171-97f1-035cd315fdf5</AffiliateStatusReasonId>
<AffiliateTypeId>74bb31f7-3d51-48d9-aaf4-d89cc42a0f0f</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>ff2fdabb-5e02-473e-9c6f-c9798da80d2e</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>e00e0dcb-4cba-48a3-a005-047093a19c4d</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>853159ed-10b7-40d1-b85a-eeebf9e6637d</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>15a3188d-c7a8-4157-bfc4-ca9bbc8b28b6</ContactById>
<CountryId>feac9254-fe80-4b85-9b72-8a65c2b597a2</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2025-07-07T14:49:57.3976214+01:00</DateLiveAsAr>
<DateOfBirth>2025-07-07T14:49:57.3976214+01:00</DateOfBirth>
<DateTrainedAsAr>2025-07-07T14:49:57.3976214+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>5381fd0c-80f5-410f-a79d-3deb6e2a61b2</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>075290d7-013a-4e68-bb37-6b9a679bca93</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2025-07-07T14:49:57.3976214+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>86324906-8496-47d8-b341-57111c7ae5e9</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>03e22634-97b9-43eb-83ac-49fef2291d33</d2p1:guid>
<d2p1:guid>ac2989fc-d958-49bf-a15b-12fd2e9b7f3f</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>85b426ea-a303-417f-83cc-dcefb65d38a9</d2p1:guid>
<d2p1:guid>09860e7c-41ee-44aa-be18-7c79bb26a1f1</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>19619d51-88f8-4413-a521-bef0a6d85ee1</d2p1:guid>
<d2p1:guid>f7871234-b74d-4816-a84e-200edd318234</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>4b72d8f2-ce51-4470-8300-e71d0634dddb</d2p1:guid>
<d2p1:guid>7a1583ad-eed4-4b13-8619-a5788937ac18</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>8c6a6d2a-516c-4699-a225-2b56a0af6d36</VetClaimPaymentGroupId>
<VetGroupId>5f12d447-bb16-466f-898b-06b12d8af828</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>