ClubReady Api

ClubVisitHistoryRequest

The following routes are available for this service:
GET	/club/visit-history	Return list of club visits, by club or entire chain.

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
Imports ClubReady.Core.Clubs.Models

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 ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class ClubVisitHistoryRequestDto
            Inherits ApiDtoBase
            Public Overridable Property FromDate As Date
            Public Overridable Property ToDate As Date
        End Class

        Public Partial Class ClubVisitHistoryResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                Visits = New List(Of ClubVisitHistoryItem)
            End Sub

            Public Overridable Property TotalVisits As Integer
            Public Overridable Property Visits As List(Of ClubVisitHistoryItem)
        End Class
    End Namespace

    Namespace ClubReady.Core.Clubs.Models

        Public Partial Class ClubVisitHistoryItem
            Public Overridable Property CheckinLogId As Integer
            Public Overridable Property UserId As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property CheckinStoreId As Integer
            Public Overridable Property CheckinLocationName As String
            Public Overridable Property HomeStoreId As Integer
            Public Overridable Property HomeStoreLocationName As String
            Public Overridable Property UtcTime 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

        Public Partial Class ClubVisitHistoryRequest
            Inherits ClubVisitHistoryRequestDto
            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>
            '''Either StoreId or ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Either StoreId or ChainId is required", Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''Either StoreId or ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Either StoreId or ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''UTC Format
            '''</Summary>
            <ApiMember(DataType:="date", Description:="UTC Format", IsRequired:=true, Name:="FromDate", ParameterType:="query")>
            Public Overridable Property FromDate As Date

            '''<Summary>
            '''Max 24 Hours (UTC Format)
            '''</Summary>
            <ApiMember(DataType:="date", Description:="Max 24 Hours (UTC Format)", IsRequired:=true, Name:="ToDate", ParameterType:="query")>
            Public Overridable Property ToDate As Date

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

        Public Partial Class ClubVisitHistoryResponse
            Inherits ClubVisitHistoryResponseDto
            Public Sub New()
                Visits = New List(Of ClubVisitHistoryItem)
            End Sub

            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
            Public Overridable Property TotalVisits As Integer
            Public Overridable Property Visits As List(Of ClubVisitHistoryItem)
        End Class
    End Namespace
End Namespace

VB.NET ClubVisitHistoryRequest 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 /club/visit-history HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<ClubVisitHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.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>
  <TotalVisits xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalVisits>
  <Visits xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Clubs.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:ClubVisitHistoryItem>
      <d2p1:CheckinLocationName>String</d2p1:CheckinLocationName>
      <d2p1:CheckinLogId>0</d2p1:CheckinLogId>
      <d2p1:CheckinStoreId>0</d2p1:CheckinStoreId>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:HomeStoreId>0</d2p1:HomeStoreId>
      <d2p1:HomeStoreLocationName>String</d2p1:HomeStoreLocationName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:UtcTime>0001-01-01T00:00:00</d2p1:UtcTime>
    </d2p1:ClubVisitHistoryItem>
  </Visits>
</ClubVisitHistoryResponse>