GET api/web/client/{affiliateCode}/validate

This method will retrieve site user information and settings using affiliate code specified as part of the iframe url

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateCode	Business user affiliate code	string	Required

Body Parameters

None.

Response Information

Resource Description

Website owner business model and settings

WebsiteOwnerModel

Name	Type	Additional information
Id	integer	None.
FirstName	string	None.
LastName	string	None.
CompanyName	string	None.
WebsiteUrl	string	None.
AppealFlatFee	decimal number	None.
DiscountPercent	decimal number	None.
AnalysisFee	decimal number	None.
SendReferral	boolean	None.
PayReferralFee	boolean	None.
ReferralFeePercent	boolean	None.
ContingencyFeePercent	decimal number	None.
UserId	integer	None.
RequireUserRegistration	boolean	None.
CollectAnalysisFee	boolean	None.
IFrameBannerImageUrl	string	None.
Phone	string	None.
Email	string	None.
AffiliateCode	string	None.
IsActiveSubscriber	boolean	None.
IFrameEmailReportToWebUser	boolean	None.
IFrameEnabledAppeal	boolean	None.
IFrameEnabledAppealGuarantee	boolean	None.
IsBannerVisible	boolean	None.
PaymentGatewayPublicKey	string	None.
DigitalSignaturePackageUrl	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "companyName": "sample string 4",
  "websiteUrl": "sample string 5",
  "appealFlatFee": 1.0,
  "discountPercent": 1.0,
  "analysisFee": 6.0,
  "sendReferral": true,
  "payReferralFee": true,
  "referralFeePercent": true,
  "contingencyFeePercent": 1.0,
  "userId": 10,
  "requireUserRegistration": true,
  "collectAnalysisFee": true,
  "iFrameBannerImageUrl": "sample string 13",
  "phone": "sample string 14",
  "email": "sample string 15",
  "affiliateCode": "sample string 16",
  "isActiveSubscriber": true,
  "iFrameEmailReportToWebUser": true,
  "iFrameEnabledAppeal": true,
  "iFrameEnabledAppealGuarantee": true,
  "isBannerVisible": true,
  "paymentGatewayPublicKey": "sample string 22",
  "digitalSignaturePackageUrl": "sample string 23"
}

text/html

Sample:

{"id":1,"firstName":"sample string 2","lastName":"sample string 3","companyName":"sample string 4","websiteUrl":"sample string 5","appealFlatFee":1.0,"discountPercent":1.0,"analysisFee":6.0,"sendReferral":true,"payReferralFee":true,"referralFeePercent":true,"contingencyFeePercent":1.0,"userId":10,"requireUserRegistration":true,"collectAnalysisFee":true,"iFrameBannerImageUrl":"sample string 13","phone":"sample string 14","email":"sample string 15","affiliateCode":"sample string 16","isActiveSubscriber":true,"iFrameEmailReportToWebUser":true,"iFrameEnabledAppeal":true,"iFrameEnabledAppealGuarantee":true,"isBannerVisible":true,"paymentGatewayPublicKey":"sample string 22","digitalSignaturePackageUrl":"sample string 23"}

application/xml, text/xml

Sample:

<WebsiteOwnerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
  <AffiliateCode>sample string 16</AffiliateCode>
  <AnalysisFee>6</AnalysisFee>
  <AppealFlatFee>1</AppealFlatFee>
  <CollectAnalysisFee>true</CollectAnalysisFee>
  <CompanyName>sample string 4</CompanyName>
  <ContingencyFeePercent>1</ContingencyFeePercent>
  <DigitalSignaturePackageUrl>sample string 23</DigitalSignaturePackageUrl>
  <DiscountPercent>1</DiscountPercent>
  <Email>sample string 15</Email>
  <FirstName>sample string 2</FirstName>
  <IFrameBannerImageUrl>sample string 13</IFrameBannerImageUrl>
  <IFrameEmailReportToWebUser>true</IFrameEmailReportToWebUser>
  <IFrameEnabledAppeal>true</IFrameEnabledAppeal>
  <IFrameEnabledAppealGuarantee>true</IFrameEnabledAppealGuarantee>
  <Id>1</Id>
  <IsActiveSubscriber>true</IsActiveSubscriber>
  <IsBannerVisible>true</IsBannerVisible>
  <LastName>sample string 3</LastName>
  <PayReferralFee>true</PayReferralFee>
  <PaymentGatewayPublicKey>sample string 22</PaymentGatewayPublicKey>
  <Phone>sample string 14</Phone>
  <ReferralFeePercent>true</ReferralFeePercent>
  <RequireUserRegistration>true</RequireUserRegistration>
  <SendReferral>true</SendReferral>
  <UserId>10</UserId>
  <WebsiteUrl>sample string 5</WebsiteUrl>
</WebsiteOwnerModel>