ClubReady Api

CreateGuestPassRequest

The following routes are available for this service:
POST	/club/guest-pass/create	Create a guest pass for a user.

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 CreateGuestPassRequestDto
        : ApiDtoBase
    {
        public virtual int UserId { get; set; }
        public virtual int GuestPassTypeId { get; set; }
        public virtual bool Activated { get; set; }
        public virtual DateTime? Expires { get; set; }
    }

    public partial class CreateGuestPassResponseDto
        : ApiResponseBase
    {
        public virtual int GuestPassId { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.ClubAccess.Model
{
    public partial class CreateGuestPassRequest
        : CreateGuestPassRequestDto, 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>
        ///User ID
        ///</summary>
        [ApiMember(DataType="string", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")]
        public virtual int UserId { 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>
        ///Guest pass type to create.
        ///</summary>
        [ApiMember(DataType="integer", Description="Guest pass type to create.", IsRequired=true, Name="GuestPassTypeId", ParameterType="query")]
        public virtual int GuestPassTypeId { 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")]
        public virtual bool Activated { 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")]
        public virtual DateTime? Expires { get; set; }

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

    public partial class CreateGuestPassResponse
        : CreateGuestPassResponseDto
    {
        public virtual bool Success { get; set; }
        public virtual int GuestPassId { get; set; }
        public virtual string Message { get; set; }
    }

}

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

POST /club/guest-pass/create HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateGuestPassRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <Activated xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Activated>
  <Expires xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</Expires>
  <GuestPassTypeId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</GuestPassTypeId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</CreateGuestPassRequest>

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

<CreateGuestPassResponse 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>
  <GuestPassId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</GuestPassId>
</CreateGuestPassResponse>