| POST | /v2/{ApiKey}/club/{StoreId}/prospect | (obsolete) Create a Prospect |
|---|
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type CreateProspectRequestV2Dto() =
inherit ApiDtoBase()
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Address:String = null with get,set
member val City:String = null with get,set
member val State:String = null with get,set
member val Zip:String = null with get,set
member val Email:String = null with get,set
member val Gender:String = null with get,set
member val AddPackageId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ProspectTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ReferralTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SendEmail:Boolean = new Boolean() with get,set
member val Phone:String = null with get,set
member val WorkPhone:String = null with get,set
member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CellPhone:String = null with get,set
member val Coupon:String = null with get,set
member val Note:String = null with get,set
member val EmailTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type CreateProspectRequestV2() =
inherit CreateProspectRequestV2Dto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///ClubReady Club ID (StoreID internally)
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///First Name
///</summary>
[<ApiMember(DataType="string", Description="First Name", IsRequired=true, Name="FirstName", ParameterType="query")>]
member val FirstName:String = null with get,set
///<summary>
///Last Name
///</summary>
[<ApiMember(DataType="string", Description="Last Name", IsRequired=true, Name="LastName", ParameterType="query")>]
member val LastName:String = null with get,set
///<summary>
///Email Address
///</summary>
[<ApiMember(DataType="string", Description="Email Address", IsRequired=true, Name="Email", ParameterType="query")>]
member val Email:String = null with get,set
///<summary>
///Gender
///</summary>
[<ApiMember(DataType="string", Description="Gender", Name="Gender", ParameterType="query")>]
member val Gender:String = null with get,set
///<summary>
///Address
///</summary>
[<ApiMember(DataType="string", Description="Address", Name="Address", ParameterType="query")>]
member val Address:String = null with get,set
///<summary>
///City
///</summary>
[<ApiMember(DataType="string", Description="City", Name="City", ParameterType="query")>]
member val City:String = null with get,set
[<ApiMember(DataType="string", Name="State", ParameterType="query")>]
member val State:String = null with get,set
[<ApiMember(DataType="string", Name="Zip", ParameterType="query")>]
member val Zip:String = null with get,set
member val Phone:String = null with get,set
member val WorkPhone:String = null with get,set
member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CellPhone:String = null with get,set
///<summary>
///Specify a Package to apply to the new prospect
///</summary>
[<ApiMember(DataType="integer", Description="Specify a Package to apply to the new prospect", Name="AddPackageId", ParameterType="query")>]
member val AddPackageId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specify a specific Prospect Type for the new prospect
///</summary>
[<ApiMember(DataType="integer", Description="Specify a specific Prospect Type for the new prospect", Name="ProspectTypeId", ParameterType="query")>]
member val ProspectTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specify a specific Referral Type for the new prospect
///</summary>
[<ApiMember(DataType="integer", Description="Specify a specific Referral Type for the new prospect", Name="ReferralTypeId", ParameterType="query")>]
member val ReferralTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Send a Welcome email to the new prospect
///</summary>
[<ApiMember(DataType="boolean", Description="Send a Welcome email to the new prospect", IsRequired=true, Name="SendEmail", ParameterType="query")>]
member val SendEmail:Boolean = new Boolean() with get,set
///<summary>
///Only used if SendEmail = True
///</summary>
[<ApiMember(DataType="integer", Description="Only used if SendEmail = True", Name="EmailTemplateId", ParameterType="query")>]
member val EmailTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///
///</summary>
[<ApiMember(DataType="string", Description="", Name="Coupon", ParameterType="query")>]
member val Coupon:String = null with get,set
///<summary>
///Add an internal note for the new prospect
///</summary>
[<ApiMember(DataType="string", Description="Add an internal note for the new prospect", Name="Note", ParameterType="query")>]
member val Note:String = null with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
F# 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
}