ClubReady Api

GetGuestPassesRequest

The following routes are available for this service:
GET	/club/guest-pass/get	Get a user's guest pass(es).

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

        Public Partial Class GetGuestPassRequestDto
            Inherits ApiDtoBase
            Public Overridable Property UserId As Integer
        End Class

        Public Partial Class GetGuestPassResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                GuestPasses = New List(Of GuestPassSimple)
            End Sub

            Public Overridable Property GuestPasses As List(Of GuestPassSimple)
        End Class

        Public Partial Class GuestPassSimple
            Public Overridable Property GuestPassId As Integer
            Public Overridable Property GuestPassTypeId As Integer
            Public Overridable Property StoreId As Integer
            Public Overridable Property ActivatedOn As Nullable(Of Date)
            Public Overridable Property Expires As Nullable(Of 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 GetGuestPassesRequest
            Inherits GetGuestPassRequestDto
            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>
            '''Store ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Store ID", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''User ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="User ID", IsRequired:=true, Name:="UserId", ParameterType:="query")>
            Public Overridable Property UserId As Integer

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

        Public Partial Class GetGuestPassesResponse
            Inherits GetGuestPassResponseDto
            Public Sub New()
                GuestPasses = New List(Of GuestPassSimple)
            End Sub

            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
            Public Overridable Property GuestPasses As List(Of GuestPassSimple)
        End Class
    End Namespace
End Namespace

VB.NET GetGuestPassesRequest 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.

GET /club/guest-pass/get HTTP/1.1 
Host: www.clubready.com 
Accept: application/json

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

{"Success":false,"Message":"String","GuestPasses":[{"GuestPassId":0,"GuestPassTypeId":0,"StoreId":0,"ActivatedOn":"0001-01-01T00:00:00.0000000","Expires":"0001-01-01T00:00:00.0000000"}]}