ClubReady Api

GetGuestPassTypesRequest

The following routes are available for this service:
GET	/club/guest-pass/types	Guest passes available at location.

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.ClubAccess.GuestPasses.Dtos

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 GetGuestPassTypesRequestDto
            Inherits ApiDtoBase
        End Class

        Public Partial Class GetGuestPassTypesResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                GuestPassTypes = New List(Of GuestPassTypeDto)
            End Sub

            Public Overridable Property GuestPassTypes As List(Of GuestPassTypeDto)
        End Class
    End Namespace

    Namespace ClubReady.Core.ClubAccess.GuestPasses.Dtos

        Public Partial Class GuestPassTypeDto
            Public Overridable Property GuestPassTypeId As Integer
            Public Overridable Property ChainId As Nullable(Of Integer)
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property PassName As String
            Public Overridable Property DurationDays As Integer
            Public Overridable Property ExpirationEditable As Boolean
            Public Overridable Property MaxDurationDays As Integer
            Public Overridable Property AutoActivateWhenIssued As Boolean
            Public Overridable Property IssueBarcodeWhenActivated As Boolean
            Public Overridable Property TagWhenActivated As String
            Public Overridable Property MaxIssuedCount As Integer
            Public Overridable Property IsDeleted As Boolean
            Public Overridable Property InactiveCount As Integer
            Public Overridable Property ActiveCount As Integer
            Public Overridable Property ExpiredCount As Integer
            Public Overridable Property TotalCount As Integer
        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 GetGuestPassTypesRequest
            Inherits GetGuestPassTypesRequestDto
            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)

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

        Public Partial Class GetGuestPassTypesResponse
            Inherits GetGuestPassTypesResponseDto
            Public Sub New()
                GuestPassTypes = New List(Of GuestPassTypeDto)
            End Sub

            Public Overridable Property GuestPassTypes As List(Of GuestPassTypeDto)
        End Class
    End Namespace
End Namespace

VB.NET GetGuestPassTypesRequest DTOs

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

HTTP + CSV

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

GET /club/guest-pass/types HTTP/1.1 
Host: clubready.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GuestPassTypes":[{"GuestPassTypeId":0,"ChainId":0,"StoreId":0,"PassName":"String","DurationDays":0,"ExpirationEditable":false,"MaxDurationDays":0,"AutoActivateWhenIssued":false,"IssueBarcodeWhenActivated":false,"TagWhenActivated":"String","MaxIssuedCount":0,"IsDeleted":false,"InactiveCount":0,"ActiveCount":0,"ExpiredCount":0,"TotalCount":0}],"Success":false,"Message":"String"}