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": "2d8318d4-3344-4a0c-a04a-49b9baf75be7",
"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": "403a4415-1c47-4c37-9be0-cecf45998be3",
"PostCode": "sample string 11",
"SourceAffiliateId": "6e2d31cf-8d79-4076-944c-1713f869b698",
"TelephoneNumber": "sample string 12",
"TermsAgreed": true,
"TitleId": "1bcf1f41-6e29-4834-99ec-0ce316b2a102",
"Town": "sample string 15",
"AffiliateSourceId": "cbef6969-556a-49eb-b037-2d0b4f16d993",
"DateOfBirth": "2026-02-04T01:09:53.1040635+00:00",
"NumberOfBitchesQueens": 1,
"NumberOfLittersPerYear": 1,
"LitterReady": true,
"LitterReadyDate": "2026-02-04T01:09:53.1040635+00:00",
"NextLitterDueDate": "2026-02-04T01:09:53.1040635+00:00",
"AssociatedRegisteredBefore": true,
"SubjectToInvestigation": true,
"SelfBreedAllLittersSold": true,
"PreferredSpecies": [
"f6653dc9-1d76-40e5-9525-0791be6b303c",
"35669438-35bd-42be-b7bd-a4d2eaa57a28"
],
"PreferredBreeds": [
"20dad25c-82ce-4694-9901-5609c6534ac9",
"bb47fb8f-d1be-4aa0-ac13-24e9ce1522e3"
],
"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>cbef6969-556a-49eb-b037-2d0b4f16d993</AffiliateSourceId>
<AssociatedRegisteredBefore>true</AssociatedRegisteredBefore>
<CountryId>2d8318d4-3344-4a0c-a04a-49b9baf75be7</CountryId>
<County>sample string 4</County>
<DateOfBirth>2026-02-04T01:09:53.1040635+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-02-04T01:09:53.1040635+00:00</LitterReadyDate>
<MobileNumber>sample string 10</MobileNumber>
<NextLitterDueDate>2026-02-04T01:09:53.1040635+00:00</NextLitterDueDate>
<NextLitterDueId>403a4415-1c47-4c37-9be0-cecf45998be3</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>20dad25c-82ce-4694-9901-5609c6534ac9</d2p1:guid>
<d2p1:guid>bb47fb8f-d1be-4aa0-ac13-24e9ce1522e3</d2p1:guid>
</PreferredBreeds>
<PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f6653dc9-1d76-40e5-9525-0791be6b303c</d2p1:guid>
<d2p1:guid>35669438-35bd-42be-b7bd-a4d2eaa57a28</d2p1:guid>
</PreferredSpecies>
<SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
<SourceAffiliateId>6e2d31cf-8d79-4076-944c-1713f869b698</SourceAffiliateId>
<SubjectToInvestigation>true</SubjectToInvestigation>
<TelephoneNumber>sample string 12</TelephoneNumber>
<TermsAgreed>true</TermsAgreed>
<TitleId>1bcf1f41-6e29-4834-99ec-0ce316b2a102</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": "a63ef0dd-efde-404e-9972-b0911ec5e4b0",
"AffiliateClaimsStatusId": "dc6178cb-3ae8-4b1b-a9f9-344e0d5e8b28",
"AffiliateReference": "sample string 5",
"AffiliateTypeId": "0a3dd566-9e35-40b7-9230-c8a2adf90a5d",
"AffiliateSourceId": "9742cc14-9488-449e-9acf-ea57b50bd58e",
"AffiliateStatusId": "4626bf35-32dc-435e-b821-40979bce0a08",
"AffiliateStatusReasonId": "5d384cb1-c84f-4530-97bd-f19a85f26204",
"AgriaId": "sample string 6",
"AppointedRepresentative": true,
"AppointedRepresentativeStatusId": "39ec6b5a-bc8a-4e84-b532-34b61f1debb1",
"AssocRegBefore": true,
"BreederMembership": "21f93830-26da-411d-b00f-e39e8b2ee04e",
"BreederMembershipNumber": "sample string 7",
"BuyingGroupParent": "sample string 8",
"CharityId": "d5167e09-bfde-4ca6-86db-228f29254e4b",
"ClaimsEmailAddress": "sample string 9",
"ComplianceCheck": true,
"ContactById": "01132c3f-3c27-4263-82d6-cd77ea671919",
"CountryId": "05f4cd35-23d5-4f75-aa0e-8820e8c39dec",
"County": "sample string 10",
"DateOfBirth": "2026-02-04T01:09:53.1196871+00:00",
"DateLiveAsAr": "2026-02-04T01:09:53.1196871+00:00",
"DateTrainedAsAr": "2026-02-04T01:09:53.1196871+00:00",
"DonateToCharity": true,
"EmailAddress": "sample string 11",
"EstMonthlyRehomed": 1,
"EstPrimaryVaccinations": 1,
"ExternalPracticeReference": "sample string 12",
"FaxNumber": "sample string 13",
"FcaStatusId": "6ec20d63-d444-4fc7-b5d3-2ce3bec0b9ab",
"Forename": "sample string 14",
"HouseName": "sample string 15",
"HouseNumber": "sample string 16",
"Id": "219a7dc7-6c59-4473-98cb-40e035541831",
"KcAccredited": true,
"KcBreederId": "sample string 17",
"LitterReady": true,
"LitterReadyDate": "2026-02-04T01:09:53.1196871+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": "d30a4774-ae89-4f6e-b5c6-83ef0751e6ad",
"PostCode": "sample string 21",
"PracticeManagementSystemUsed": "sample string 22",
"PracticePartnerIds": [
"e9167fef-0c9e-430a-aad4-af25716d1786",
"2d0da3dd-13d2-49be-af71-df5089e543dd"
],
"PreferredBreeds": [
"d21de9ef-cc45-421e-a6e6-a5205de7dd1b",
"ab2f1569-49f5-4b28-b9fa-0e5ebde9e16e"
],
"PreferredEmail": true,
"PreferredPost": true,
"PreferredPhone": true,
"PreferredSms": true,
"PreferredSpecies": [
"7b8c32a9-499a-4fa5-a21b-faca91e259a0",
"0ba434f2-9eec-429f-9c7e-b351f97dbe6e"
],
"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": [
"8ada7dd9-ca51-46e0-85e5-a5227196a8fd",
"fc676500-0386-4e54-b3de-63d883558f83"
],
"VetClaimPaymentGroupId": "d5079a3b-e5c4-4c07-a083-ea6a073e0ee2",
"VetGroupId": "46133bcc-9756-47f4-b58b-41726e5cdf3d",
"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>a63ef0dd-efde-404e-9972-b0911ec5e4b0</AffiliateBusinessTypeId>
<AffiliateClaimsStatusId>dc6178cb-3ae8-4b1b-a9f9-344e0d5e8b28</AffiliateClaimsStatusId>
<AffiliateReference>sample string 5</AffiliateReference>
<AffiliateSourceId>9742cc14-9488-449e-9acf-ea57b50bd58e</AffiliateSourceId>
<AffiliateStatusId>4626bf35-32dc-435e-b821-40979bce0a08</AffiliateStatusId>
<AffiliateStatusReasonId>5d384cb1-c84f-4530-97bd-f19a85f26204</AffiliateStatusReasonId>
<AffiliateTypeId>0a3dd566-9e35-40b7-9230-c8a2adf90a5d</AffiliateTypeId>
<AgriaId>sample string 6</AgriaId>
<AppointedRepresentative>true</AppointedRepresentative>
<AppointedRepresentativeStatusId>39ec6b5a-bc8a-4e84-b532-34b61f1debb1</AppointedRepresentativeStatusId>
<AssocRegBefore>true</AssocRegBefore>
<BreederMembership>21f93830-26da-411d-b00f-e39e8b2ee04e</BreederMembership>
<BreederMembershipNumber>sample string 7</BreederMembershipNumber>
<BuyingGroupParent>sample string 8</BuyingGroupParent>
<CharityId>d5167e09-bfde-4ca6-86db-228f29254e4b</CharityId>
<ClaimsEmailAddress>sample string 9</ClaimsEmailAddress>
<ComplianceCheck>true</ComplianceCheck>
<ContactById>01132c3f-3c27-4263-82d6-cd77ea671919</ContactById>
<CountryId>05f4cd35-23d5-4f75-aa0e-8820e8c39dec</CountryId>
<County>sample string 10</County>
<DateLiveAsAr>2026-02-04T01:09:53.1196871+00:00</DateLiveAsAr>
<DateOfBirth>2026-02-04T01:09:53.1196871+00:00</DateOfBirth>
<DateTrainedAsAr>2026-02-04T01:09:53.1196871+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>6ec20d63-d444-4fc7-b5d3-2ce3bec0b9ab</FcaStatusId>
<Forename>sample string 14</Forename>
<HouseName>sample string 15</HouseName>
<HouseNumber>sample string 16</HouseNumber>
<Id>219a7dc7-6c59-4473-98cb-40e035541831</Id>
<KcAccredited>true</KcAccredited>
<KcBreederId>sample string 17</KcBreederId>
<LitterReady>true</LitterReady>
<LitterReadyDate>2026-02-04T01:09:53.1196871+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>d30a4774-ae89-4f6e-b5c6-83ef0751e6ad</ParentAffiliateId>
<PostCode>sample string 21</PostCode>
<PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed>
<PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e9167fef-0c9e-430a-aad4-af25716d1786</d2p1:guid>
<d2p1:guid>2d0da3dd-13d2-49be-af71-df5089e543dd</d2p1:guid>
</PracticePartnerIds>
<PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>d21de9ef-cc45-421e-a6e6-a5205de7dd1b</d2p1:guid>
<d2p1:guid>ab2f1569-49f5-4b28-b9fa-0e5ebde9e16e</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>7b8c32a9-499a-4fa5-a21b-faca91e259a0</d2p1:guid>
<d2p1:guid>0ba434f2-9eec-429f-9c7e-b351f97dbe6e</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>8ada7dd9-ca51-46e0-85e5-a5227196a8fd</d2p1:guid>
<d2p1:guid>fc676500-0386-4e54-b3de-63d883558f83</d2p1:guid>
</TypeIds>
<VetClaimPaymentGroupId>d5079a3b-e5c4-4c07-a083-ea6a073e0ee2</VetClaimPaymentGroupId>
<VetGroupId>46133bcc-9756-47f4-b58b-41726e5cdf3d</VetGroupId>
<Website>sample string 30</Website>
</Affiliate>