ClubReady Api

<back to all web services

GetSalesPackageRequest

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetSalesPackageRequestDto extends ApiDtoBase
{
    public PackageId: number;

    public constructor(init?: Partial<GetSalesPackageRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export 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 ApiKey: string;

    /**
    * 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 StoreId?: number;

    /**
    * 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 ChainId?: number;

    /**
    * 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 PackageId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetSalesPackageRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetSalesPackageRequest DTOs

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