| POST | /v2/{ApiKey}/club/{StoreId}/prospect | (obsolete) Create a Prospect |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CreateProspectRequestV2 : CreateProspectRequestV2Dto(), IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
@ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
var ApiKey:String? = null
/**
* ClubReady Club ID (StoreID internally)
*/
@ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
var StoreId:Int? = null
/**
* First Name
*/
@ApiMember(DataType="string", Description="First Name", IsRequired=true, Name="FirstName", ParameterType="query")
var FirstName:String? = null
/**
* Last Name
*/
@ApiMember(DataType="string", Description="Last Name", IsRequired=true, Name="LastName", ParameterType="query")
var LastName:String? = null
/**
* Email Address
*/
@ApiMember(DataType="string", Description="Email Address", IsRequired=true, Name="Email", ParameterType="query")
var Email:String? = null
/**
* Gender
*/
@ApiMember(DataType="string", Description="Gender", Name="Gender", ParameterType="query")
var Gender:String? = null
/**
* Address
*/
@ApiMember(DataType="string", Description="Address", Name="Address", ParameterType="query")
var Address:String? = null
/**
* City
*/
@ApiMember(DataType="string", Description="City", Name="City", ParameterType="query")
var City:String? = null
@ApiMember(DataType="string", Name="State", ParameterType="query")
var State:String? = null
@ApiMember(DataType="string", Name="Zip", ParameterType="query")
var Zip:String? = null
var Phone:String? = null
var WorkPhone:String? = null
var DateOfBirth:Date? = null
var CellPhone:String? = null
/**
* Specify a Package to apply to the new prospect
*/
@ApiMember(DataType="integer", Description="Specify a Package to apply to the new prospect", Name="AddPackageId", ParameterType="query")
var AddPackageId:Int? = null
/**
* Specify a specific Prospect Type for the new prospect
*/
@ApiMember(DataType="integer", Description="Specify a specific Prospect Type for the new prospect", Name="ProspectTypeId", ParameterType="query")
var ProspectTypeId:Int? = null
/**
* Specify a specific Referral Type for the new prospect
*/
@ApiMember(DataType="integer", Description="Specify a specific Referral Type for the new prospect", Name="ReferralTypeId", ParameterType="query")
var ReferralTypeId:Int? = null
/**
* Send a Welcome email to the new prospect
*/
@ApiMember(DataType="boolean", Description="Send a Welcome email to the new prospect", IsRequired=true, Name="SendEmail", ParameterType="query")
var SendEmail:Boolean? = null
/**
* Only used if SendEmail = True
*/
@ApiMember(DataType="integer", Description="Only used if SendEmail = True", Name="EmailTemplateId", ParameterType="query")
var EmailTemplateId:Int? = null
/**
*
*/
@ApiMember(DataType="string", Description="", Name="Coupon", ParameterType="query")
var Coupon:String? = null
/**
* Add an internal note for the new prospect
*/
@ApiMember(DataType="string", Description="Add an internal note for the new prospect", Name="Note", ParameterType="query")
var Note:String? = null
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
}
open class CreateProspectRequestV2Dto : ApiDtoBase()
{
var FirstName:String? = null
var LastName:String? = null
var Address:String? = null
var City:String? = null
var State:String? = null
var Zip:String? = null
var Email:String? = null
var Gender:String? = null
var AddPackageId:Int? = null
var ProspectTypeId:Int? = null
var ReferralTypeId:Int? = null
var SendEmail:Boolean? = null
var Phone:String? = null
var WorkPhone:String? = null
var DateOfBirth:Date? = null
var CellPhone:String? = null
var Coupon:String? = null
var Note:String? = null
var EmailTemplateId:Int? = null
}
open class ApiDtoBase
{
var ChainId:Int? = null
var ApiKey:String? = null
var StoreId:Int? = null
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
Kotlin CreateProspectRequestV2 DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v2/{ApiKey}/club/{StoreId}/prospect HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
StoreId: 0,
FirstName: String,
LastName: String,
Email: String,
Gender: String,
Address: String,
City: String,
State: String,
Zip: String,
Phone: String,
WorkPhone: String,
DateOfBirth: 0001-01-01,
CellPhone: String,
AddPackageId: 0,
ProspectTypeId: 0,
ReferralTypeId: 0,
SendEmail: False,
EmailTemplateId: 0,
Coupon: String,
Note: String,
RestrictedId: 0,
RestrictedResourceType: Store,
ChainId: 0
}