Luminate Online

validateDiscount

Validates that the provided discount code applies to the participation type of the current user.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRTeamraiserAPI	None.	GET, POST	No.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=validateDiscount &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &discount_code=value &fr_id=value &participation_id=value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

discount_code

Required. Discount Code to apply to a participation type

Type xsd:string.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

participation_id

Required. The TeamRaiser participation type ID.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<validateDiscountResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValid>true</isValid>
  <discount>
    <discountedFee>$10.00</discountedFee>
    <discountedFeeDecimal>1000</discountedFeeDecimal>
    <discountAmount>$5.00</discountAmount>
    <discountAmountDecimal>500</discountAmountDecimal>
    <discountName>Sample Discount</discountName>
  </discount>
</validateDiscountResponse>

JSON response

{"validateDiscountResponse":{"isValid":"true","discount":{"discountName":"Sample Discount","discountedFee":"$10.00","discountedFeeDecimal":"1000","discountAmount":"$5.00","discountAmountDecimal":"500"}}}

validateDiscount

Client API Syntax

Client API Parameters

Response

Leave a Comment