ClubReady Api

GetSalesPackageRequest

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

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


open class GetSalesPackageRequest : GetSalesPackageRequestDto(), 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 package details for. <br//> Either StoreId or ChainId is required
    */
    @ApiMember(DataType="string", Description="ID # of store to get package details for. <br//> Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID # of chain to get package details for. <br//> Either StoreId or ChainId is required
    */
    @ApiMember(DataType="string", Description="ID # of chain to get package details for. <br//> Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

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

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

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

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

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

Kotlin GetSalesPackageRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /sales/package/{PackageId} HTTP/1.1 
Host: clubready.com 
Accept: application/json