ClubReady Api

<back to all web services

CheckForPaymentProfile

The following routes are available for this service:
GET/sales/member/{MemberId}/profile/checkCheck a customer for payment profile(s)
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CheckForPaymentProfile extends CheckForPaymentProfileDto 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;

        /**
        * ID # of store member belongs to
        */
        @ApiMember(DataType="integer", Description="ID # of store member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * ID # of user to check
        */
        @ApiMember(DataType="integer", Description="ID # of user to check", IsRequired=true, Name="MemberId", ParameterType="path")
        public Integer MemberId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CheckForPaymentProfile setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CheckForPaymentProfile setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getMemberId() { return MemberId; }
        public CheckForPaymentProfile setMemberId(Integer value) { this.MemberId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CheckForPaymentProfile setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CheckForPaymentProfile setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class CheckForPaymentProfileDto extends ApiDtoBase
    {
        public Integer MemberId = null;
        
        public Integer getMemberId() { return MemberId; }
        public CheckForPaymentProfileDto setMemberId(Integer value) { this.MemberId = value; return this; }
    }

    public static class ApiDtoBase
    {
        public Integer ChainId = null;
        public String ApiKey = null;
        public Integer StoreId = null;
        
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
        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 static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java CheckForPaymentProfile 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 /sales/member/{MemberId}/profile/check HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml