ClubReady Api

ActivateGuestPassRequest

The following routes are available for this service:
POST	/club/guest-pass/activate	Activate a guest pass.

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 ActivateGuestPassRequestDto
            Inherits ApiDtoBase
            Public Overridable Property GuestPassId As Integer
            Public Overridable Property Expires As Nullable(Of Date)
        End Class

        Public Partial Class ActivateGuestPassResponseDto
            Inherits ApiResponseBase
        End Class

        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
    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 ActivateGuestPassRequest
            Inherits ActivateGuestPassRequestDto
            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>
            '''Guest pass to activate.
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Guest pass to activate.", IsRequired:=true, Name:="GuestPassId", ParameterType:="query")>
            Public Overridable Property GuestPassId As Integer

            '''<Summary>
            '''When will this pass expire? (leave blank for never)
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="When will this pass expire? (leave blank for never)", Name:="Expires", ParameterType:="query")>
            Public Overridable Property Expires As Nullable(Of Date)

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

        Public Partial Class ActivateGuestPassResponse
            Inherits ActivateGuestPassResponseDto
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

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

POST /club/guest-pass/activate HTTP/1.1 
Host: clubready.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"String","StoreId":0,"GuestPassId":0,"Expires":"0001-01-01T00:00:00.0000000","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}

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

{"Success":false,"Message":"String"}