ClubReady Api

<back to all web services

GetGuestPassTypesRequest

The following routes are available for this service:
GET/club/guest-pass/typesGuest passes available at location.
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 GetGuestPassTypesRequestDto() = 
        inherit ApiDtoBase()

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type GetGuestPassTypesRequest() = 
        inherit GetGuestPassTypesRequestDto()
        ///<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>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<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 GuestPassTypeDto() = 
        member val GuestPassTypeId:Int32 = new Int32() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PassName:String = null with get,set
        member val DurationDays:Int32 = new Int32() with get,set
        member val ExpirationEditable:Boolean = new Boolean() with get,set
        member val MaxDurationDays:Int32 = new Int32() with get,set
        member val AutoActivateWhenIssued:Boolean = new Boolean() with get,set
        member val IssueBarcodeWhenActivated:Boolean = new Boolean() with get,set
        member val TagWhenActivated:String = null with get,set
        member val MaxIssuedCount:Int32 = new Int32() with get,set
        member val IsDeleted:Boolean = new Boolean() with get,set
        member val InactiveCount:Int32 = new Int32() with get,set
        member val ActiveCount:Int32 = new Int32() with get,set
        member val ExpiredCount:Int32 = new Int32() with get,set
        member val TotalCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GetGuestPassTypesResponseDto() = 
        inherit ApiResponseBase()
        member val GuestPassTypes:ResizeArray<GuestPassTypeDto> = new ResizeArray<GuestPassTypeDto>() with get,set

    [<AllowNullLiteral>]
    type GetGuestPassTypesResponse() = 
        inherit GetGuestPassTypesResponseDto()
        member val GuestPassTypes:ResizeArray<GuestPassTypeDto> = new ResizeArray<GuestPassTypeDto>() with get,set

F# GetGuestPassTypesRequest DTOs

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

HTTP + XML

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: www.clubready.com 
Accept: application/xml

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

<GetGuestPassTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <GuestPassTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.ClubAccess.GuestPasses.Dtos" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:GuestPassTypeDto>
      <d2p1:ActiveCount>0</d2p1:ActiveCount>
      <d2p1:AutoActivateWhenIssued>false</d2p1:AutoActivateWhenIssued>
      <d2p1:ChainId>0</d2p1:ChainId>
      <d2p1:DurationDays>0</d2p1:DurationDays>
      <d2p1:ExpirationEditable>false</d2p1:ExpirationEditable>
      <d2p1:ExpiredCount>0</d2p1:ExpiredCount>
      <d2p1:GuestPassTypeId>0</d2p1:GuestPassTypeId>
      <d2p1:InactiveCount>0</d2p1:InactiveCount>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:IssueBarcodeWhenActivated>false</d2p1:IssueBarcodeWhenActivated>
      <d2p1:MaxDurationDays>0</d2p1:MaxDurationDays>
      <d2p1:MaxIssuedCount>0</d2p1:MaxIssuedCount>
      <d2p1:PassName>String</d2p1:PassName>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TagWhenActivated>String</d2p1:TagWhenActivated>
      <d2p1:TotalCount>0</d2p1:TotalCount>
    </d2p1:GuestPassTypeDto>
  </GuestPassTypes>
</GetGuestPassTypesResponse>