ClubReady Api

GetGuestPassTypesRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.ClubAccess.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;
using ClubReady.Core.ClubAccess.GuestPasses.Dtos;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class GetGuestPassTypesRequestDto
        : ApiDtoBase
    {
    }

    public partial class GetGuestPassTypesResponseDto
        : ApiResponseBase
    {
        public GetGuestPassTypesResponseDto()
        {
            GuestPassTypes = new List<GuestPassTypeDto>{};
        }

        public virtual List<GuestPassTypeDto> GuestPassTypes { get; set; }
    }

}

namespace ClubReady.Core.ClubAccess.GuestPasses.Dtos
{
    public partial class GuestPassTypeDto
    {
        public virtual int GuestPassTypeId { get; set; }
        public virtual int? ChainId { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual string PassName { get; set; }
        public virtual int DurationDays { get; set; }
        public virtual bool ExpirationEditable { get; set; }
        public virtual int MaxDurationDays { get; set; }
        public virtual bool AutoActivateWhenIssued { get; set; }
        public virtual bool IssueBarcodeWhenActivated { get; set; }
        public virtual string TagWhenActivated { get; set; }
        public virtual int MaxIssuedCount { get; set; }
        public virtual bool IsDeleted { get; set; }
        public virtual int InactiveCount { get; set; }
        public virtual int ActiveCount { get; set; }
        public virtual int ExpiredCount { get; set; }
        public virtual int TotalCount { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.ClubAccess.Model
{
    public partial class GetGuestPassTypesRequest
        : GetGuestPassTypesRequestDto, 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 virtual string ApiKey { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class GetGuestPassTypesResponse
        : GetGuestPassTypesResponseDto
    {
        public GetGuestPassTypesResponse()
        {
            GuestPassTypes = new List<GuestPassTypeDto>{};
        }

        public virtual List<GuestPassTypeDto> GuestPassTypes { get; set; }
    }

}

C# 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>