ClubReady Api

CreditCheckRequest

The following routes are available for this service:
GET	/scheduling/{UserId}/credit-check	Check to see if a particular credit can be used to book a certain class or service.

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 CreditCheckRequestDto
        : ApiDtoBase
    {
        public virtual int UserId { get; set; }
        public virtual int CustomerSessionId { get; set; }
        public virtual int? ClassId { get; set; }
        public virtual int? SessionSizeId { get; set; }
    }

    public partial class CreditCheckResponseDto
        : ApiResponseBase
    {
        public virtual bool CanUse { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Scheduling.Model
{
    public partial class CreditCheckRequest
        : CreditCheckRequestDto, 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>
        ///ClubReady Customer Session ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady Customer Session ID", IsRequired=true, Name="CustomerSessionId", ParameterType="query")]
        public virtual int CustomerSessionId { get; set; }

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

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

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

    public partial class CreditCheckResponse
        : CreditCheckResponseDto
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual bool CanUse { get; set; }
    }

}

C# CreditCheckRequest 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-check HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<CreditCheckResponse 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>
  <CanUse xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</CanUse>
</CreditCheckResponse>