ClubReady Api

DoCheckInRequest

Check a user into a club

The following routes are available for this service:
POST	/users/checkin	Check User Into Club

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 DoCheckInRequestDto() = 
        inherit ApiDtoBase()
        member val Barcode:String = null with get,set
        member val UserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UtcTimeStamp:DateTime = new DateTime() with get,set

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

    ///<summary>
    ///Check a user into a club
    ///</summary>
    [<Api(Description="Check a user into a club")>]
    [<AllowNullLiteral>]
    type DoCheckInRequest() = 
        inherit DoCheckInRequestDto()
        ///<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>
        ///User barcode
        ///</summary>
        [<ApiMember(DataType="string", Description="User barcode", IsRequired=true, Name="Barcode", ParameterType="query")>]
        member val Barcode:String = null with get,set

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

        ///<summary>
        ///UserId to check into club
        ///</summary>
        [<ApiMember(DataType="integer", Description="UserId to check into club", Name="UserId", ParameterType="query")>]
        member val UserId: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

F# DoCheckInRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/checkin HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	Barcode: String,
	StoreId: 0,
	UserId: 0,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	UtcTimeStamp: 0001-01-01,
	ChainId: 0
}