Tradera Developer Program

RestrictedService

Documentation Version 3 > RestrictedService > ValidateCampaignCode

ValidateCampaignCode |WebMethod|

Validates a campaign code given the user context and the supplied category id.
NOTE: This method is considered internal and might be changed at any time without prior notice.

Parameters
  1. campaignCode, Campaign code to validate
  2. categoryId, The category to be used in the validation context
Returns

Campaign code details and validation info

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/ValidateCampaignCode"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <ValidateCampaignCode xmlns="http://api.tradera.com">
      <campaignCode>string</campaignCode>
      <categoryId>int</categoryId>
    </ValidateCampaignCode>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ValidateCampaignCodeResponse xmlns="http://api.tradera.com">
      <ValidateCampaignCodeResult>
        <IsValid>boolean</IsValid>
        <IsInvalidBecauseDoesNotExist>boolean</IsInvalidBecauseDoesNotExist>
        <IsInvalidBecauseHasNotStarted>boolean</IsInvalidBecauseHasNotStarted>
        <IsInvalidBecauseHasEnded>boolean</IsInvalidBecauseHasEnded>
        <IsInvalidBecauseCategoryIsNotAllowed>boolean</IsInvalidBecauseCategoryIsNotAllowed>
        <IsInvalidBecauseAlreadyUsed>boolean</IsInvalidBecauseAlreadyUsed>
        <IsInvalidBecauseUserIsNotAllowed>boolean</IsInvalidBecauseUserIsNotAllowed>
        <Description>string</Description>
        <DiscountFactor>decimal</DiscountFactor>
        <ProvisionFactor>decimal</ProvisionFactor>
        <MaxFeeCap>decimal</MaxFeeCap>
        <IsCustomLengthFeeFree>boolean</IsCustomLengthFeeFree>
        <IsUnsoldFeeFree>boolean</IsUnsoldFeeFree>
      </ValidateCampaignCodeResult>
    </ValidateCampaignCodeResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <ValidateCampaignCode xmlns="http://api.tradera.com">
      <campaignCode>string</campaignCode>
      <categoryId>int</categoryId>
    </ValidateCampaignCode>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ValidateCampaignCodeResponse xmlns="http://api.tradera.com">
      <ValidateCampaignCodeResult>
        <IsValid>boolean</IsValid>
        <IsInvalidBecauseDoesNotExist>boolean</IsInvalidBecauseDoesNotExist>
        <IsInvalidBecauseHasNotStarted>boolean</IsInvalidBecauseHasNotStarted>
        <IsInvalidBecauseHasEnded>boolean</IsInvalidBecauseHasEnded>
        <IsInvalidBecauseCategoryIsNotAllowed>boolean</IsInvalidBecauseCategoryIsNotAllowed>
        <IsInvalidBecauseAlreadyUsed>boolean</IsInvalidBecauseAlreadyUsed>
        <IsInvalidBecauseUserIsNotAllowed>boolean</IsInvalidBecauseUserIsNotAllowed>
        <Description>string</Description>
        <DiscountFactor>decimal</DiscountFactor>
        <ProvisionFactor>decimal</ProvisionFactor>
        <MaxFeeCap>decimal</MaxFeeCap>
        <IsCustomLengthFeeFree>boolean</IsCustomLengthFeeFree>
        <IsUnsoldFeeFree>boolean</IsUnsoldFeeFree>
      </ValidateCampaignCodeResult>
    </ValidateCampaignCodeResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3/RestrictedService.asmx/ValidateCampaignCode?campaignCode=string&categoryId=string HTTP/1.1
Host: api.tradera.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ValidateCampaignCodeResult xmlns="http://api.tradera.com">
  <IsValid>boolean</IsValid>
  <IsInvalidBecauseDoesNotExist>boolean</IsInvalidBecauseDoesNotExist>
  <IsInvalidBecauseHasNotStarted>boolean</IsInvalidBecauseHasNotStarted>
  <IsInvalidBecauseHasEnded>boolean</IsInvalidBecauseHasEnded>
  <IsInvalidBecauseCategoryIsNotAllowed>boolean</IsInvalidBecauseCategoryIsNotAllowed>
  <IsInvalidBecauseAlreadyUsed>boolean</IsInvalidBecauseAlreadyUsed>
  <IsInvalidBecauseUserIsNotAllowed>boolean</IsInvalidBecauseUserIsNotAllowed>
  <Description>string</Description>
  <DiscountFactor>decimal</DiscountFactor>
  <ProvisionFactor>decimal</ProvisionFactor>
  <MaxFeeCap>decimal</MaxFeeCap>
  <IsCustomLengthFeeFree>boolean</IsCustomLengthFeeFree>
  <IsUnsoldFeeFree>boolean</IsUnsoldFeeFree>
</ValidateCampaignCodeResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx/ValidateCampaignCode HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

campaignCode=string&categoryId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ValidateCampaignCodeResult xmlns="http://api.tradera.com">
  <IsValid>boolean</IsValid>
  <IsInvalidBecauseDoesNotExist>boolean</IsInvalidBecauseDoesNotExist>
  <IsInvalidBecauseHasNotStarted>boolean</IsInvalidBecauseHasNotStarted>
  <IsInvalidBecauseHasEnded>boolean</IsInvalidBecauseHasEnded>
  <IsInvalidBecauseCategoryIsNotAllowed>boolean</IsInvalidBecauseCategoryIsNotAllowed>
  <IsInvalidBecauseAlreadyUsed>boolean</IsInvalidBecauseAlreadyUsed>
  <IsInvalidBecauseUserIsNotAllowed>boolean</IsInvalidBecauseUserIsNotAllowed>
  <Description>string</Description>
  <DiscountFactor>decimal</DiscountFactor>
  <ProvisionFactor>decimal</ProvisionFactor>
  <MaxFeeCap>decimal</MaxFeeCap>
  <IsCustomLengthFeeFree>boolean</IsCustomLengthFeeFree>
  <IsUnsoldFeeFree>boolean</IsUnsoldFeeFree>
</ValidateCampaignCodeResult>

XHTML CSS