ClubReady Api

CreditDetailRequest

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

namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type CreditDetailRequest() = 
        inherit ApiDtoBase()
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Chain ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Store ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")>]
        member val UserId:Int32 = new Int32() with 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")>]
        member val FullDetail:Boolean = new Boolean() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type ApiResponseBase() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type SessionCreditDetail() = 
        member val ServiceId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SessionSizeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ClassId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set
        member val Total:Int32 = new Int32() with get,set
        member val Available:Int32 = new Int32() with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CreditDetailResponseDto() = 
        inherit ApiResponseBase()
        member val TotalPurchased:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TotalAvailable:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Credits:ResizeArray<SessionCreditDetail> = new ResizeArray<SessionCreditDetail>() with get,set

    [<AllowNullLiteral>]
    type CreditDetailResponse() = 
        inherit CreditDetailResponseDto()
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val TotalPurchased:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TotalAvailable:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Credits:ResizeArray<SessionCreditDetail> = new ResizeArray<SessionCreditDetail>() with get,set

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