ClubReady Api

CreditDetailRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Scheduling.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CreditDetailResponseDto
        : ApiResponseBase
    {
        public CreditDetailResponseDto()
        {
            Credits = new List<SessionCreditDetail>{};
        }

        public virtual int? TotalPurchased { get; set; }
        public virtual int? TotalAvailable { get; set; }
        public virtual List<SessionCreditDetail> Credits { get; set; }
    }

    public partial class SessionCreditDetail
    {
        public virtual int? ServiceId { get; set; }
        public virtual int? SessionSizeId { get; set; }
        public virtual int? ClassId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Total { get; set; }
        public virtual int Available { get; set; }
        public virtual int? StoreId { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Scheduling.Model
{
    public partial class CreditDetailRequest
        : ApiDtoBase, IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Chain ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Store ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")]
        public virtual int UserId { get; set; }

        ///<summary>
        ///Determines if the list of the user's credits are broken out by store ID.
        ///</summary>
        [ApiMember(DataType="Boolean", Description="Determines if the list of the user's credits are broken out by store ID.", Name="FullDetail", ParameterType="query")]
        public virtual bool FullDetail { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class CreditDetailResponse
        : CreditDetailResponseDto
    {
        public CreditDetailResponse()
        {
            Credits = new List<SessionCreditDetail>{};
        }

        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual int? TotalPurchased { get; set; }
        public virtual int? TotalAvailable { get; set; }
        public virtual List<SessionCreditDetail> Credits { get; set; }
    }

}

C# 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>