POST api/Breeder/ActivateFreeCover
Request Information
URI Parameters
None.
Body Parameters
BreederFreeCoverRequestName | Description | Type | Additional information |
---|---|---|---|
BrandId | globally unique identifier |
None. |
|
BreederAffiliateId | globally unique identifier |
None. |
|
Customer | Customer |
None. |
|
Id | globally unique identifier |
None. |
|
Pet | Pet |
None. |
|
PolicyStartDate | date |
None. |
|
TermsAgreed | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "BrandId": "113958d9-beab-4434-98d3-4505ce201869", "BreederAffiliateId": "f14ead5d-becf-47f4-8bfb-4ff28f51d23e", "Customer": { "AddressLine1": "sample string 1", "AddressLine2": "sample string 2", "AddressLine3": "sample string 3", "CountryId": "41203077-82be-457b-b53c-be337a8ef27f", "County": "sample string 4", "DateOfBirth": "2025-08-27T03:32:50.1696928+01:00", "DaytimeNumber": "sample string 5", "EmailAddress": "sample string 6", "EveningNumber": "sample string 7", "FirstName": "sample string 8", "HouseName": "sample string 9", "HouseNumber": "sample string 10", "Id": "29a7b084-b431-4cfa-984d-23c21d60a359", "IsLocked": true, "LastName": "sample string 12", "MobileNumber": "sample string 13", "PostCode": "sample string 14", "TitleId": "178f473c-4e53-46f2-87fd-43ac28375094", "Town": "sample string 15", "MarketingContactByEmail": true, "MarketingContactByPhone": true, "MarketingContactByPost": true, "MarketingContactBySMS": true, "Policies": [ { "PolicyId": "4332804b-bdaf-4ddb-9a1e-86847d78b57d", "PolicyNumber": "sample string 2", "PolicyEffectiveFrom": "2025-08-27T03:32:50.1696928+01:00", "PolicyEffectiveTo": "2025-08-27T03:32:50.1696928+01:00", "Brand": "sample string 3", "Product": "sample string 4", "PetSpecies": "sample string 5", "PetDOB": "2025-08-27T03:32:50.1696928+01:00", "PetBreed": "sample string 6", "PetName": "sample string 7", "PetPhoto": { "Id": "c402072e-6e93-425e-a67e-3435e242167b", "FileExtension": "sample string 2", "Size": 3, "Data": "QEA=" } }, { "PolicyId": "4332804b-bdaf-4ddb-9a1e-86847d78b57d", "PolicyNumber": "sample string 2", "PolicyEffectiveFrom": "2025-08-27T03:32:50.1696928+01:00", "PolicyEffectiveTo": "2025-08-27T03:32:50.1696928+01:00", "Brand": "sample string 3", "Product": "sample string 4", "PetSpecies": "sample string 5", "PetDOB": "2025-08-27T03:32:50.1696928+01:00", "PetBreed": "sample string 6", "PetName": "sample string 7", "PetPhoto": { "Id": "c402072e-6e93-425e-a67e-3435e242167b", "FileExtension": "sample string 2", "Size": 3, "Data": "QEA=" } } ] }, "Id": "c806dd1e-0cf1-4091-98ab-153e309411f6", "Pet": { "ActivityGroups": [ { "Id": "7c340913-0ddd-4b06-91e6-94da11f47cb2", "Name": "sample string 2", "Description": "sample string 3", "MappingValue": 1, "MtaOnly": true, "Priority": 1 }, { "Id": "7c340913-0ddd-4b06-91e6-94da11f47cb2", "Name": "sample string 2", "Description": "sample string 3", "MappingValue": 1, "MtaOnly": true, "Priority": 1 } ], "AggressiveBehaviour": true, "BreedId": "b0ba890b-99db-43a9-adbf-5b60fde80f14", "Cost": 1.0, "DateOfBirth": "2025-08-27T03:32:50.1696928+01:00", "DateOfBirthExact": true, "GenderId": "cc314bb8-d908-4340-bb5a-1752e62002da", "HadPriorThirdPartyLiabilityClaim": true, "Id": "a56113b0-6e14-4691-8390-ec24984193ba", "IllnessOrInjury": true, "IsMicrochipped": true, "IsNeutered": true, "IsVaccinated": true, "LastVaccinatedDate": "2025-08-27T03:32:50.1696928+01:00", "MicrochipNumber": "sample string 7", "Name": "sample string 8", "PolicyStartDate": "2025-08-27T03:32:50.1696928+01:00", "SpeciesId": "25f740eb-7508-4f06-826b-0263c2a7ea36", "SubSpeciesId": "8dc433c3-cb75-4340-b84a-66585bcdc38c", "VetChecked": true, "VetId": "826186d8-d780-4ff7-b888-94c5eceef80e" }, "PolicyStartDate": "2025-08-27T03:32:50.1696928+01:00", "TermsAgreed": true }
application/xml, text/xml
Sample:
<BreederFreeCoverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tss.Eitr.Customer.Agria.WebApi.Models"> <BrandId>113958d9-beab-4434-98d3-4505ce201869</BrandId> <BreederAffiliateId>f14ead5d-becf-47f4-8bfb-4ff28f51d23e</BreederAffiliateId> <Customer> <AddressLine1>sample string 1</AddressLine1> <AddressLine2>sample string 2</AddressLine2> <AddressLine3>sample string 3</AddressLine3> <CountryId>41203077-82be-457b-b53c-be337a8ef27f</CountryId> <County>sample string 4</County> <DateOfBirth>2025-08-27T03:32:50.1696928+01:00</DateOfBirth> <DaytimeNumber>sample string 5</DaytimeNumber> <EmailAddress>sample string 6</EmailAddress> <EveningNumber>sample string 7</EveningNumber> <FirstName>sample string 8</FirstName> <HouseName>sample string 9</HouseName> <HouseNumber>sample string 10</HouseNumber> <Id>29a7b084-b431-4cfa-984d-23c21d60a359</Id> <IsLocked>true</IsLocked> <LastName>sample string 12</LastName> <MarketingContactByEmail>true</MarketingContactByEmail> <MarketingContactByPhone>true</MarketingContactByPhone> <MarketingContactByPost>true</MarketingContactByPost> <MarketingContactBySMS>true</MarketingContactBySMS> <MobileNumber>sample string 13</MobileNumber> <Policies> <LoyaltyPolicyResponse> <Brand>sample string 3</Brand> <PetBreed>sample string 6</PetBreed> <PetDOB>2025-08-27T03:32:50.1696928+01:00</PetDOB> <PetName>sample string 7</PetName> <PetPhoto> <Data>QEA=</Data> <FileExtension>sample string 2</FileExtension> <Id>c402072e-6e93-425e-a67e-3435e242167b</Id> <Size>3</Size> </PetPhoto> <PetSpecies>sample string 5</PetSpecies> <PolicyEffectiveFrom>2025-08-27T03:32:50.1696928+01:00</PolicyEffectiveFrom> <PolicyEffectiveTo>2025-08-27T03:32:50.1696928+01:00</PolicyEffectiveTo> <PolicyId>4332804b-bdaf-4ddb-9a1e-86847d78b57d</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> <Product>sample string 4</Product> </LoyaltyPolicyResponse> <LoyaltyPolicyResponse> <Brand>sample string 3</Brand> <PetBreed>sample string 6</PetBreed> <PetDOB>2025-08-27T03:32:50.1696928+01:00</PetDOB> <PetName>sample string 7</PetName> <PetPhoto> <Data>QEA=</Data> <FileExtension>sample string 2</FileExtension> <Id>c402072e-6e93-425e-a67e-3435e242167b</Id> <Size>3</Size> </PetPhoto> <PetSpecies>sample string 5</PetSpecies> <PolicyEffectiveFrom>2025-08-27T03:32:50.1696928+01:00</PolicyEffectiveFrom> <PolicyEffectiveTo>2025-08-27T03:32:50.1696928+01:00</PolicyEffectiveTo> <PolicyId>4332804b-bdaf-4ddb-9a1e-86847d78b57d</PolicyId> <PolicyNumber>sample string 2</PolicyNumber> <Product>sample string 4</Product> </LoyaltyPolicyResponse> </Policies> <PostCode>sample string 14</PostCode> <TitleId>178f473c-4e53-46f2-87fd-43ac28375094</TitleId> <Town>sample string 15</Town> </Customer> <Id>c806dd1e-0cf1-4091-98ab-153e309411f6</Id> <Pet> <ActivityGroups> <ActivityGroup> <Description>sample string 3</Description> <Id>7c340913-0ddd-4b06-91e6-94da11f47cb2</Id> <MappingValue>1</MappingValue> <MtaOnly>true</MtaOnly> <Name>sample string 2</Name> <Priority>1</Priority> </ActivityGroup> <ActivityGroup> <Description>sample string 3</Description> <Id>7c340913-0ddd-4b06-91e6-94da11f47cb2</Id> <MappingValue>1</MappingValue> <MtaOnly>true</MtaOnly> <Name>sample string 2</Name> <Priority>1</Priority> </ActivityGroup> </ActivityGroups> <AggressiveBehaviour>true</AggressiveBehaviour> <BreedId>b0ba890b-99db-43a9-adbf-5b60fde80f14</BreedId> <Cost>1</Cost> <DateOfBirth>2025-08-27T03:32:50.1696928+01:00</DateOfBirth> <DateOfBirthExact>true</DateOfBirthExact> <GenderId>cc314bb8-d908-4340-bb5a-1752e62002da</GenderId> <HadPriorThirdPartyLiabilityClaim>true</HadPriorThirdPartyLiabilityClaim> <Id>a56113b0-6e14-4691-8390-ec24984193ba</Id> <IllnessOrInjury>true</IllnessOrInjury> <IsMicrochipped>true</IsMicrochipped> <IsNeutered>true</IsNeutered> <IsVaccinated>true</IsVaccinated> <LastVaccinatedDate>2025-08-27T03:32:50.1696928+01:00</LastVaccinatedDate> <MicrochipNumber>sample string 7</MicrochipNumber> <Name>sample string 8</Name> <PolicyStartDate>2025-08-27T03:32:50.1696928+01:00</PolicyStartDate> <SpeciesId>25f740eb-7508-4f06-826b-0263c2a7ea36</SpeciesId> <SubSpeciesId>8dc433c3-cb75-4340-b84a-66585bcdc38c</SubSpeciesId> <VetChecked>true</VetChecked> <VetId>826186d8-d780-4ff7-b888-94c5eceef80e</VetId> </Pet> <PolicyStartDate>2025-08-27T03:32:50.1696928+01:00</PolicyStartDate> <TermsAgreed>true</TermsAgreed> </BreederFreeCoverRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PolicyResponseName | Description | Type | Additional information |
---|---|---|---|
AnnualRate | decimal number |
None. |
|
Customer | Customer |
None. |
|
CustomerId | globally unique identifier |
None. |
|
FixedExcess | Excess |
None. |
|
Pet | Pet |
None. |
|
PolicyEndDate | date |
None. |
|
PolicyId | globally unique identifier |
None. |
|
PolicyNumber | string |
None. |
|
PolicyStartDate | date |
None. |
|
VariableExcess | Excess |
None. |
|
HasErrored | boolean |
None. |
|
Messages | Collection of Message |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.