ClubReady Api

<back to all web services

GetSalesPackagesRequest

The following routes are available for this service:
GET/sales/packagesGet Available packages for a chain or store
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetSalesPackagesRequest : GetSalesPackagesRequestDto(), IRestrictedApiRequest
{
    /**
    * 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 packages for
    */
    @ApiMember(DataType="string", Description="ID # of store to get packages for", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID # of the user to get packages for
    */
    @ApiMember(DataType="integer", Description="ID # of the user to get packages for", Name="UserId", ParameterType="query")
    var UserId:Int? = null

    /**
    * The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)
    */
    @ApiMember(DataType="integer", Description="The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)", Name="CreditFilterType", ParameterType="query")
    var CreditFilterType:Int? = null

    /**
    * ClassId or ClassScheduleId or SessionSizeId packages which drop credits
    */
    @ApiMember(DataType="integer", Description="ClassId or ClassScheduleId or SessionSizeId packages which drop credits", Name="CreditFilterId", ParameterType="query")
    var CreditFilterId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
    /**
    * Show packages enabled for In App purchase. True or False
    */
    @ApiMember(DataType="string", Description="Show packages enabled for In App purchase. True or False", Name="InApp", ParameterType="query")
    var InApp:Boolean? = null
}

open class GetSalesPackagesRequestDto : ApiDtoBase()
{
}

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

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

Kotlin GetSalesPackagesRequest DTOs

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

HTTP + CSV

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

GET /sales/packages HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv