ClubReady Api

<back to all web services

ActivateGuestPassRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ActivateGuestPassRequest extends ActivateGuestPassRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * Store ID
        */
        @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * Guest pass to activate.
        */
        @ApiMember(DataType="integer", Description="Guest pass to activate.", IsRequired=true, Name="GuestPassId", ParameterType="query")
        public Integer GuestPassId = null;

        /**
        * When will this pass expire? (leave blank for never)
        */
        @ApiMember(DataType="datetime", Description="When will this pass expire? (leave blank for never)", Name="Expires", ParameterType="query")
        public Date Expires = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public ActivateGuestPassRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ActivateGuestPassRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getGuestPassId() { return GuestPassId; }
        public ActivateGuestPassRequest setGuestPassId(Integer value) { this.GuestPassId = value; return this; }
        public Date getExpires() { return Expires; }
        public ActivateGuestPassRequest setExpires(Date value) { this.Expires = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public ActivateGuestPassRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public ActivateGuestPassRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class ActivateGuestPassRequestDto extends ApiDtoBase
    {
        public Integer GuestPassId = null;
        public Date Expires = null;
        
        public Integer getGuestPassId() { return GuestPassId; }
        public ActivateGuestPassRequestDto setGuestPassId(Integer value) { this.GuestPassId = value; return this; }
        public Date getExpires() { return Expires; }
        public ActivateGuestPassRequestDto setExpires(Date value) { this.Expires = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class ActivateGuestPassResponse extends ActivateGuestPassResponseDto
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ActivateGuestPassResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ActivateGuestPassResponse setMessage(String value) { this.Message = value; return this; }
    }

    public static class ActivateGuestPassResponseDto extends ApiResponseBase
    {
        
    }

    public static class ApiResponseBase
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
    }

}

Java ActivateGuestPassRequest DTOs

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

<ActivateGuestPassRequest 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>
  <Expires xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</Expires>
  <GuestPassId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</GuestPassId>
</ActivateGuestPassRequest>

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

<ActivateGuestPassResponse 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>
</ActivateGuestPassResponse>