ClubReady Api

<back to all web services

PackageEligibilityRequest

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 PackageEligibilityRequestDto extends ApiDtoBase
{
    public PackageId: number;
    public MemberId: number;

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

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

export class PackageEligibilityRequest extends PackageEligibilityRequestDto 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;

    /**
    * Store ID # member belongs to
    */
    // @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * ID of the member to lookup
    */
    // @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
    public MemberId: number;

    /**
    * ID of the package to check
    */
    // @ApiMember(DataType="integer", Description="ID of the package to check", IsRequired=true, Name="PackageId", ParameterType="query")
    public PackageId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

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

export class PackageEligibilityItem
{
    public Name: string;
    public Value: string;
    public IsEligible: boolean;
    public Message: string;

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

export class PackageEligibility
{
    public IsEligible: boolean;
    public Eligibility: PackageEligibilityItem[];

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

export class PackageEligibilityResponseDto extends ApiResponseBase
{
    public EligibilityInfo: PackageEligibility;

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

export class PackageEligibilityResponse extends PackageEligibilityResponseDto
{
    public EligibilityInfo: PackageEligibility;

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

TypeScript PackageEligibilityRequest DTOs

GET /sales/members/{MemberId}/package-eligibility HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EligibilityInfo: 
	{
		IsEligible: False,
		Eligibility: 
		[
			{
				Name: String,
				Value: String,
				IsEligible: False,
				Message: String
			}
		]
	},
	Success: False,
	Message: String
}