POST api/ProductComparison

Creates a new Product Comparison Research document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LicenseKey	string	None.
CompanyId	string	None.
SiteId	string	None.
HeaderImageBase64	string	None.
HeaderImageType	ImageType	None.
AdviserName	string	None.
Applicants	Collection of ProductComparisonApplicant	None.
LoanDetails	ProductComparisonLoanDetails	None.
ProductDetails	Collection of ProductComparisonProductDetail	None.
AdditionalInformation	string	None.
TrueCostCalculatedOverNumMonths	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LicenseKey": "sample string 1",
  "CompanyId": "sample string 2",
  "SiteId": "sample string 3",
  "HeaderImageBase64": "sample string 4",
  "HeaderImageType": 0,
  "AdviserName": "sample string 5",
  "Applicants": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Title": "sample string 3"
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Title": "sample string 3"
    }
  ],
  "LoanDetails": {
    "LoanPurpose": "sample string 1",
    "MortgageType": 0,
    "PropertyValue": 2.0,
    "LoanAmount": 3.0,
    "LoanRequiredInvestmentPart": 4.0,
    "Term": 5,
    "TermUnit": 0,
    "PaymentMethod": 0,
    "PaymentMethodDescription": "sample string 6"
  },
  "ProductDetails": [
    {
      "LenderName": "sample string 1",
      "ProductName": "sample string 2",
      "ProductCode": "sample string 3",
      "FullRateDescription": "sample string 4",
      "InitialPayRate": 5.0,
      "InitialRatePeriod": "sample string 6",
      "EarlyRepaymentCharge": "sample string 7",
      "OverpaymentsAllowed": true,
      "MaxOverpaymentPercentNoERC": 9,
      "ArrangementFee": 10.0,
      "BookingFee": 11.0,
      "ValuationFee": 12.0,
      "CHAPSFee": 13.0,
      "ProductType": "sample string 14",
      "MortgageDischargeFee": 15.0,
      "DeedsReleaseFee": 16.0,
      "DisbursementFee": 17.0,
      "HigherLendingCharge": 18.0,
      "FreeLegalFees": true,
      "ValuationFeeConditions": "sample string 20",
      "Cashback": 21.0,
      "InitialMonthlyPayment": 22.0,
      "TruecostOverInitialPeriod": 23.0,
      "TrueCost": 24.0,
      "TrueCostFullTerm": 25.0,
      "DeferredPayment": true
    },
    {
      "LenderName": "sample string 1",
      "ProductName": "sample string 2",
      "ProductCode": "sample string 3",
      "FullRateDescription": "sample string 4",
      "InitialPayRate": 5.0,
      "InitialRatePeriod": "sample string 6",
      "EarlyRepaymentCharge": "sample string 7",
      "OverpaymentsAllowed": true,
      "MaxOverpaymentPercentNoERC": 9,
      "ArrangementFee": 10.0,
      "BookingFee": 11.0,
      "ValuationFee": 12.0,
      "CHAPSFee": 13.0,
      "ProductType": "sample string 14",
      "MortgageDischargeFee": 15.0,
      "DeedsReleaseFee": 16.0,
      "DisbursementFee": 17.0,
      "HigherLendingCharge": 18.0,
      "FreeLegalFees": true,
      "ValuationFeeConditions": "sample string 20",
      "Cashback": 21.0,
      "InitialMonthlyPayment": 22.0,
      "TruecostOverInitialPeriod": 23.0,
      "TrueCost": 24.0,
      "TrueCostFullTerm": 25.0,
      "DeferredPayment": true
    }
  ],
  "AdditionalInformation": "sample string 6",
  "TrueCostCalculatedOverNumMonths": 1
}

application/xml, text/xml

Sample:

<ProductComparisonDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common">
  <AdditionalInformation>sample string 6</AdditionalInformation>
  <AdviserName>sample string 5</AdviserName>
  <Applicants>
    <ProductComparisonApplicant>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <Title>sample string 3</Title>
    </ProductComparisonApplicant>
    <ProductComparisonApplicant>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <Title>sample string 3</Title>
    </ProductComparisonApplicant>
  </Applicants>
  <CompanyId>sample string 2</CompanyId>
  <HeaderImageBase64>sample string 4</HeaderImageBase64>
  <HeaderImageType>Jpeg</HeaderImageType>
  <LicenseKey>sample string 1</LicenseKey>
  <LoanDetails>
    <LoanAmount>3</LoanAmount>
    <LoanPurpose>sample string 1</LoanPurpose>
    <LoanRequiredInvestmentPart>4</LoanRequiredInvestmentPart>
    <MortgageType>Standard</MortgageType>
    <PaymentMethod>Repayment</PaymentMethod>
    <PaymentMethodDescription>sample string 6</PaymentMethodDescription>
    <PropertyValue>2</PropertyValue>
    <Term>5</Term>
    <TermUnit>Years</TermUnit>
  </LoanDetails>
  <ProductDetails>
    <ProductComparisonProductDetail>
      <ArrangementFee>10</ArrangementFee>
      <BookingFee>11</BookingFee>
      <CHAPSFee>13</CHAPSFee>
      <Cashback>21</Cashback>
      <DeedsReleaseFee>16</DeedsReleaseFee>
      <DeferredPayment>true</DeferredPayment>
      <DisbursementFee>17</DisbursementFee>
      <EarlyRepaymentCharge>sample string 7</EarlyRepaymentCharge>
      <FreeLegalFees>true</FreeLegalFees>
      <FullRateDescription>sample string 4</FullRateDescription>
      <HigherLendingCharge>18</HigherLendingCharge>
      <InitialMonthlyPayment>22</InitialMonthlyPayment>
      <InitialPayRate>5</InitialPayRate>
      <InitialRatePeriod>sample string 6</InitialRatePeriod>
      <LenderName>sample string 1</LenderName>
      <MaxOverpaymentPercentNoERC>9</MaxOverpaymentPercentNoERC>
      <MortgageDischargeFee>15</MortgageDischargeFee>
      <OverpaymentsAllowed>true</OverpaymentsAllowed>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 2</ProductName>
      <ProductType>sample string 14</ProductType>
      <TrueCost>24</TrueCost>
      <TrueCostFullTerm>25</TrueCostFullTerm>
      <TruecostOverInitialPeriod>23</TruecostOverInitialPeriod>
      <ValuationFee>12</ValuationFee>
      <ValuationFeeConditions>sample string 20</ValuationFeeConditions>
    </ProductComparisonProductDetail>
    <ProductComparisonProductDetail>
      <ArrangementFee>10</ArrangementFee>
      <BookingFee>11</BookingFee>
      <CHAPSFee>13</CHAPSFee>
      <Cashback>21</Cashback>
      <DeedsReleaseFee>16</DeedsReleaseFee>
      <DeferredPayment>true</DeferredPayment>
      <DisbursementFee>17</DisbursementFee>
      <EarlyRepaymentCharge>sample string 7</EarlyRepaymentCharge>
      <FreeLegalFees>true</FreeLegalFees>
      <FullRateDescription>sample string 4</FullRateDescription>
      <HigherLendingCharge>18</HigherLendingCharge>
      <InitialMonthlyPayment>22</InitialMonthlyPayment>
      <InitialPayRate>5</InitialPayRate>
      <InitialRatePeriod>sample string 6</InitialRatePeriod>
      <LenderName>sample string 1</LenderName>
      <MaxOverpaymentPercentNoERC>9</MaxOverpaymentPercentNoERC>
      <MortgageDischargeFee>15</MortgageDischargeFee>
      <OverpaymentsAllowed>true</OverpaymentsAllowed>
      <ProductCode>sample string 3</ProductCode>
      <ProductName>sample string 2</ProductName>
      <ProductType>sample string 14</ProductType>
      <TrueCost>24</TrueCost>
      <TrueCostFullTerm>25</TrueCostFullTerm>
      <TruecostOverInitialPeriod>23</TruecostOverInitialPeriod>
      <ValuationFee>12</ValuationFee>
      <ValuationFeeConditions>sample string 20</ValuationFeeConditions>
    </ProductComparisonProductDetail>
  </ProductDetails>
  <SiteId>sample string 3</SiteId>
  <TrueCostCalculatedOverNumMonths>1</TrueCostCalculatedOverNumMonths>
</ProductComparisonDocumentRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProductComparisonDocumentRequest'.

Response Information

Resource Description

A ProductComparison document id

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.