ClubReady Api

DoCheckInRequest

Check a user into a club

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.ClubAccess.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class DoCheckInRequestDto
            Inherits ApiDtoBase
            Public Overridable Property Barcode As String
            Public Overridable Property UserId As Nullable(Of Integer)
            Public Overridable Property UtcTimeStamp As Date
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.ClubAccess.Model

        '''<Summary>
        '''Check a user into a club
        '''</Summary>
        <Api(Description:="Check a user into a club")>
        Public Partial Class DoCheckInRequest
            Inherits DoCheckInRequestDto
            Implements 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 Overridable Property ApiKey As String

            '''<Summary>
            '''User barcode
            '''</Summary>
            <ApiMember(DataType:="string", Description:="User barcode", IsRequired:=true, Name:="Barcode", ParameterType:="query")>
            Public Overridable Property Barcode As String

            '''<Summary>
            '''ClubReady StoreId required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady StoreId required", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''UserId to check into club
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="UserId to check into club", Name:="UserId", ParameterType:="query")>
            Public Overridable Property UserId As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class
    End Namespace
End Namespace

VB.NET DoCheckInRequest DTOs

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

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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