POST v1/companies-web/purchase-rights
Request Information
URI Parameters
None.
Body Parameters
RightToPurchaseRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseRights | Collection of RightToPurchaseForm |
None. |
|
| CompanyName | string |
Required |
|
| CompanyBic | string |
Required |
|
| RepresentativeFirstName | string |
Required |
|
| RepresentativeLastName | string |
Required |
|
| RepresentativePhone | string |
Required |
|
| RepresentativeEmail | string |
Required |
|
| SourceData | TransactionSourceData |
None. |
Request Formats
application/json, text/json
Sample:
{
"PurchaseRights": [
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Phone": "sample string 3",
"Email": "sample string 4"
},
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Phone": "sample string 3",
"Email": "sample string 4"
}
],
"CompanyName": "sample string 1",
"CompanyBic": "sample string 2",
"RepresentativeFirstName": "sample string 3",
"RepresentativeLastName": "sample string 4",
"RepresentativePhone": "sample string 5",
"RepresentativeEmail": "sample string 6",
"SourceData": {
"ChannelEnum": 0,
"IdentificationTypeEnum": "NULL",
"CreateTime": "2026-07-02T10:22:56.9753631+00:00",
"IdentificationBankCode": "sample string 1",
"IdentificationDetail": "sample string 2",
"IpAddress": "sample string 3",
"DeviceTypeCode": "sample string 4",
"ApplicationSourceEnum": 0,
"AffiliateSourceCode": "sample string 5",
"AffiliateMediumCode": "sample string 6",
"AffiliateCampaignCode": "sample string 7",
"AffiliateTransactionCode": "sample string 8",
"SearchEngineCode": "sample string 9",
"SearchEngineTransactionCode": "sample string 10",
"SearchKeyword": "sample string 11",
"OperatingSystemCode": "sample string 12",
"LandingPageUrl": "sample string 13",
"PageUrl": "sample string 14",
"IsMobileDevice": true,
"TrackingCookieId": "sample string 15",
"SessionCode": "sample string 16",
"FirstVisitTime": "2026-07-02T10:22:56.9753631+00:00",
"SessionStartTime": "2026-07-02T10:22:56.9753631+00:00",
"PageVisitHistory": "sample string 17",
"ReferrerUrl": "sample string 18",
"ExternalCampaignCode": "sample string 19",
"ExternalTransactionCode": "sample string 20",
"UserName": "sample string 21",
"UserRoleCode": "sample string 22",
"ABTestingCode": "sample string 23"
}
}
application/xml, text/xml
Sample:
<RightToPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
<SourceData>
<ABTestingCode>sample string 23</ABTestingCode>
<AffiliateCampaignCode>sample string 7</AffiliateCampaignCode>
<AffiliateMediumCode>sample string 6</AffiliateMediumCode>
<AffiliateSourceCode>sample string 5</AffiliateSourceCode>
<AffiliateTransactionCode>sample string 8</AffiliateTransactionCode>
<ApplicationSourceEnum>NULL</ApplicationSourceEnum>
<ChannelEnum>NULL</ChannelEnum>
<CreateTime>2026-07-02T10:22:56.9753631+00:00</CreateTime>
<DeviceTypeCode>sample string 4</DeviceTypeCode>
<ExternalCampaignCode>sample string 19</ExternalCampaignCode>
<ExternalTransactionCode>sample string 20</ExternalTransactionCode>
<FirstVisitTime>2026-07-02T10:22:56.9753631+00:00</FirstVisitTime>
<IdentificationBankCode>sample string 1</IdentificationBankCode>
<IdentificationDetail>sample string 2</IdentificationDetail>
<IdentificationTypeEnum>NULL</IdentificationTypeEnum>
<IpAddress>sample string 3</IpAddress>
<IsMobileDevice>true</IsMobileDevice>
<LandingPageUrl>sample string 13</LandingPageUrl>
<OperatingSystemCode>sample string 12</OperatingSystemCode>
<PageUrl>sample string 14</PageUrl>
<PageVisitHistory>sample string 17</PageVisitHistory>
<ReferrerUrl>sample string 18</ReferrerUrl>
<SearchEngineCode>sample string 9</SearchEngineCode>
<SearchEngineTransactionCode>sample string 10</SearchEngineTransactionCode>
<SearchKeyword>sample string 11</SearchKeyword>
<SessionCode>sample string 16</SessionCode>
<SessionStartTime>2026-07-02T10:22:56.9753631+00:00</SessionStartTime>
<TrackingCookieId>sample string 15</TrackingCookieId>
<UserName>sample string 21</UserName>
<UserRoleCode>sample string 22</UserRoleCode>
</SourceData>
<CompanyBic>sample string 2</CompanyBic>
<CompanyName>sample string 1</CompanyName>
<PurchaseRights>
<RightToPurchaseForm>
<Email>sample string 4</Email>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<Phone>sample string 3</Phone>
</RightToPurchaseForm>
<RightToPurchaseForm>
<Email>sample string 4</Email>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<Phone>sample string 3</Phone>
</RightToPurchaseForm>
</PurchaseRights>
<RepresentativeEmail>sample string 6</RepresentativeEmail>
<RepresentativeFirstName>sample string 3</RepresentativeFirstName>
<RepresentativeLastName>sample string 4</RepresentativeLastName>
<RepresentativePhone>sample string 5</RepresentativePhone>
</RightToPurchaseRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.