ClubReady Api

<back to all web services

CreditDetailRequest

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

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	]
}