ClubReady Api

GetSalesPackageDiscountsRequest

The following routes are available for this service:
GET	/sales/packages/{PackageId}/installments	Get sales package installments

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetSalesPackageDiscountsRequest : GetSalesPackageInstallmentsDto(), IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * ID # of store to get package plans for
    */
    @ApiMember(DataType="string", Description="ID # of store to get package plans for", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID # of package to get installment plans for
    */
    @ApiMember(DataType="string", Description="ID # of package to get installment plans for", IsRequired=true, Name="PackageId", ParameterType="path")
    var PackageId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class GetSalesPackageInstallmentsDto : ApiDtoBase()
{
    var PackageId:Int? = null
}

open class ApiDtoBase : IApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

Kotlin GetSalesPackageDiscountsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sales/packages/{PackageId}/installments HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSalesPackageInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <SalesPackageInstallmentPlanResponse>
    <DuePerPayment>String</DuePerPayment>
    <Fees>
      <PackageFee>
        <Amount>String</Amount>
        <CanBeWaived>false</CanBeWaived>
        <CanDuplicate>false</CanDuplicate>
        <DueUpfront>false</DueUpfront>
        <Name>String</Name>
        <OneTime>false</OneTime>
        <PayFrequencyMonths>0</PayFrequencyMonths>
        <Taxable>false</Taxable>
      </PackageFee>
    </Fees>
    <ForOnlineSale>false</ForOnlineSale>
    <Id>0</Id>
    <PaymentCount>0</PaymentCount>
  </SalesPackageInstallmentPlanResponse>
</ArrayOfSalesPackageInstallmentPlanResponse>