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": "150bb8d5-5ad6-41df-867e-f7c5bc48f346",
"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": "f64a4b2a-0c6a-457a-b011-868bc05cc108",
"PostCode": "sample string 11",
"SourceAffiliateId": "78964313-cf77-43b6-9540-7e8870a85c64",
"TelephoneNumber": "sample string 12",
"TermsAgreed": true,
"TitleId": "67aa9fad-8772-4643-a0b6-0c22ac521768",
"Town": "sample string 15",
"AffiliateSourceId": "4b925cd3-990d-4080-a028-82bfc8df1c0e",
"DateOfBirth": "2026-03-23T06:36:19.6973003+00:00",
"NumberOfBitchesQueens": 1,
"NumberOfLittersPerYear": 1,
"LitterReady": true,
"LitterReadyDate": "2026-03-23T06:36:19.6973003+00:00",
"NextLitterDueDate": "2026-03-23T06:36:19.6973003+00:00",
"AssociatedRegisteredBefore": true,
"SubjectToInvestigation": true,
"SelfBreedAllLittersSold": true,
"PreferredSpecies": [
"3d53002a-2ea4-40d8-a240-ccd8e73d363e",
"61128af6-ecb9-4230-9243-f992875a334f"
],
"PreferredBreeds": [
"ea613012-7ebe-42e8-aada-1bb2759806b9",
"c9858b26-8659-4755-9a35-986c1b7aa0c4"
],
"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>4b925cd3-990d-4080-a028-82bfc8df1c0e</AffiliateSourceId>
<AssociatedRegisteredBefore>true</AssociatedRegisteredBefore>
<CountryId>150bb8d5-5ad6-41df-867e-f7c5bc48f346</CountryId>
<County>sample string 4</County>
<DateOfBirth>2026-03-23T06:36:19.6973003+00: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-03-23T06:36:19.6973003+00:00</LitterReadyDate>
<MobileNumber>sample string 10</MobileNumber>
<NextLitterDueDate>2026-03-23T06:36:19.6973003+00:00</NextLitterDueDate>
<NextLitterDueId>f64a4b2a-0c6a-457a-b011-868bc05cc108</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>ea613012-7ebe-42e8-aada-1bb2759806b9</d2p1:guid>
<d2p1:guid>c9858b26-8659-4755-9a35-986c1b7aa0c4</d2p1:guid>
</PreferredBreeds>
<PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>3d53002a-2ea4-40d8-a240-ccd8e73d363e</d2p1:guid>
<d2p1:guid>61128af6-ecb9-4230-9243-f992875a334f</d2p1:guid>
</PreferredSpecies>
<SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
<SourceAffiliateId>78964313-cf77-43b6-9540-7e8870a85c64</SourceAffiliateId>
<SubjectToInvestigation>true</SubjectToInvestigation>
<TelephoneNumber>sample string 12</TelephoneNumber>
<TermsAgreed>true</TermsAgreed>
<TitleId>67aa9fad-8772-4643-a0b6-0c22ac521768</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": "4eb5acac-3f3c-45ff-aa53-1f9598dea58e",
"AffiliateClaimsStatusId": "970d7677-e9c6-4622-ab67-0967dd5a0b06",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "41302883-ba09-4505-b0d7-8bc09a42de7b",
"AffiliateSourceId": "a5fe663b-7ba9-444e-bd8d-83c6ca1923d0",
"AffiliateStatusId": "2f1025bf-0f51-471e-88e9-4e3a71420d1d",
"AffiliateStatusReasonId": "9d366461-c891-4cea-91dd-029a222987a8",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "83e13a30-affa-417e-af6a-da6bb4b714d6",
"AssocRegBefore": true,
"BreederMembership": "56ca40a2-5bde-43ca-85b9-5782e42e07e0",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "14a3df45-0aee-47bc-b336-634e4aea8532",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "df600989-4c34-4ea0-b81b-8d0c715b8ce0",
"CountryId": "317b8b93-09bb-43a7-8dde-b751ff31d48d",
"County": "sample string 10",
"DateOfBirth": "2026-03-23T06:36:19.7129166+00:00",
"DateLiveAsAr": "2026-03-23T06:36:19.7129166+00:00",
"DateTrainedAsAr": "2026-03-23T06:36:19.7129166+00:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "08030e48-db98-44ce-9157-e421d95e1200",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "2a33cc9d-79f0-4e93-9e41-7802aeac6cff",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-03-23T06:36:19.7129166+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": "b795872d-816d-49a6-8255-fc41ef6483c9",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"820afca3-4315-4878-8bb8-111c1cc194ff",
"11ab9d68-8054-4c58-b026-58e2b2145933"
],
"PreferredBreeds": [
"18cdb685-712d-417d-b021-139c6f9da1e3",
"de1e3249-82ca-4d39-9134-8b0781ff4b02"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"b79b0ee4-3947-4c60-b330-6e66e2cd2145",
"6b2dfa18-d8b7-40e6-9dff-b856aebb82ff"
],
"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": [
"3a5299a3-5215-4766-8f3e-9c88e2b14eba",
"62d8574e-c63c-4bbc-b89b-845d608289bf"
],
"VetClaimPaymentGroupId": "764e8277-7e97-4c2e-a4bd-d4fc70f16a9e",
"VetGroupId": "fdb858bb-4219-4a4d-b4fa-c094dcec66c4",
"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>4eb5acac-3f3c-45ff-aa53-1f9598dea58e</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>970d7677-e9c6-4622-ab67-0967dd5a0b06</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>a5fe663b-7ba9-444e-bd8d-83c6ca1923d0</AffiliateSourceId>
<AffiliateStatusId>2f1025bf-0f51-471e-88e9-4e3a71420d1d</AffiliateStatusId>
<AffiliateStatusReasonId>9d366461-c891-4cea-91dd-029a222987a8</AffiliateStatusReasonId>
<AffiliateTypeId>41302883-ba09-4505-b0d7-8bc09a42de7b</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>83e13a30-affa-417e-af6a-da6bb4b714d6</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>56ca40a2-5bde-43ca-85b9-5782e42e07e0</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>14a3df45-0aee-47bc-b336-634e4aea8532</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>df600989-4c34-4ea0-b81b-8d0c715b8ce0</ContactById>
<CountryId>317b8b93-09bb-43a7-8dde-b751ff31d48d</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-03-23T06:36:19.7129166+00:00</DateLiveAsAr>
<DateOfBirth>2026-03-23T06:36:19.7129166+00:00</DateOfBirth>
<DateTrainedAsAr>2026-03-23T06:36:19.7129166+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>08030e48-db98-44ce-9157-e421d95e1200</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>2a33cc9d-79f0-4e93-9e41-7802aeac6cff</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-03-23T06:36:19.7129166+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>b795872d-816d-49a6-8255-fc41ef6483c9</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>820afca3-4315-4878-8bb8-111c1cc194ff</d2p1:guid>
<d2p1:guid>11ab9d68-8054-4c58-b026-58e2b2145933</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>18cdb685-712d-417d-b021-139c6f9da1e3</d2p1:guid>
<d2p1:guid>de1e3249-82ca-4d39-9134-8b0781ff4b02</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>b79b0ee4-3947-4c60-b330-6e66e2cd2145</d2p1:guid>
<d2p1:guid>6b2dfa18-d8b7-40e6-9dff-b856aebb82ff</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>3a5299a3-5215-4766-8f3e-9c88e2b14eba</d2p1:guid>
<d2p1:guid>62d8574e-c63c-4bbc-b89b-845d608289bf</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>764e8277-7e97-4c2e-a4bd-d4fc70f16a9e</VetClaimPaymentGroupId>
<VetGroupId>fdb858bb-4219-4a4d-b4fa-c094dcec66c4</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>