| POST | /club/guest-pass/create | Create a guest pass for a user. |
|---|
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 ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type CreateGuestPassRequestDto() =
inherit ApiDtoBase()
member val UserId:Int32 = new Int32() with get,set
member val GuestPassTypeId:Int32 = new Int32() with get,set
member val Activated:Boolean = new Boolean() with get,set
member val Expires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type CreateGuestPassRequest() =
inherit CreateGuestPassRequestDto()
///<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>
///User ID
///</summary>
[<ApiMember(DataType="string", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")>]
member val UserId:Int32 = new Int32() 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>
///Guest pass type to create.
///</summary>
[<ApiMember(DataType="integer", Description="Guest pass type to create.", IsRequired=true, Name="GuestPassTypeId", ParameterType="query")>]
member val GuestPassTypeId:Int32 = new Int32() with get,set
///<summary>
///Activate this Guest Pass immediately? (True or False)
///</summary>
[<ApiMember(DataType="bool", Description="Activate this Guest Pass immediately? (True or False)", IsRequired=true, Name="Activated", ParameterType="query")>]
member val Activated:Boolean = new Boolean() with get,set
///<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")>]
member val Expires:Nullable<DateTime> = new Nullable<DateTime>() 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 CreateGuestPassResponseDto() =
inherit ApiResponseBase()
member val GuestPassId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CreateGuestPassResponse() =
inherit CreateGuestPassResponseDto()
member val Success:Boolean = new Boolean() with get,set
member val GuestPassId:Int32 = new Int32() with get,set
member val Message:String = null with get,set
F# CreateGuestPassRequest DTOs
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.
POST /club/guest-pass/create HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
UserId: 0,
StoreId: 0,
GuestPassTypeId: 0,
Activated: False,
Expires: 0001-01-01,
RestrictedId: 0,
RestrictedResourceType: Store,
ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
GuestPassId: 0,
Message: String
}