ClubReady Api

<back to all web services

DoCheckInRequest

Check a user into a club

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

public class dtos
{

    /**
    * Check a user into a club
    */
    @Api(Description="Check a user into a club")
    public static class DoCheckInRequest extends DoCheckInRequestDto 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;

        /**
        * User barcode
        */
        @ApiMember(DataType="string", Description="User barcode", IsRequired=true, Name="Barcode", ParameterType="query")
        public String Barcode = null;

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

        /**
        * UserId to check into club
        */
        @ApiMember(DataType="integer", Description="UserId to check into club", Name="UserId", ParameterType="query")
        public Integer UserId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public DoCheckInRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getBarcode() { return Barcode; }
        public DoCheckInRequest setBarcode(String value) { this.Barcode = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public DoCheckInRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public DoCheckInRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public DoCheckInRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public DoCheckInRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class DoCheckInRequestDto extends ApiDtoBase
    {
        public String Barcode = null;
        public Integer UserId = null;
        public Date UtcTimeStamp = null;
        
        public String getBarcode() { return Barcode; }
        public DoCheckInRequestDto setBarcode(String value) { this.Barcode = value; return this; }
        public Integer getUserId() { return UserId; }
        public DoCheckInRequestDto setUserId(Integer value) { this.UserId = value; return this; }
        public Date getUtcTimeStamp() { return UtcTimeStamp; }
        public DoCheckInRequestDto setUtcTimeStamp(Date value) { this.UtcTimeStamp = 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;
    }

}

Java DoCheckInRequest DTOs

POST /users/checkin HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DoCheckInRequest 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>
  <Barcode xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Barcode>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
  <UtcTimeStamp xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</UtcTimeStamp>
</DoCheckInRequest>