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": "8e17cb1b-52a3-4b99-bc55-db3ce0a8ea79",
"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": "5dfc72e7-dc0e-46b2-adfc-cb94cb29c0f7",
"PostCode": "sample string 11",
"SourceAffiliateId": "43b32f44-5359-4a24-9fa1-4b4f45b76eea",
"TelephoneNumber": "sample string 12",
"TermsAgreed": true,
"TitleId": "6234d2a9-514f-46c2-900e-c8ed5e374659",
"Town": "sample string 15",
"AffiliateSourceId": "28597800-cd24-4814-b887-bacb0c083ff6",
"DateOfBirth": "2026-08-15T10:58:24.4020828+01:00",
"NumberOfBitchesQueens": 1,
"NumberOfLittersPerYear": 1,
"LitterReady": true,
"LitterReadyDate": "2026-08-15T10:58:24.4020828+01:00",
"NextLitterDueDate": "2026-08-15T10:58:24.4020828+01:00",
"AssociatedRegisteredBefore": true,
"SubjectToInvestigation": true,
"SelfBreedAllLittersSold": true,
"PreferredSpecies": [
"7316f4ce-2717-41bc-9670-e0b0022410aa",
"4f847ce1-c5b2-44cd-a2e8-a076af2f7384"
],
"PreferredBreeds": [
"b88f244d-4456-414b-8fe2-74d40574f42e",
"e3e6399a-4159-4f0b-9d1c-dac91593b867"
],
"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>28597800-cd24-4814-b887-bacb0c083ff6</AffiliateSourceId>
<AssociatedRegisteredBefore>true</AssociatedRegisteredBefore>
<CountryId>8e17cb1b-52a3-4b99-bc55-db3ce0a8ea79</CountryId>
<County>sample string 4</County>
<DateOfBirth>2026-08-15T10:58:24.4020828+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-08-15T10:58:24.4020828+01:00</LitterReadyDate>
<MobileNumber>sample string 10</MobileNumber>
<NextLitterDueDate>2026-08-15T10:58:24.4020828+01:00</NextLitterDueDate>
<NextLitterDueId>5dfc72e7-dc0e-46b2-adfc-cb94cb29c0f7</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>b88f244d-4456-414b-8fe2-74d40574f42e</d2p1:guid>
<d2p1:guid>e3e6399a-4159-4f0b-9d1c-dac91593b867</d2p1:guid>
</PreferredBreeds>
<PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>7316f4ce-2717-41bc-9670-e0b0022410aa</d2p1:guid>
<d2p1:guid>4f847ce1-c5b2-44cd-a2e8-a076af2f7384</d2p1:guid>
</PreferredSpecies>
<SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
<SourceAffiliateId>43b32f44-5359-4a24-9fa1-4b4f45b76eea</SourceAffiliateId>
<SubjectToInvestigation>true</SubjectToInvestigation>
<TelephoneNumber>sample string 12</TelephoneNumber>
<TermsAgreed>true</TermsAgreed>
<TitleId>6234d2a9-514f-46c2-900e-c8ed5e374659</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": "ae951c2f-5db5-40a5-a84a-fec08794ca6c",
"AffiliateClaimsStatusId": "8ccfee83-52f8-48c8-9531-2211f46a9827",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "2a03802f-8485-4525-8382-4d765a08a2d3",
"AffiliateSourceId": "eb4f177b-7cd8-4cf1-aef9-eaa39ceb5950",
"AffiliateStatusId": "59a9c9bb-8aa5-4b1e-83c7-56ba0559d81e",
"AffiliateStatusReasonId": "dfd12c28-99e9-4933-b844-c6b4e3cc071d",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "e6633c79-61bf-49c1-b952-b0b772a30a07",
"AssocRegBefore": true,
"BreederMembership": "569ed2a4-c71c-4fed-b559-32c2a5f30dea",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "cea426ab-01d1-4912-8063-c59f2709ab11",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "f3a59653-c20d-41af-ad63-d9c2bbd754f2",
"CountryId": "80eed00e-42ca-413d-bfe6-4b630873e89b",
"County": "sample string 10",
"DateOfBirth": "2026-08-15T10:58:24.4020828+01:00",
"DateLiveAsAr": "2026-08-15T10:58:24.4020828+01:00",
"DateTrainedAsAr": "2026-08-15T10:58:24.4020828+01:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "9974143f-93ff-4c7a-bff8-4592158237a4",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "0532d4dd-5b98-49c1-8387-2e22fb480302",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-08-15T10:58:24.4020828+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": "f0cae800-7f00-43c3-92a3-0628a6a84c2d",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"11025fa6-d488-4c1a-8a96-e900b115c027",
"e5616a6d-495c-41c8-8bdb-a98702da7e9a"
],
"PreferredBreeds": [
"c5b339d2-46ca-4ff9-aa89-c5a59b9b1023",
"ff2d3a3d-f8af-4f16-825e-a28f6b058936"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"114d6300-30f4-48f6-ac7a-aba90c5c17bc",
"e1f3193e-6732-41e9-bb09-b1be988436d2"
],
"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": [
"8f4839d3-2ae9-44c9-8299-5e8aa9240314",
"76be38cd-ebce-4a41-a106-bce9a05b89c0"
],
"VetClaimPaymentGroupId": "fefdd705-7e44-4cf0-9e76-eeebb9912b7f",
"VetGroupId": "978be992-df8c-44cc-9d6b-f351853b6b1b",
"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>ae951c2f-5db5-40a5-a84a-fec08794ca6c</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>8ccfee83-52f8-48c8-9531-2211f46a9827</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>eb4f177b-7cd8-4cf1-aef9-eaa39ceb5950</AffiliateSourceId>
<AffiliateStatusId>59a9c9bb-8aa5-4b1e-83c7-56ba0559d81e</AffiliateStatusId>
<AffiliateStatusReasonId>dfd12c28-99e9-4933-b844-c6b4e3cc071d</AffiliateStatusReasonId>
<AffiliateTypeId>2a03802f-8485-4525-8382-4d765a08a2d3</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>e6633c79-61bf-49c1-b952-b0b772a30a07</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>569ed2a4-c71c-4fed-b559-32c2a5f30dea</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>cea426ab-01d1-4912-8063-c59f2709ab11</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>f3a59653-c20d-41af-ad63-d9c2bbd754f2</ContactById>
<CountryId>80eed00e-42ca-413d-bfe6-4b630873e89b</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-08-15T10:58:24.4020828+01:00</DateLiveAsAr>
<DateOfBirth>2026-08-15T10:58:24.4020828+01:00</DateOfBirth>
<DateTrainedAsAr>2026-08-15T10:58:24.4020828+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>9974143f-93ff-4c7a-bff8-4592158237a4</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>0532d4dd-5b98-49c1-8387-2e22fb480302</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-08-15T10:58:24.4020828+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>f0cae800-7f00-43c3-92a3-0628a6a84c2d</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>11025fa6-d488-4c1a-8a96-e900b115c027</d2p1:guid>
<d2p1:guid>e5616a6d-495c-41c8-8bdb-a98702da7e9a</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c5b339d2-46ca-4ff9-aa89-c5a59b9b1023</d2p1:guid>
<d2p1:guid>ff2d3a3d-f8af-4f16-825e-a28f6b058936</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>114d6300-30f4-48f6-ac7a-aba90c5c17bc</d2p1:guid>
<d2p1:guid>e1f3193e-6732-41e9-bb09-b1be988436d2</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>8f4839d3-2ae9-44c9-8299-5e8aa9240314</d2p1:guid>
<d2p1:guid>76be38cd-ebce-4a41-a106-bce9a05b89c0</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>fefdd705-7e44-4cf0-9e76-eeebb9912b7f</VetClaimPaymentGroupId>
<VetGroupId>978be992-df8c-44cc-9d6b-f351853b6b1b</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>