ClubReady Api

<back to all web services

CreditDetailRequest

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

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

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

export class CreditDetailRequest extends ApiDtoBase 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;

    /**
    * Chain ID
    */
    // @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
    public UserId: number;

    /**
    * Determines if the list of the user's credits are broken out by store ID.
    */
    // @ApiMember(DataType="Boolean", Description="Determines if the list of the user's credits are broken out by store ID.", Name="FullDetail", ParameterType="query")
    public FullDetail: boolean;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<CreditDetailRequest>) { 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 SessionCreditDetail
{
    public ServiceId?: number;
    public SessionSizeId?: number;
    public ClassId?: number;
    public Name: string;
    public Total: number;
    public Available: number;
    public StoreId?: number;

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

export class CreditDetailResponseDto extends ApiResponseBase
{
    public TotalPurchased?: number;
    public TotalAvailable?: number;
    public Credits: SessionCreditDetail[];

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

export class CreditDetailResponse extends CreditDetailResponseDto
{
    public Success: boolean;
    public Message: string;
    public TotalPurchased?: number;
    public TotalAvailable?: number;
    public Credits: SessionCreditDetail[];

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

TypeScript CreditDetailRequest DTOs

GET /scheduling/{UserId}/credit-detail HTTP/1.1 
Host: clubready.com 
Accept: text/csv

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

{"Success":false,"Message":"String","TotalPurchased":0,"TotalAvailable":0,"Credits":[{"ServiceId":0,"SessionSizeId":0,"ClassId":0,"Name":"String","Total":0,"Available":0,"StoreId":0}]}