ClubReady Api

<back to all web services

GetGuestPassesRequest

The following routes are available for this service:
GET/club/guest-pass/getGet a user's guest pass(es).
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;

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 GetGuestPassRequestDto
        : ApiDtoBase
    {
        public virtual int UserId { get; set; }
    }

    public partial class GetGuestPassResponseDto
        : ApiResponseBase
    {
        public GetGuestPassResponseDto()
        {
            GuestPasses = new List<GuestPassSimple>{};
        }

        public virtual List<GuestPassSimple> GuestPasses { get; set; }
    }

    public partial class GuestPassSimple
    {
        public virtual int GuestPassId { get; set; }
        public virtual int GuestPassTypeId { get; set; }
        public virtual int StoreId { get; set; }
        public virtual DateTime? ActivatedOn { get; set; }
        public virtual DateTime? Expires { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.ClubAccess.Model
{
    public partial class GetGuestPassesRequest
        : GetGuestPassRequestDto, 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>
        ///Store ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///User ID
        ///</summary>
        [ApiMember(DataType="integer", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")]
        public virtual int UserId { get; set; }

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

    public partial class GetGuestPassesResponse
        : GetGuestPassResponseDto
    {
        public GetGuestPassesResponse()
        {
            GuestPasses = new List<GuestPassSimple>{};
        }

        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual List<GuestPassSimple> GuestPasses { get; set; }
    }

}

C# GetGuestPassesRequest DTOs

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

HTTP + 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: www.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
		}
	]
}