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": "055e52af-0185-4dcb-b548-f88bf38aa03c", "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": "5616e756-1b86-431a-a965-9b5ea803e7c3", "PostCode": "sample string 11", "SourceAffiliateId": "832422e0-8f76-44f8-abf4-9039935bcada", "TelephoneNumber": "sample string 12", "TermsAgreed": true, "TitleId": "5e3b7779-6c87-49d0-bd31-2751dbcb7f28", "Town": "sample string 15", "AffiliateSourceId": "fa375be5-0b8e-4ae1-8b30-0bfab775bd47", "DateOfBirth": "2025-09-13T03:27:14.118831+01:00", "NumberOfBitchesQueens": 1, "NumberOfLittersPerYear": 1, "LitterReady": true, "LitterReadyDate": "2025-09-13T03:27:14.118831+01:00", "NextLitterDueDate": "2025-09-13T03:27:14.118831+01:00", "AssociatedRegisteredBefore": true, "SubjectToInvestigation": true, "SelfBreedAllLittersSold": true, "PreferredSpecies": [ "16bb2378-af34-44f8-bfae-8a2d95809380", "34408701-9e81-461c-ae72-00e16f538d06" ], "PreferredBreeds": [ "f7b3b3ab-750b-414c-b7e4-cb7ec561792b", "81798236-4860-4182-b759-985cfa8664d1" ], "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>fa375be5-0b8e-4ae1-8b30-0bfab775bd47</AffiliateSourceId> <AssociatedRegisteredBefore>true</AssociatedRegisteredBefore> <CountryId>055e52af-0185-4dcb-b548-f88bf38aa03c</CountryId> <County>sample string 4</County> <DateOfBirth>2025-09-13T03:27:14.118831+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-09-13T03:27:14.118831+01:00</LitterReadyDate> <MobileNumber>sample string 10</MobileNumber> <NextLitterDueDate>2025-09-13T03:27:14.118831+01:00</NextLitterDueDate> <NextLitterDueId>5616e756-1b86-431a-a965-9b5ea803e7c3</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>f7b3b3ab-750b-414c-b7e4-cb7ec561792b</d2p1:guid> <d2p1:guid>81798236-4860-4182-b759-985cfa8664d1</d2p1:guid> </PreferredBreeds> <PreferredSpecies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>16bb2378-af34-44f8-bfae-8a2d95809380</d2p1:guid> <d2p1:guid>34408701-9e81-461c-ae72-00e16f538d06</d2p1:guid> </PreferredSpecies> <SelfBreedAllLittersSold>true</SelfBreedAllLittersSold> <SourceAffiliateId>832422e0-8f76-44f8-abf4-9039935bcada</SourceAffiliateId> <SubjectToInvestigation>true</SubjectToInvestigation> <TelephoneNumber>sample string 12</TelephoneNumber> <TermsAgreed>true</TermsAgreed> <TitleId>5e3b7779-6c87-49d0-bd31-2751dbcb7f28</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": "7cd2174d-95fa-4631-8a9e-31a9bc1670a8", "AffiliateClaimsStatusId": "18dda2ff-2058-4bac-b8b5-0cb58ffc2fae", "AffiliateReference": "sample string 5", "AffiliateTypeId": "ddaad4ef-a75a-442d-8c9e-5297d43cc5f6", "AffiliateSourceId": "ff636e04-56aa-447d-80b0-e442f0123a87", "AffiliateStatusId": "29fac18c-c77b-4ba1-b644-f47816684231", "AffiliateStatusReasonId": "8a93ebd7-6480-4dfc-8d53-c26d3e0db1fb", "AgriaId": "sample string 6", "AppointedRepresentative": true, "AppointedRepresentativeStatusId": "2ec981b8-0d4e-419d-9c92-e91c2060d118", "AssocRegBefore": true, "BreederMembership": "c045c52d-ea3d-4db7-953f-c8ff99d27f26", "BreederMembershipNumber": "sample string 7", "BuyingGroupParent": "sample string 8", "CharityId": "61fad942-32a8-488c-8352-fade80723194", "ClaimsEmailAddress": "sample string 9", "ComplianceCheck": true, "ContactById": "541e9330-c34a-4daf-931b-880e3d7cae63", "CountryId": "0196381b-d7d9-499f-8956-347cd6e26ec2", "County": "sample string 10", "DateOfBirth": "2025-09-13T03:27:14.1344876+01:00", "DateLiveAsAr": "2025-09-13T03:27:14.1344876+01:00", "DateTrainedAsAr": "2025-09-13T03:27:14.1344876+01:00", "DonateToCharity": true, "EmailAddress": "sample string 11", "EstMonthlyRehomed": 1, "EstPrimaryVaccinations": 1, "ExternalPracticeReference": "sample string 12", "FaxNumber": "sample string 13", "FcaStatusId": "4d4cda9f-2693-48c0-8e83-b8ff55ff0d2b", "Forename": "sample string 14", "HouseName": "sample string 15", "HouseNumber": "sample string 16", "Id": "ebde5b41-a6b1-4fd9-9302-ffe66aecba14", "KcAccredited": true, "KcBreederId": "sample string 17", "LitterReady": true, "LitterReadyDate": "2025-09-13T03:27:14.1344876+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": "f5d04c23-1d6f-462c-84de-4679f7cad441", "PostCode": "sample string 21", "PracticeManagementSystemUsed": "sample string 22", "PracticePartnerIds": [ "3127c961-86fb-493b-8941-ac925977f2d8", "c0090a4a-ce4c-4420-a5d9-b27ffb446742" ], "PreferredBreeds": [ "52216392-49b4-4cce-bb29-9e228af7e854", "8ef8a90f-b90e-4dfb-a4e5-87e501ecced0" ], "PreferredEmail": true, "PreferredPost": true, "PreferredPhone": true, "PreferredSms": true, "PreferredSpecies": [ "542ad895-13db-494f-93f0-c86a6f155023", "a903ce18-2da1-48fb-8f45-5d29397baa08" ], "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": [ "7afa72c9-20ff-4678-8f4c-853a81df07ff", "10f76b92-f81c-49ff-9d98-bab36484d187" ], "VetClaimPaymentGroupId": "5d30d1c0-59e9-41f8-a562-0ca0e06c8e64", "VetGroupId": "09a7cf56-712f-48e0-bbf9-12cc58f7f890", "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>7cd2174d-95fa-4631-8a9e-31a9bc1670a8</AffiliateBusinessTypeId> <AffiliateClaimsStatusId>18dda2ff-2058-4bac-b8b5-0cb58ffc2fae</AffiliateClaimsStatusId> <AffiliateReference>sample string 5</AffiliateReference> <AffiliateSourceId>ff636e04-56aa-447d-80b0-e442f0123a87</AffiliateSourceId> <AffiliateStatusId>29fac18c-c77b-4ba1-b644-f47816684231</AffiliateStatusId> <AffiliateStatusReasonId>8a93ebd7-6480-4dfc-8d53-c26d3e0db1fb</AffiliateStatusReasonId> <AffiliateTypeId>ddaad4ef-a75a-442d-8c9e-5297d43cc5f6</AffiliateTypeId> <AgriaId>sample string 6</AgriaId> <AppointedRepresentative>true</AppointedRepresentative> <AppointedRepresentativeStatusId>2ec981b8-0d4e-419d-9c92-e91c2060d118</AppointedRepresentativeStatusId> <AssocRegBefore>true</AssocRegBefore> <BreederMembership>c045c52d-ea3d-4db7-953f-c8ff99d27f26</BreederMembership> <BreederMembershipNumber>sample string 7</BreederMembershipNumber> <BuyingGroupParent>sample string 8</BuyingGroupParent> <CharityId>61fad942-32a8-488c-8352-fade80723194</CharityId> <ClaimsEmailAddress>sample string 9</ClaimsEmailAddress> <ComplianceCheck>true</ComplianceCheck> <ContactById>541e9330-c34a-4daf-931b-880e3d7cae63</ContactById> <CountryId>0196381b-d7d9-499f-8956-347cd6e26ec2</CountryId> <County>sample string 10</County> <DateLiveAsAr>2025-09-13T03:27:14.1344876+01:00</DateLiveAsAr> <DateOfBirth>2025-09-13T03:27:14.1344876+01:00</DateOfBirth> <DateTrainedAsAr>2025-09-13T03:27:14.1344876+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>4d4cda9f-2693-48c0-8e83-b8ff55ff0d2b</FcaStatusId> <Forename>sample string 14</Forename> <HouseName>sample string 15</HouseName> <HouseNumber>sample string 16</HouseNumber> <Id>ebde5b41-a6b1-4fd9-9302-ffe66aecba14</Id> <KcAccredited>true</KcAccredited> <KcBreederId>sample string 17</KcBreederId> <LitterReady>true</LitterReady> <LitterReadyDate>2025-09-13T03:27:14.1344876+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>f5d04c23-1d6f-462c-84de-4679f7cad441</ParentAffiliateId> <PostCode>sample string 21</PostCode> <PracticeManagementSystemUsed>sample string 22</PracticeManagementSystemUsed> <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>3127c961-86fb-493b-8941-ac925977f2d8</d2p1:guid> <d2p1:guid>c0090a4a-ce4c-4420-a5d9-b27ffb446742</d2p1:guid> </PracticePartnerIds> <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>52216392-49b4-4cce-bb29-9e228af7e854</d2p1:guid> <d2p1:guid>8ef8a90f-b90e-4dfb-a4e5-87e501ecced0</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>542ad895-13db-494f-93f0-c86a6f155023</d2p1:guid> <d2p1:guid>a903ce18-2da1-48fb-8f45-5d29397baa08</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>7afa72c9-20ff-4678-8f4c-853a81df07ff</d2p1:guid> <d2p1:guid>10f76b92-f81c-49ff-9d98-bab36484d187</d2p1:guid> </TypeIds> <VetClaimPaymentGroupId>5d30d1c0-59e9-41f8-a562-0ca0e06c8e64</VetClaimPaymentGroupId> <VetGroupId>09a7cf56-712f-48e0-bbf9-12cc58f7f890</VetGroupId> <Website>sample string 30</Website> </Affiliate>