| GET | /club/guest-pass/get | Get a user's guest pass(es). |
|---|
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type GetGuestPassRequestDto() =
inherit ApiDtoBase()
member val UserId:Int32 = new Int32() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type GetGuestPassesRequest() =
inherit GetGuestPassRequestDto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///Store ID
///</summary>
[<ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///User ID
///</summary>
[<ApiMember(DataType="integer", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")>]
member val UserId:Int32 = new Int32() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
[<AllowNullLiteral>]
type ApiResponseBase() =
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type GuestPassSimple() =
member val GuestPassId:Int32 = new Int32() with get,set
member val GuestPassTypeId:Int32 = new Int32() with get,set
member val StoreId:Int32 = new Int32() with get,set
member val ActivatedOn:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Expires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type GetGuestPassResponseDto() =
inherit ApiResponseBase()
member val GuestPasses:ResizeArray<GuestPassSimple> = new ResizeArray<GuestPassSimple>() with get,set
[<AllowNullLiteral>]
type GetGuestPassesResponse() =
inherit GetGuestPassResponseDto()
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
member val GuestPasses:ResizeArray<GuestPassSimple> = new ResizeArray<GuestPassSimple>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: clubready.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Message: String,
GuestPasses:
[
{
GuestPassId: 0,
GuestPassTypeId: 0,
StoreId: 0,
ActivatedOn: 0001-01-01,
Expires: 0001-01-01
}
]
}