ClubReady Api

<back to all web services

GetProspectTypesRequest

The following routes are available for this service:
GET/club/lead-typesList of prospect types.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetProspectTypesRequest extends ApiDtoBase 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;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetProspectTypesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetProspectTypesRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetProspectTypesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetProspectTypesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetProspectTypesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = 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 GetProspectTypesResponse extends GetProspectTypesResponseDto
    {
        public ArrayList<ApiGenericType> LeadTypes = null;
        
        public ArrayList<ApiGenericType> getLeadTypes() { return LeadTypes; }
        public GetProspectTypesResponse setLeadTypes(ArrayList<ApiGenericType> value) { this.LeadTypes = value; return this; }
    }

    public static class GetProspectTypesResponseDto
    {
        public ArrayList<ApiGenericType> LeadTypes = null;
        
        public ArrayList<ApiGenericType> getLeadTypes() { return LeadTypes; }
        public GetProspectTypesResponseDto setLeadTypes(ArrayList<ApiGenericType> value) { this.LeadTypes = value; return this; }
    }

    public static class ApiGenericType
    {
        public Integer Id = null;
        public String Name = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public Integer getId() { return Id; }
        public ApiGenericType setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ApiGenericType setName(String value) { this.Name = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiGenericType setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiGenericType setChainId(Integer value) { this.ChainId = value; return this; }
    }

}

Java GetProspectTypesRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /club/lead-types HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"LeadTypes":[{"Id":0,"Name":"String","StoreId":0,"ChainId":0}]}