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": "6d702d23-5cc5-4d48-b488-daf871120983",
"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": "aed7ee77-20f5-4873-8d5c-88e947ce8557",
"PostCode": "sample string 11",
"SourceAffiliateId": "e5cfb18f-856e-459e-94f1-80a1164d1f63",
"TelephoneNumber": "sample string 12",
"TermsAgreed": true,
"TitleId": "c9c8c635-4c1d-4d79-9493-a7181e38bc00",
"Town": "sample string 15",
"AffiliateSourceId": "c9710413-5302-4a9e-a541-814b7c8e9de2",
"DateOfBirth": "2026-05-08T21:28:04.5187917+01:00",
"NumberOfBitchesQueens": 1,
"NumberOfLittersPerYear": 1,
"LitterReady": true,
"LitterReadyDate": "2026-05-08T21:28:04.5187917+01:00",
"NextLitterDueDate": "2026-05-08T21:28:04.5187917+01:00",
"AssociatedRegisteredBefore": true,
"SubjectToInvestigation": true,
"SelfBreedAllLittersSold": true,
"PreferredSpecies": [
"a1056516-db1b-426b-830b-907408f8ed7e",
"bdfc4619-11e9-494e-839b-2cbf0c8747fb"
],
"PreferredBreeds": [
"cb4e20cd-327d-48a8-bfea-eab075d498d5",
"ec25fc8f-03ba-4261-9936-557faf6d2e24"
],
"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>c9710413-5302-4a9e-a541-814b7c8e9de2</AffiliateSourceId>
<AssociatedRegisteredBefore>true</AssociatedRegisteredBefore>
<CountryId>6d702d23-5cc5-4d48-b488-daf871120983</CountryId>
<County>sample string 4</County>
<DateOfBirth>2026-05-08T21:28:04.5187917+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-05-08T21:28:04.5187917+01:00</LitterReadyDate>
<MobileNumber>sample string 10</MobileNumber>
<NextLitterDueDate>2026-05-08T21:28:04.5187917+01:00</NextLitterDueDate>
<NextLitterDueId>aed7ee77-20f5-4873-8d5c-88e947ce8557</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>cb4e20cd-327d-48a8-bfea-eab075d498d5</d2p1:guid>
<d2p1:guid>ec25fc8f-03ba-4261-9936-557faf6d2e24</d2p1:guid>
</PreferredBreeds>
<PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>a1056516-db1b-426b-830b-907408f8ed7e</d2p1:guid>
<d2p1:guid>bdfc4619-11e9-494e-839b-2cbf0c8747fb</d2p1:guid>
</PreferredSpecies>
<SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
<SourceAffiliateId>e5cfb18f-856e-459e-94f1-80a1164d1f63</SourceAffiliateId>
<SubjectToInvestigation>true</SubjectToInvestigation>
<TelephoneNumber>sample string 12</TelephoneNumber>
<TermsAgreed>true</TermsAgreed>
<TitleId>c9c8c635-4c1d-4d79-9493-a7181e38bc00</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": "056d15c9-7b60-41e4-8bc1-4c6f61185a10",
"AffiliateClaimsStatusId": "812b8b3f-de51-41bb-b25e-840dacdf1011",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "eb71e9a9-4b5e-4158-8fb3-68378a8542e5",
"AffiliateSourceId": "ac7f04f2-858e-411c-aaf1-3ac22877a037",
"AffiliateStatusId": "e9a39322-096d-4bf5-b804-3ac5417109a4",
"AffiliateStatusReasonId": "85106735-e02a-4bcb-b1c7-22f8385e00d4",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "cd2dadbc-9a65-4daf-96a1-04ca420a1ce8",
"AssocRegBefore": true,
"BreederMembership": "2e19df21-eb44-4148-afc3-51bd240ffc43",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "b17fee6b-23bb-4c03-bca1-b96ee9edf66d",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "25704d80-6a4f-49a5-a42e-138f4b25a5d7",
"CountryId": "18e491c8-c223-4687-8247-6ed29c5f5b79",
"County": "sample string 10",
"DateOfBirth": "2026-05-08T21:28:04.5500506+01:00",
"DateLiveAsAr": "2026-05-08T21:28:04.5500506+01:00",
"DateTrainedAsAr": "2026-05-08T21:28:04.5500506+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "9c686377-5d10-4c77-8c37-77df2f4f3e3c",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "3103e5d7-fc7e-43d2-884c-b1d7194b4837",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-05-08T21:28:04.5500506+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": "34d3adfa-7555-435f-8a6d-eebc2c050992",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"31522311-9fad-43ef-80a0-76048fcdab3f",
"ed44e069-c9e3-4b50-a378-89a30de77d37"
],
"PreferredBreeds": [
"2f2919b3-fd55-4599-8568-b9c0452235ac",
"3fb15224-e34d-4d63-9b5c-f6330c7fb5c6"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"c011292f-186d-4b96-aaa4-3edb7da82da2",
"9dcfa1f8-a2e8-47a7-9e13-95513a27cfdc"
],
"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": [
"80f2e4d5-b891-4025-b10f-d03d26fe0305",
"fbe1e096-3186-4848-bca8-3e698bbc30f8"
],
"VetClaimPaymentGroupId": "b7086d5e-2438-42eb-a750-41a8bb68beec",
"VetGroupId": "3b342fee-9af0-427e-a508-f16a65b89095",
"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>056d15c9-7b60-41e4-8bc1-4c6f61185a10</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>812b8b3f-de51-41bb-b25e-840dacdf1011</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>ac7f04f2-858e-411c-aaf1-3ac22877a037</AffiliateSourceId>
<AffiliateStatusId>e9a39322-096d-4bf5-b804-3ac5417109a4</AffiliateStatusId>
<AffiliateStatusReasonId>85106735-e02a-4bcb-b1c7-22f8385e00d4</AffiliateStatusReasonId>
<AffiliateTypeId>eb71e9a9-4b5e-4158-8fb3-68378a8542e5</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>cd2dadbc-9a65-4daf-96a1-04ca420a1ce8</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>2e19df21-eb44-4148-afc3-51bd240ffc43</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>b17fee6b-23bb-4c03-bca1-b96ee9edf66d</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>25704d80-6a4f-49a5-a42e-138f4b25a5d7</ContactById>
<CountryId>18e491c8-c223-4687-8247-6ed29c5f5b79</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-05-08T21:28:04.5500506+01:00</DateLiveAsAr>
<DateOfBirth>2026-05-08T21:28:04.5500506+01:00</DateOfBirth>
<DateTrainedAsAr>2026-05-08T21:28:04.5500506+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>9c686377-5d10-4c77-8c37-77df2f4f3e3c</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>3103e5d7-fc7e-43d2-884c-b1d7194b4837</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-05-08T21:28:04.5500506+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>34d3adfa-7555-435f-8a6d-eebc2c050992</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>31522311-9fad-43ef-80a0-76048fcdab3f</d2p1:guid>
<d2p1:guid>ed44e069-c9e3-4b50-a378-89a30de77d37</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>2f2919b3-fd55-4599-8568-b9c0452235ac</d2p1:guid>
<d2p1:guid>3fb15224-e34d-4d63-9b5c-f6330c7fb5c6</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>c011292f-186d-4b96-aaa4-3edb7da82da2</d2p1:guid>
<d2p1:guid>9dcfa1f8-a2e8-47a7-9e13-95513a27cfdc</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>80f2e4d5-b891-4025-b10f-d03d26fe0305</d2p1:guid>
<d2p1:guid>fbe1e096-3186-4848-bca8-3e698bbc30f8</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>b7086d5e-2438-42eb-a750-41a8bb68beec</VetClaimPaymentGroupId>
<VetGroupId>3b342fee-9af0-427e-a508-f16a65b89095</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>