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": "b3d0fc95-d91c-44cd-9de4-820c6fd2c967",
"AffiliateClaimsStatusId": "a3d9c634-eb75-4b5a-844f-3f144a823352",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "514462bb-12b5-43bf-9828-0438b23976cb",
"AffiliateSourceId": "28859c4b-f3be-4e16-aca9-e35e582f7688",
"AffiliateStatusId": "1e9c9ccb-e852-47c6-aa4d-8feb0f07b886",
"AffiliateStatusReasonId": "c36322a6-335d-40d7-a550-435b75057815",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "da78016d-04bf-4b6e-89dc-4a357cb16da8",
"AssocRegBefore": true,
"BreederMembership": "abb446c6-6972-4398-b386-cb727eadb22e",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "514f184d-c2a7-4529-bb0f-d9fd87efbe2b",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "27f35a3b-f569-40c7-937f-3c06030c43d7",
"CountryId": "a3392be4-b453-43b2-8fd4-08da4ca1eced",
"County": "sample string 10",
"DateOfBirth": "2025-08-27T03:36:02.9992583+01:00",
"DateLiveAsAr": "2025-08-27T03:36:02.9992583+01:00",
"DateTrainedAsAr": "2025-08-27T03:36:02.9992583+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "5a72402a-6794-4e8e-a3aa-30905d7e3de8",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "6942355f-6b4f-47f6-bac9-0eab12fbf65d",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2025-08-27T03:36:02.9992583+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": "b369248a-7b5d-4e35-9d07-90f44c19fdaa",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"981dc88d-5386-484a-b965-c0180d3b762d",
"364576a7-8b39-414e-840f-91a26b4c4daf"
],
"PreferredBreeds": [
"cb113064-d9f4-4f31-a6e7-e21cd693860f",
"623abd04-1b97-407e-ba3a-cc093b602d38"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"fd5cca92-35ab-4021-9c30-87c614b02840",
"48e418d4-f529-4c1e-b32a-9a8b6b31e0ef"
],
"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": [
"9ba50e54-d336-495c-a94f-bc4e3ce11286",
"84b1b9fd-5764-44a2-9d26-0b0653056b19"
],
"VetClaimPaymentGroupId": "e77c3773-6ba0-488a-bd00-b939431a5ffd",
"VetGroupId": "f98da922-7768-4a18-b63e-36c2b955907e",
"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>b3d0fc95-d91c-44cd-9de4-820c6fd2c967</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>a3d9c634-eb75-4b5a-844f-3f144a823352</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>28859c4b-f3be-4e16-aca9-e35e582f7688</AffiliateSourceId>
<AffiliateStatusId>1e9c9ccb-e852-47c6-aa4d-8feb0f07b886</AffiliateStatusId>
<AffiliateStatusReasonId>c36322a6-335d-40d7-a550-435b75057815</AffiliateStatusReasonId>
<AffiliateTypeId>514462bb-12b5-43bf-9828-0438b23976cb</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>da78016d-04bf-4b6e-89dc-4a357cb16da8</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>abb446c6-6972-4398-b386-cb727eadb22e</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>514f184d-c2a7-4529-bb0f-d9fd87efbe2b</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>27f35a3b-f569-40c7-937f-3c06030c43d7</ContactById>
<CountryId>a3392be4-b453-43b2-8fd4-08da4ca1eced</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2025-08-27T03:36:02.9992583+01:00</DateLiveAsAr>
<DateOfBirth>2025-08-27T03:36:02.9992583+01:00</DateOfBirth>
<DateTrainedAsAr>2025-08-27T03:36:02.9992583+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>5a72402a-6794-4e8e-a3aa-30905d7e3de8</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>6942355f-6b4f-47f6-bac9-0eab12fbf65d</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2025-08-27T03:36:02.9992583+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>b369248a-7b5d-4e35-9d07-90f44c19fdaa</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>981dc88d-5386-484a-b965-c0180d3b762d</d2p1:guid>
<d2p1:guid>364576a7-8b39-414e-840f-91a26b4c4daf</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>cb113064-d9f4-4f31-a6e7-e21cd693860f</d2p1:guid>
<d2p1:guid>623abd04-1b97-407e-ba3a-cc093b602d38</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>fd5cca92-35ab-4021-9c30-87c614b02840</d2p1:guid>
<d2p1:guid>48e418d4-f529-4c1e-b32a-9a8b6b31e0ef</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>9ba50e54-d336-495c-a94f-bc4e3ce11286</d2p1:guid>
<d2p1:guid>84b1b9fd-5764-44a2-9d26-0b0653056b19</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>e77c3773-6ba0-488a-bd00-b939431a5ffd</VetClaimPaymentGroupId>
<VetGroupId>f98da922-7768-4a18-b63e-36c2b955907e</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>