| GET | /scheduling/{UserId}/credit-check | Check to see if a particular credit can be used to book a certain class or service. |
|---|
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
[<AllowNullLiteral>]
type CreditCheckRequestDto() =
inherit ApiDtoBase()
member val UserId:Int32 = new Int32() with get,set
member val CustomerSessionId:Int32 = new Int32() with get,set
member val ClassId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SessionSizeId:Nullable<Int32> = new Nullable<Int32>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type CreditCheckRequest() =
inherit CreditCheckRequestDto()
///<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>
///ClubReady Customer Session ID
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Customer Session ID", IsRequired=true, Name="CustomerSessionId", ParameterType="query")>]
member val CustomerSessionId:Int32 = new Int32() with get,set
///<summary>
///ClubReady Class ID
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Class ID", Name="ClassId", ParameterType="query")>]
member val ClassId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///ClubReady Session Size ID
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Session Size ID", Name="SessionSizeId", ParameterType="query")>]
member val SessionSizeId:Nullable<Int32> = new Nullable<Int32>() 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 CreditCheckResponseDto() =
inherit ApiResponseBase()
member val CanUse:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CreditCheckResponse() =
inherit CreditCheckResponseDto()
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
member val CanUse:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /scheduling/{UserId}/credit-check HTTP/1.1
Host: clubready.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Success":false,"Message":"String","CanUse":false}