GET api/Affiliate/GetDetails?affiliateId={affiliateId}

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

AffiliateDetails

Name	Type	Additional information
AccountHolderName	string	None.
AccountNumber	string	None.
Charity	Charity	None.
EmailAddress	string	None.
FaxNumber	string	None.
FirstName	string	None.
LastName	string	None.
MarketingContactByEmail	boolean	None.
MarketingContactByPhone	boolean	None.
MarketingContactByPost	boolean	None.
MarketingContactBySMS	boolean	None.
MobileNumber	string	None.
RewardTotal	decimal number	None.
SortCode	string	None.
TelephoneNumber	string	None.
TitleId	globally unique identifier	None.
AppointedRepresentativeStatusId	globally unique identifier	None.
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.
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.
EstMonthlyRehomed	integer	None.
EstPrimaryVaccinations	integer	None.
ExternalPracticeReference	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.
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.
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:

{
  "AccountHolderName": "sample string 1",
  "AccountNumber": "sample string 2",
  "Charity": {
    "Id": "8a0da0a1-99a5-466f-95df-ca2ddc5bd8f0",
    "Name": "sample string 2"
  },
  "EmailAddress": "sample string 3",
  "FaxNumber": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "MarketingContactByEmail": true,
  "MarketingContactByPhone": true,
  "MarketingContactByPost": true,
  "MarketingContactBySMS": true,
  "MobileNumber": "sample string 11",
  "RewardTotal": 12.0,
  "SortCode": "sample string 13",
  "TelephoneNumber": "sample string 14",
  "TitleId": "0bcc1c9f-5e9d-4318-8723-70ef5258f831",
  "AppointedRepresentativeStatusId": "79e38be5-3980-4a33-a39a-be26d97a672d",
  "ActivatorEmail": "sample string 15",
  "ActualPrimaryVaccinations": 1,
  "AddressLine1": "sample string 16",
  "AddressLine2": "sample string 17",
  "AddressLine3": "sample string 18",
  "AffiliateBusinessTypeId": "529d7889-b8f6-4407-b24d-f16d00cd132e",
  "AffiliateClaimsStatusId": "0b446947-30f4-445e-b180-e8b11ce49b08",
  "AffiliateReference": "sample string 19",
  "AffiliateTypeId": "458ed33b-0a7f-47c0-b712-c1f02ec4f05b",
  "AffiliateSourceId": "2097b2eb-392c-4305-b45b-0509f20b2955",
  "AffiliateStatusId": "ffb11d2b-e89a-4509-95ae-0066997f6f11",
  "AffiliateStatusReasonId": "b9b1f598-fd3f-4a91-af60-0899bd6b84a9",
  "AgriaId": "sample string 20",
  "AppointedRepresentative": true,
  "AssocRegBefore": true,
  "BreederMembership": "120b319c-e0cd-4dd2-adda-31c34aec9435",
  "BreederMembershipNumber": "sample string 21",
  "BuyingGroupParent": "sample string 22",
  "CharityId": "ed1a04ca-8fd3-424e-b902-80823fe41907",
  "ClaimsEmailAddress": "sample string 23",
  "ComplianceCheck": true,
  "ContactById": "0b9e0bd8-d077-425d-949b-c349de3e7871",
  "CountryId": "faddd49f-7f64-4e10-8970-70ead8843f8d",
  "County": "sample string 24",
  "DateOfBirth": "2025-08-27T03:36:02.9523112+01:00",
  "DateLiveAsAr": "2025-08-27T03:36:02.9523112+01:00",
  "DateTrainedAsAr": "2025-08-27T03:36:02.9523112+01:00",
  "DonateToCharity": true,
  "EstMonthlyRehomed": 1,
  "EstPrimaryVaccinations": 1,
  "ExternalPracticeReference": "sample string 25",
  "FcaStatusId": "1bc63df0-6218-40a2-b322-888a80804e72",
  "Forename": "sample string 26",
  "HouseName": "sample string 27",
  "HouseNumber": "sample string 28",
  "Id": "f21472e8-ff41-40dd-baca-da31450e53c2",
  "KcAccredited": true,
  "KcBreederId": "sample string 29",
  "LitterReady": true,
  "LitterReadyDate": "2025-08-27T03:36:02.9523112+01:00",
  "MiddleNames": "sample string 30",
  "Name": "sample string 31",
  "NumberOfBitchesQueens": 1,
  "NumberOfLittersPerYear": 1,
  "OptOutSms": true,
  "OptOutEmail": true,
  "OptOutPhone": true,
  "OptOutPost": true,
  "ParentAffiliateId": "50d00d16-806f-43be-84fd-97c2e15cf1c4",
  "PostCode": "sample string 32",
  "PracticeManagementSystemUsed": "sample string 33",
  "PracticePartnerIds": [
    "d0655c65-c871-43e3-8f75-7d711c533393",
    "170e4808-2f9e-4f36-bf19-811fef2f8b77"
  ],
  "PreferredBreeds": [
    "61813a8c-97fd-4074-9c6f-90530fa55a34",
    "2d49dc91-dc91-4269-bd2f-4d488090f468"
  ],
  "PreferredEmail": true,
  "PreferredPost": true,
  "PreferredPhone": true,
  "PreferredSms": true,
  "PreferredSpecies": [
    "fced23d4-c0c3-41c5-89d7-e4baf0b84f37",
    "19ab4b7f-3af1-402a-ba2d-24ce2437e7c6"
  ],
  "PrincipalEmail": "sample string 34",
  "Rating": "sample string 35",
  "RewardAmount": 1.0,
  "RvcCode": "sample string 36",
  "SelfBreedAllLittersSold": true,
  "SubjectToInvestigation": true,
  "Surname": "sample string 37",
  "Town": "sample string 38",
  "TradingName": "sample string 39",
  "TypeIds": [
    "549ab491-9f06-478d-9a8c-6fe38e6898c3",
    "4e935c08-8381-47ed-8684-026abaf27c1e"
  ],
  "VetClaimPaymentGroupId": "6381bae6-d1a1-4cbb-b32b-82ad006c3ea3",
  "VetGroupId": "b802ece7-b776-4633-a555-beadfd5f09c5",
  "Website": "sample string 40"
}

application/xml, text/xml

Sample:

<AffiliateDetails 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 15</ActivatorEmail>
  <ActualPrimaryVaccinations>1</ActualPrimaryVaccinations>
  <AddressLine1>sample string 16</AddressLine1>
  <AddressLine2>sample string 17</AddressLine2>
  <AddressLine3>sample string 18</AddressLine3>
  <AffiliateBusinessTypeId>529d7889-b8f6-4407-b24d-f16d00cd132e</AffiliateBusinessTypeId>
  <AffiliateClaimsStatusId>0b446947-30f4-445e-b180-e8b11ce49b08</AffiliateClaimsStatusId>
  <AffiliateReference>sample string 19</AffiliateReference>
  <AffiliateSourceId>2097b2eb-392c-4305-b45b-0509f20b2955</AffiliateSourceId>
  <AffiliateStatusId>ffb11d2b-e89a-4509-95ae-0066997f6f11</AffiliateStatusId>
  <AffiliateStatusReasonId>b9b1f598-fd3f-4a91-af60-0899bd6b84a9</AffiliateStatusReasonId>
  <AffiliateTypeId>458ed33b-0a7f-47c0-b712-c1f02ec4f05b</AffiliateTypeId>
  <AgriaId>sample string 20</AgriaId>
  <AppointedRepresentative>true</AppointedRepresentative>
  <AppointedRepresentativeStatusId i:nil="true" />
  <AssocRegBefore>true</AssocRegBefore>
  <BreederMembership>120b319c-e0cd-4dd2-adda-31c34aec9435</BreederMembership>
  <BreederMembershipNumber>sample string 21</BreederMembershipNumber>
  <BuyingGroupParent>sample string 22</BuyingGroupParent>
  <CharityId>ed1a04ca-8fd3-424e-b902-80823fe41907</CharityId>
  <ClaimsEmailAddress>sample string 23</ClaimsEmailAddress>
  <ComplianceCheck>true</ComplianceCheck>
  <ContactById>0b9e0bd8-d077-425d-949b-c349de3e7871</ContactById>
  <CountryId>faddd49f-7f64-4e10-8970-70ead8843f8d</CountryId>
  <County>sample string 24</County>
  <DateLiveAsAr>2025-08-27T03:36:02.9523112+01:00</DateLiveAsAr>
  <DateOfBirth>2025-08-27T03:36:02.9523112+01:00</DateOfBirth>
  <DateTrainedAsAr>2025-08-27T03:36:02.9523112+01:00</DateTrainedAsAr>
  <DonateToCharity>true</DonateToCharity>
  <EmailAddress i:nil="true" />
  <EstMonthlyRehomed>1</EstMonthlyRehomed>
  <EstPrimaryVaccinations>1</EstPrimaryVaccinations>
  <ExternalPracticeReference>sample string 25</ExternalPracticeReference>
  <FaxNumber i:nil="true" />
  <FcaStatusId>1bc63df0-6218-40a2-b322-888a80804e72</FcaStatusId>
  <Forename>sample string 26</Forename>
  <HouseName>sample string 27</HouseName>
  <HouseNumber>sample string 28</HouseNumber>
  <Id>f21472e8-ff41-40dd-baca-da31450e53c2</Id>
  <KcAccredited>true</KcAccredited>
  <KcBreederId>sample string 29</KcBreederId>
  <LitterReady>true</LitterReady>
  <LitterReadyDate>2025-08-27T03:36:02.9523112+01:00</LitterReadyDate>
  <MiddleNames>sample string 30</MiddleNames>
  <MobileNumber i:nil="true" />
  <Name>sample string 31</Name>
  <NumberOfBitchesQueens>1</NumberOfBitchesQueens>
  <NumberOfLittersPerYear>1</NumberOfLittersPerYear>
  <OptOutEmail>true</OptOutEmail>
  <OptOutPhone>true</OptOutPhone>
  <OptOutPost>true</OptOutPost>
  <OptOutSms>true</OptOutSms>
  <ParentAffiliateId>50d00d16-806f-43be-84fd-97c2e15cf1c4</ParentAffiliateId>
  <PostCode>sample string 32</PostCode>
  <PracticeManagementSystemUsed>sample string 33</PracticeManagementSystemUsed>
  <PracticePartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>d0655c65-c871-43e3-8f75-7d711c533393</d2p1:guid>
    <d2p1:guid>170e4808-2f9e-4f36-bf19-811fef2f8b77</d2p1:guid>
  </PracticePartnerIds>
  <PreferredBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>61813a8c-97fd-4074-9c6f-90530fa55a34</d2p1:guid>
    <d2p1:guid>2d49dc91-dc91-4269-bd2f-4d488090f468</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>fced23d4-c0c3-41c5-89d7-e4baf0b84f37</d2p1:guid>
    <d2p1:guid>19ab4b7f-3af1-402a-ba2d-24ce2437e7c6</d2p1:guid>
  </PreferredSpecies>
  <PrincipalEmail>sample string 34</PrincipalEmail>
  <Rating>sample string 35</Rating>
  <RewardAmount>1</RewardAmount>
  <RvcCode>sample string 36</RvcCode>
  <SelfBreedAllLittersSold>true</SelfBreedAllLittersSold>
  <SubjectToInvestigation>true</SubjectToInvestigation>
  <Surname>sample string 37</Surname>
  <TelephoneNumber i:nil="true" />
  <Town>sample string 38</Town>
  <TradingName>sample string 39</TradingName>
  <TypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>549ab491-9f06-478d-9a8c-6fe38e6898c3</d2p1:guid>
    <d2p1:guid>4e935c08-8381-47ed-8684-026abaf27c1e</d2p1:guid>
  </TypeIds>
  <VetClaimPaymentGroupId>6381bae6-d1a1-4cbb-b32b-82ad006c3ea3</VetClaimPaymentGroupId>
  <VetGroupId>b802ece7-b776-4633-a555-beadfd5f09c5</VetGroupId>
  <Website>sample string 40</Website>
  <AccountHolderName>sample string 1</AccountHolderName>
  <AccountNumber>sample string 2</AccountNumber>
  <AppointedRepresentativeStatusId>79e38be5-3980-4a33-a39a-be26d97a672d</AppointedRepresentativeStatusId>
  <Charity>
    <Id>8a0da0a1-99a5-466f-95df-ca2ddc5bd8f0</Id>
    <Name>sample string 2</Name>
  </Charity>
  <EmailAddress>sample string 3</EmailAddress>
  <FaxNumber>sample string 4</FaxNumber>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 6</LastName>
  <MarketingContactByEmail>true</MarketingContactByEmail>
  <MarketingContactByPhone>true</MarketingContactByPhone>
  <MarketingContactByPost>true</MarketingContactByPost>
  <MarketingContactBySMS>true</MarketingContactBySMS>
  <MobileNumber>sample string 11</MobileNumber>
  <RewardTotal>12</RewardTotal>
  <SortCode>sample string 13</SortCode>
  <TelephoneNumber>sample string 14</TelephoneNumber>
  <TitleId>0bcc1c9f-5e9d-4318-8723-70ef5258f831</TitleId>
</AffiliateDetails>