ClubReady Api

<back to all web services

CreditDetailRequest

The following routes are available for this service:
GET/scheduling/{UserId}/credit-detailBreakdown of a user's credits.

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

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

HTTP + XML

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

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <Credits xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <SessionCreditDetail>
      <Available>0</Available>
      <ClassId>0</ClassId>
      <Name>String</Name>
      <ServiceId>0</ServiceId>
      <SessionSizeId>0</SessionSizeId>
      <StoreId>0</StoreId>
      <Total>0</Total>
    </SessionCreditDetail>
  </Credits>
  <TotalAvailable xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalAvailable>
  <TotalPurchased xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalPurchased>
</CreditDetailResponse>