| POST | /sales/agreement/addNewUser | Set up a package that will be sold to an existing user | Set up a package that will be sold to an existing user. The header `X-Forwarded-For` is required and should be set to the IP address of the end user. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="", ResponseType=AddNewUserResponse.class, StatusCode=200)
open class AddNewUserEndpoint : IAddNewUserEndpoint, IRestrictedApiRequest
{
/**
* IP address of the end user
*/
@ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
var XForwardedFor:String? = null
/**
* Api Authentication Key
*/
@ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
var ApiKey:String? = null
/**
* Member Id of the user buying the Package
*/
@ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
var MemberId:Int? = null
/**
* Id of the store for the user
*/
@ApiMember(Description="Id of the store for the user", IsRequired=true)
var StoreId:Int? = null
var ChainId:Int? = null
/**
* Package Id number of the package being purchased
*/
@ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
var PackageId:Int? = null
/**
* Installment Plan Id being purchased. If empty, the default package will be selected.
*/
@ApiMember(Description="Installment Plan Id being purchased. If empty, the default package will be selected.")
var InstallmentId:Int? = null
/**
* Date contract takes affect
*/
@ApiMember(Description="Date contract takes affect")
var StartDate:Date? = null
/**
* Promo code to apply a discount.
*/
@ApiMember(Description="Promo code to apply a discount.")
var PromoCode:String? = null
/**
* Staff Id of salesperson who sold the agreement.
*/
@ApiMember(Description="Staff Id of salesperson who sold the agreement.")
var StaffId:Int? = null
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
/**
* First Name
*/
@ApiMember(Description="First Name", IsRequired=true)
var FirstName:String? = null
/**
* Last Name
*/
@ApiMember(Description="Last Name", IsRequired=true)
var LastName:String? = null
/**
* Email Address
*/
@ApiMember(Description="Email Address", IsRequired=true)
var Email:String? = null
/**
* Gender
*/
@ApiMember(Description="Gender")
var Gender:String? = null
/**
* Address
*/
@ApiMember(Description="Address")
var Address:String? = null
/**
* City
*/
@ApiMember(Description="City")
var City:String? = null
/**
* State
*/
@ApiMember(Description="State")
var State:String? = null
/**
* Zip Code
*/
@ApiMember(Description="Zip Code")
var Zip:String? = null
/**
* Home phone
*/
@ApiMember(Description="Home phone")
var Phone:String? = null
/**
* Work phone
*/
@ApiMember(Description="Work phone")
var WorkPhone:String? = null
/**
* Date of Birth
*/
@ApiMember(Description="Date of Birth")
var DateOfBirth:Date? = null
/**
* Cell phone
*/
@ApiMember(Description="Cell phone")
var CellPhone:String? = null
/**
* Add an internal note for the new prospect
*/
@ApiMember(Description="Add an internal note for the new prospect")
var Note:String? = null
/**
* Unique Id for the user from your system. We store internally as ExternalUserId
*/
@ApiMember(Description="Unique Id for the user from your system. We store internally as ExternalUserId")
var ExternalId:String? = null
/**
* Username should be between 4 and 255 characters long
*/
@ApiMember(Description="Username should be between 4 and 255 characters long")
var Username:String? = null
/**
* ReferralTypeId
*/
@ApiMember(Description="ReferralTypeId")
var ReferralTypeId:Int? = null
/**
* Emergency contact name
*/
@ApiMember(Description="Emergency contact name")
var EmergencyContactName:String? = null
/**
* Emergency contact phone number
*/
@ApiMember(Description="Emergency contact phone number")
var EmergencyContactPhone:String? = null
/**
* Emergency contact relationship
*/
@ApiMember(Description="Emergency contact relationship")
var EmergencyContactType:String? = null
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
open class AddNewUserResponse : ApiResponse2Base()
{
var incompleteAgreementToken:String? = null
var memberId:Int? = null
var contractId:Int? = null
}
open class ApiResponse2Base
{
var success:Boolean? = null
var message:String? = null
}
Kotlin AddNewUserEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/agreement/addNewUser HTTP/1.1
Host: www.clubready.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddNewUserEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Agreement">
<Address>String</Address>
<ApiKey>String</ApiKey>
<CellPhone>String</CellPhone>
<ChainId>0</ChainId>
<City>String</City>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Email>String</Email>
<EmergencyContactName>String</EmergencyContactName>
<EmergencyContactPhone>String</EmergencyContactPhone>
<EmergencyContactType>String</EmergencyContactType>
<ExternalId>String</ExternalId>
<FirstName>String</FirstName>
<Gender>String</Gender>
<InstallmentId>0</InstallmentId>
<LastName>String</LastName>
<MemberId>0</MemberId>
<Note>String</Note>
<PackageId>0</PackageId>
<Phone>String</Phone>
<PromoCode>String</PromoCode>
<ReferralTypeId>0</ReferralTypeId>
<StaffId>0</StaffId>
<StartDate>0001-01-01T00:00:00</StartDate>
<State>String</State>
<StoreId>0</StoreId>
<Username>String</Username>
<WorkPhone>String</WorkPhone>
<XForwardedFor>String</XForwardedFor>
<Zip>String</Zip>
</AddNewUserEndpoint>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AddNewUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Agreement"> <message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api">String</message> <success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api">false</success> <contractId>0</contractId> <incompleteAgreementToken>String</incompleteAgreementToken> <memberId>0</memberId> </AddNewUserResponse>