POST api/Affiliate/EnrolForBreederClub
Request Information
URI Parameters
None.
Body Parameters
AffiliateBreederClubEnrolmentRequestName | 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": "dfabde0c-33f5-41b6-9006-7d466c6a5029", "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": "69298f4d-c688-4d10-9120-2580c5389c68", "PostCode": "sample string 11", "SourceAffiliateId": "71a4847e-fbd3-4d3b-b511-ed54404eb73d", "TelephoneNumber": "sample string 12", "TermsAgreed": true, "TitleId": "16a23b7e-d648-4bbe-bc54-f253c8bb1f55", "Town": "sample string 15", "AffiliateSourceId": "82cf25e7-a573-4013-911c-9433dc4b9dca", "DateOfBirth": "2025-08-27T03:34:56.264424+01:00", "NumberOfBitchesQueens": 1, "NumberOfLittersPerYear": 1, "LitterReady": true, "LitterReadyDate": "2025-08-27T03:34:56.264424+01:00", "NextLitterDueDate": "2025-08-27T03:34:56.264424+01:00", "AssociatedRegisteredBefore": true, "SubjectToInvestigation": true, "SelfBreedAllLittersSold": true, "PreferredSpecies": [ "f52ba066-c5c8-4e69-b1b7-d906376ac3ff", "cbce175b-0622-45f5-8ce2-1aada2a7e630" ], "PreferredBreeds": [ "0b621475-f3d4-4f0e-bde2-218a3f2c44a8", "6aaa103e-5558-4f8a-ab22-2ce8d220344f" ], "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>82cf25e7-a573-4013-911c-9433dc4b9dca</AffiliateSourceId> <AssociatedRegisteredBefore>true</AssociatedRegisteredBefore> <CountryId>dfabde0c-33f5-41b6-9006-7d466c6a5029</CountryId> <County>sample string 4</County> <DateOfBirth>2025-08-27T03:34:56.264424+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>2025-08-27T03:34:56.264424+01:00</LitterReadyDate> <MobileNumber>sample string 10</MobileNumber> <NextLitterDueDate>2025-08-27T03:34:56.264424+01:00</NextLitterDueDate> <NextLitterDueId>69298f4d-c688-4d10-9120-2580c5389c68</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>0b621475-f3d4-4f0e-bde2-218a3f2c44a8</d2p1:guid> <d2p1:guid>6aaa103e-5558-4f8a-ab22-2ce8d220344f</d2p1:guid> </PreferredBreeds> <PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>f52ba066-c5c8-4e69-b1b7-d906376ac3ff</d2p1:guid> <d2p1:guid>cbce175b-0622-45f5-8ce2-1aada2a7e630</d2p1:guid> </PreferredSpecies> <SelfBreedAllLittersSold>true</SelfBreedAllLittersSold> <SourceAffiliateId>71a4847e-fbd3-4d3b-b511-ed54404eb73d</SourceAffiliateId> <SubjectToInvestigation>true</SubjectToInvestigation> <TelephoneNumber>sample string 12</TelephoneNumber> <TermsAgreed>true</TermsAgreed> <TitleId>16a23b7e-d648-4bbe-bc54-f253c8bb1f55</TitleId> <Town>sample string 15</Town> </AffiliateBreederClubEnrolmentRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AffiliateName | 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": "96738993-fba0-473b-a406-26d8cbd9fba6", "AffiliateClaimsStatusId": "11ba31be-4e1e-497b-a1b4-478d64e8ae49", "AffiliateReference": "sample string 5", "AffiliateTypeId": "bf317e36-3b60-4c08-b264-08596d2aaf7b", "AffiliateSourceId": "d576a60b-3aba-49de-b381-e670d63c8308", "AffiliateStatusId": "f8c0570a-d842-483f-a699-4035d3c78754", "AffiliateStatusReasonId": "30c45184-ac4b-414e-937b-13e08a9492bd", "AgriaId": "sample string 6", "AppointedRepresentative": true, "AppointedRepresentativeStatusId": "8ec3d61a-d245-47f3-a266-a5431c9475aa", "AssocRegBefore": true, "BreederMembership": "0f0c8ef7-60a8-45ba-97d0-010f23f40f12", "BreederMembershipNumber": "sample string 7", "BuyingGroupParent": "sample string 8", "CharityId": "5751d860-24ab-4366-8552-9763f3f57882", "ClaimsEmailAddress": "sample string 9", "ComplianceCheck": true, "ContactById": "e66da776-5d3b-4973-b4ab-aca185233575", "CountryId": "023189c3-5b93-45a4-be39-bd1a0d3e7491", "County": "sample string 10", "DateOfBirth": "2025-08-27T03:34:56.2800448+01:00", "DateLiveAsAr": "2025-08-27T03:34:56.2800448+01:00", "DateTrainedAsAr": "2025-08-27T03:34:56.2800448+01:00", "DonateToCharity": true, "EmailAddress": "sample string 11", "EstMonthlyRehomed": 1, "EstPrimaryVaccinations": 1, "ExternalPracticeReference": "sample string 12", "FaxNumber": "sample string 13", "FcaStatusId": "75a9213f-4e39-44db-a72a-ea4f6c880d7a", "Forename": "sample string 14", "HouseName": "sample string 15", "HouseNumber": "sample string 16", "Id": "22b66cd6-be6b-4a9e-b8b5-3245fdbc56ea", "KcAccredited": true, "KcBreederId": "sample string 17", "LitterReady": true, "LitterReadyDate": "2025-08-27T03:34:56.2800448+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": "5e0a076c-aec1-4893-93e2-b5030268d65e", "PostCode": "sample string 21", "PracticeManagementSystemUsed": "sample string 22", "PracticePartnerIds": [ "3dd4121d-88ed-4ae2-b561-331258cd7e39", "998d4dcc-796d-4dec-93c9-45ba6f1b508c" ], "PreferredBreeds": [ "42af028c-ccbf-4191-9b5e-fc81e76c62c6", "a55d1a79-d221-4d16-b6d6-97ac646e9000" ], "PreferredEmail": true, "PreferredPost": true, "PreferredPhone": true, "PreferredSms": true, "PreferredSpecies": [ "838f3ee4-2d90-4ff0-aee2-d336418487d2", "56d83667-eba6-47e0-8e75-2103d6fb2ae1" ], "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": [ "13e47966-a185-4f1d-9dbb-8fcc1cdf3e84", "4ccf4192-ecdc-4589-930f-6b99718edefa" ], "VetClaimPaymentGroupId": "134751f7-335a-4306-a5fc-b4884f8e34c2", "VetGroupId": "b4b1c636-aeff-419a-8656-ed608614bf08", "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>96738993-fba0-473b-a406-26d8cbd9fba6</AffiliateBusinessTypeId> <AffiliateClaimsStatusId>11ba31be-4e1e-497b-a1b4-478d64e8ae49</AffiliateClaimsStatusId> <AffiliateReference>sample string 5</AffiliateReference> <AffiliateSourceId>d576a60b-3aba-49de-b381-e670d63c8308</AffiliateSourceId> <AffiliateStatusId>f8c0570a-d842-483f-a699-4035d3c78754</AffiliateStatusId> <AffiliateStatusReasonId>30c45184-ac4b-414e-937b-13e08a9492bd</AffiliateStatusReasonId> <AffiliateTypeId>bf317e36-3b60-4c08-b264-08596d2aaf7b</AffiliateTypeId> <AgriaId>sample string 6</AgriaId> <AppointedRepresentative>true</AppointedRepresentative> <AppointedRepresentativeStatusId>8ec3d61a-d245-47f3-a266-a5431c9475aa</AppointedRepresentativeStatusId> <AssocRegBefore>true</AssocRegBefore> <BreederMembership>0f0c8ef7-60a8-45ba-97d0-010f23f40f12</BreederMembership> <BreederMembershipNumber>sample string 7</BreederMembershipNumber> <BuyingGroupParent>sample string 8</BuyingGroupParent> <CharityId>5751d860-24ab-4366-8552-9763f3f57882</CharityId> <ClaimsEmailAddress>sample string 9</ClaimsEmailAddress> <ComplianceCheck>true</ComplianceCheck> <ContactById>e66da776-5d3b-4973-b4ab-aca185233575</ContactById> <CountryId>023189c3-5b93-45a4-be39-bd1a0d3e7491</CountryId> <County>sample string 10</County> <DateLiveAsAr>2025-08-27T03:34:56.2800448+01:00</DateLiveAsAr> <DateOfBirth>2025-08-27T03:34:56.2800448+01:00</DateOfBirth> <DateTrainedAsAr>2025-08-27T03:34:56.2800448+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>75a9213f-4e39-44db-a72a-ea4f6c880d7a</FcaStatusId> <Forename>sample string 14</Forename> <HouseName>sample string 15</HouseName> <HouseNumber>sample string 16</HouseNumber> <Id>22b66cd6-be6b-4a9e-b8b5-3245fdbc56ea</Id> <KcAccredited>true</KcAccredited> <KcBreederId>sample string 17</KcBreederId> <LitterReady>true</LitterReady> <LitterReadyDate>2025-08-27T03:34:56.2800448+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>5e0a076c-aec1-4893-93e2-b5030268d65e</ParentAffiliateId> <PostCode>sample string 21</PostCode> <PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed> <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>3dd4121d-88ed-4ae2-b561-331258cd7e39</d2p1:guid> <d2p1:guid>998d4dcc-796d-4dec-93c9-45ba6f1b508c</d2p1:guid> </PracticePartnerIds> <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>42af028c-ccbf-4191-9b5e-fc81e76c62c6</d2p1:guid> <d2p1:guid>a55d1a79-d221-4d16-b6d6-97ac646e9000</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>838f3ee4-2d90-4ff0-aee2-d336418487d2</d2p1:guid> <d2p1:guid>56d83667-eba6-47e0-8e75-2103d6fb2ae1</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>13e47966-a185-4f1d-9dbb-8fcc1cdf3e84</d2p1:guid> <d2p1:guid>4ccf4192-ecdc-4589-930f-6b99718edefa</d2p1:guid> </TypeIds> <VetClaimPaymentGroupId>134751f7-335a-4306-a5fc-b4884f8e34c2</VetClaimPaymentGroupId> <VetGroupId>b4b1c636-aeff-419a-8656-ed608614bf08</VetGroupId> <Website>sample string 30</Website> </Affiliate>