POST api/Affiliate/EnrolForBreederClub
Request Information
URI Parameters
None.
Body Parameters
AffiliateBreederClubEnrolmentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| AddressLine3 | string |
None. |
|
| CountryId | globally unique identifier |
None. |
|
| County | string |
None. |
|
| EmailAddress | string |
None. |
|
| FirstName | string |
None. |
|
| HouseName | string |
None. |
|
| HouseNumber | string |
None. |
|
| LastName | string |
None. |
|
| MobileNumber | string |
None. |
|
| NextLitterDueId | globally unique identifier |
None. |
|
| PostCode | string |
None. |
|
| SourceAffiliateId | globally unique identifier |
None. |
|
| TelephoneNumber | string |
None. |
|
| TermsAgreed | boolean |
None. |
|
| TitleId | globally unique identifier |
None. |
|
| Town | string |
None. |
|
| AffiliateSourceId | globally unique identifier |
None. |
|
| DateOfBirth | date |
None. |
|
| NumberOfBitchesQueens | integer |
None. |
|
| NumberOfLittersPerYear | integer |
None. |
|
| LitterReady | boolean |
None. |
|
| LitterReadyDate | date |
None. |
|
| NextLitterDueDate | date |
None. |
|
| AssociatedRegisteredBefore | boolean |
None. |
|
| SubjectToInvestigation | boolean |
None. |
|
| SelfBreedAllLittersSold | boolean |
None. |
|
| PreferredSpecies | Collection of globally unique identifier |
None. |
|
| PreferredBreeds | Collection of globally unique identifier |
None. |
|
| IsGuest | boolean |
None. |
|
| FirstLitter | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"CountryId": "431a34a3-a71a-4277-975d-9b59c6b18d03",
"County": "sample string 4",
"EmailAddress": "sample string 5",
"FirstName": "sample string 6",
"HouseName": "sample string 7",
"HouseNumber": "sample string 8",
"LastName": "sample string 9",
"MobileNumber": "sample string 10",
"NextLitterDueId": "52d7718a-bef7-491b-82fc-e5294a58cb64",
"PostCode": "sample string 11",
"SourceAffiliateId": "f65cb95f-3332-47b7-ab71-1c9305baf97e",
"TelephoneNumber": "sample string 12",
"TermsAgreed": true,
"TitleId": "f71b0480-4b8c-43c0-8c96-05f2321bbe38",
"Town": "sample string 15",
"AffiliateSourceId": "35e3650d-731b-4bb1-a635-3adc084a4e4b",
"DateOfBirth": "2026-06-24T20:39:53.7845254+01:00",
"NumberOfBitchesQueens": 1,
"NumberOfLittersPerYear": 1,
"LitterReady": true,
"LitterReadyDate": "2026-06-24T20:39:53.7845254+01:00",
"NextLitterDueDate": "2026-06-24T20:39:53.7845254+01:00",
"AssociatedRegisteredBefore": true,
"SubjectToInvestigation": true,
"SelfBreedAllLittersSold": true,
"PreferredSpecies": [
"d7589f63-a7d0-4c20-a9cf-6c09ce0537c5",
"c51e45f7-2792-4398-b6f7-fe7ef4c179a3"
],
"PreferredBreeds": [
"333b73db-c45d-4887-b8f7-eda4e4febe65",
"9c74e31a-63aa-4128-ad61-a68e61256242"
],
"IsGuest": true,
"FirstLitter": true
}
application/xml, text/xml
Sample:
<AffiliateBreederClubEnrolmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tss.Eitr.Customer.Agria.WebApi.Models">
<AddressLine1>sample string 1</AddressLine1>
<AddressLine2>sample string 2</AddressLine2>
<AddressLine3>sample string 3</AddressLine3>
<AffiliateSourceId>35e3650d-731b-4bb1-a635-3adc084a4e4b</AffiliateSourceId>
<AssociatedRegisteredBefore>true</AssociatedRegisteredBefore>
<CountryId>431a34a3-a71a-4277-975d-9b59c6b18d03</CountryId>
<County>sample string 4</County>
<DateOfBirth>2026-06-24T20:39:53.7845254+01:00</DateOfBirth>
<EmailAddress>sample string 5</EmailAddress>
<FirstLitter>true</FirstLitter>
<FirstName>sample string 6</FirstName>
<HouseName>sample string 7</HouseName>
<HouseNumber>sample string 8</HouseNumber>
<IsGuest>true</IsGuest>
<LastName>sample string 9</LastName>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-06-24T20:39:53.7845254+01:00</LitterReadyDate>
<MobileNumber>sample string 10</MobileNumber>
<NextLitterDueDate>2026-06-24T20:39:53.7845254+01:00</NextLitterDueDate>
<NextLitterDueId>52d7718a-bef7-491b-82fc-e5294a58cb64</NextLitterDueId>
<NumberOfBitchesQueens>1</NumberOfBitchesQueens>
<NumberOfLittersPerYear>1</NumberOfLittersPerYear>
<PostCode>sample string 11</PostCode>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>333b73db-c45d-4887-b8f7-eda4e4febe65</d2p1:guid>
<d2p1:guid>9c74e31a-63aa-4128-ad61-a68e61256242</d2p1:guid>
</PreferredBreeds>
<PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>d7589f63-a7d0-4c20-a9cf-6c09ce0537c5</d2p1:guid>
<d2p1:guid>c51e45f7-2792-4398-b6f7-fe7ef4c179a3</d2p1:guid>
</PreferredSpecies>
<SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
<SourceAffiliateId>f65cb95f-3332-47b7-ab71-1c9305baf97e</SourceAffiliateId>
<SubjectToInvestigation>true</SubjectToInvestigation>
<TelephoneNumber>sample string 12</TelephoneNumber>
<TermsAgreed>true</TermsAgreed>
<TitleId>f71b0480-4b8c-43c0-8c96-05f2321bbe38</TitleId>
<Town>sample string 15</Town>
</AffiliateBreederClubEnrolmentRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
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": "24ad9842-ed25-4c18-986a-6f42b826fced",
"AffiliateClaimsStatusId": "b789d07a-3728-4fcd-9cca-e9896b925a73",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "f0ae38d5-25e2-49c2-a2c5-84bd1645d864",
"AffiliateSourceId": "0420f3b1-d140-4f65-9c8c-18c8b84d8354",
"AffiliateStatusId": "e1356c55-47a1-42a2-9bba-5e6643f0f9a6",
"AffiliateStatusReasonId": "cf1470c0-6c34-4c2b-89f1-e9c0ba2d31e6",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "7b5d21a5-48f3-4888-9761-0a6b0851ba9d",
"AssocRegBefore": true,
"BreederMembership": "be24535b-4009-499e-b57c-5b8a1f1e3123",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "c272fc3b-7f6c-47ff-a1e7-922acce9b38e",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "7ced6713-4ff7-40a8-99af-ea2e0fd57ae0",
"CountryId": "c042a12d-5158-40b9-aabc-4d9a1e5b0185",
"County": "sample string 10",
"DateOfBirth": "2026-06-24T20:39:53.8000553+01:00",
"DateLiveAsAr": "2026-06-24T20:39:53.8000553+01:00",
"DateTrainedAsAr": "2026-06-24T20:39:53.8000553+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "bb31c1d1-dff5-44a7-862b-a2dff9575411",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "667420fe-8310-4a20-9c5d-7f789e55c89a",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-06-24T20:39:53.8000553+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": "48913541-69fa-4a0a-a012-c754a2215848",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"a8507c93-7eb4-4c20-a2f8-e65561ff1ff6",
"346d6993-0306-4ceb-9f93-66e80ef17630"
],
"PreferredBreeds": [
"aeb43d6d-c497-4729-a465-1ae3ba2309a8",
"4a7d5f86-6ab1-4790-a102-0eb5d08cc9bf"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"2ec684f7-ad95-41ee-9d7c-53fbffdbfdd2",
"9461e0a6-8d0a-470a-b21a-bced9c0fd9d0"
],
"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": [
"12cc6b29-5176-4b29-a2ba-2f40c72b8988",
"3422d22c-d541-4c6e-8abc-6673f05183d1"
],
"VetClaimPaymentGroupId": "7adb2ea0-d6a0-45c8-a853-7e1be9cb6cfd",
"VetGroupId": "7bba1ac3-7d87-42e3-a586-b7e4f563ffd9",
"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>24ad9842-ed25-4c18-986a-6f42b826fced</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>b789d07a-3728-4fcd-9cca-e9896b925a73</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>0420f3b1-d140-4f65-9c8c-18c8b84d8354</AffiliateSourceId>
<AffiliateStatusId>e1356c55-47a1-42a2-9bba-5e6643f0f9a6</AffiliateStatusId>
<AffiliateStatusReasonId>cf1470c0-6c34-4c2b-89f1-e9c0ba2d31e6</AffiliateStatusReasonId>
<AffiliateTypeId>f0ae38d5-25e2-49c2-a2c5-84bd1645d864</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>7b5d21a5-48f3-4888-9761-0a6b0851ba9d</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>be24535b-4009-499e-b57c-5b8a1f1e3123</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>c272fc3b-7f6c-47ff-a1e7-922acce9b38e</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>7ced6713-4ff7-40a8-99af-ea2e0fd57ae0</ContactById>
<CountryId>c042a12d-5158-40b9-aabc-4d9a1e5b0185</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-06-24T20:39:53.8000553+01:00</DateLiveAsAr>
<DateOfBirth>2026-06-24T20:39:53.8000553+01:00</DateOfBirth>
<DateTrainedAsAr>2026-06-24T20:39:53.8000553+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>bb31c1d1-dff5-44a7-862b-a2dff9575411</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>667420fe-8310-4a20-9c5d-7f789e55c89a</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-06-24T20:39:53.8000553+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>48913541-69fa-4a0a-a012-c754a2215848</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>a8507c93-7eb4-4c20-a2f8-e65561ff1ff6</d2p1:guid>
<d2p1:guid>346d6993-0306-4ceb-9f93-66e80ef17630</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>aeb43d6d-c497-4729-a465-1ae3ba2309a8</d2p1:guid>
<d2p1:guid>4a7d5f86-6ab1-4790-a102-0eb5d08cc9bf</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>2ec684f7-ad95-41ee-9d7c-53fbffdbfdd2</d2p1:guid>
<d2p1:guid>9461e0a6-8d0a-470a-b21a-bced9c0fd9d0</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>12cc6b29-5176-4b29-a2ba-2f40c72b8988</d2p1:guid>
<d2p1:guid>3422d22c-d541-4c6e-8abc-6673f05183d1</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>7adb2ea0-d6a0-45c8-a853-7e1be9cb6cfd</VetClaimPaymentGroupId>
<VetGroupId>7bba1ac3-7d87-42e3-a586-b7e4f563ffd9</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>