ClubReady Api

<back to all web services

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.*;

public class dtos
{

    public static class GetSalesPackageRequest extends GetSalesPackageRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = 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")
        public Integer StoreId = 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")
        public Integer ChainId = 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")
        public Integer PackageId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetSalesPackageRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetSalesPackageRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetSalesPackageRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getPackageId() { return PackageId; }
        public GetSalesPackageRequest setPackageId(Integer value) { this.PackageId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetSalesPackageRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetSalesPackageRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetSalesPackageRequestDto extends ApiDtoBase
    {
        public Integer PackageId = null;
        
        public Integer getPackageId() { return PackageId; }
        public GetSalesPackageRequestDto setPackageId(Integer value) { this.PackageId = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java GetSalesPackageRequest DTOs

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

HTTP + JSV

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: text/jsv