| 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.*;
public class dtos
{
@ApiResponse(Description="", ResponseType=AddNewUserResponse.class, StatusCode=200)
public static class AddNewUserEndpoint implements IAddNewUserEndpoint, IRestrictedApiRequest
{
/**
* IP address of the end user
*/
@ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
public String XForwardedFor = null;
/**
* Api Authentication Key
*/
@ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
public String ApiKey = null;
/**
* Member Id of the user buying the Package
*/
@ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
public Integer MemberId = null;
/**
* Id of the store for the user
*/
@ApiMember(Description="Id of the store for the user", IsRequired=true)
public Integer StoreId = null;
public Integer ChainId = null;
/**
* Package Id number of the package being purchased
*/
@ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
public Integer PackageId = 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.")
public Integer InstallmentId = null;
/**
* Date contract takes affect
*/
@ApiMember(Description="Date contract takes affect")
public Date StartDate = null;
/**
* Promo code to apply a discount.
*/
@ApiMember(Description="Promo code to apply a discount.")
public String PromoCode = null;
/**
* Staff Id of salesperson who sold the agreement.
*/
@ApiMember(Description="Staff Id of salesperson who sold the agreement.")
public Integer StaffId = null;
public Integer RestrictedId = null;
public RestrictedResourceType RestrictedResourceType = null;
/**
* First Name
*/
@ApiMember(Description="First Name", IsRequired=true)
public String FirstName = null;
/**
* Last Name
*/
@ApiMember(Description="Last Name", IsRequired=true)
public String LastName = null;
/**
* Email Address
*/
@ApiMember(Description="Email Address", IsRequired=true)
public String Email = null;
/**
* Gender
*/
@ApiMember(Description="Gender")
public String Gender = null;
/**
* Address
*/
@ApiMember(Description="Address")
public String Address = null;
/**
* City
*/
@ApiMember(Description="City")
public String City = null;
/**
* State
*/
@ApiMember(Description="State")
public String State = null;
/**
* Zip Code
*/
@ApiMember(Description="Zip Code")
public String Zip = null;
/**
* Home phone
*/
@ApiMember(Description="Home phone")
public String Phone = null;
/**
* Work phone
*/
@ApiMember(Description="Work phone")
public String WorkPhone = null;
/**
* Date of Birth
*/
@ApiMember(Description="Date of Birth")
public Date DateOfBirth = null;
/**
* Cell phone
*/
@ApiMember(Description="Cell phone")
public String CellPhone = null;
/**
* Add an internal note for the new prospect
*/
@ApiMember(Description="Add an internal note for the new prospect")
public String Note = 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")
public String ExternalId = null;
/**
* Username should be between 4 and 255 characters long
*/
@ApiMember(Description="Username should be between 4 and 255 characters long")
public String Username = null;
/**
* ReferralTypeId
*/
@ApiMember(Description="ReferralTypeId")
public Integer ReferralTypeId = null;
/**
* Emergency contact name
*/
@ApiMember(Description="Emergency contact name")
public String EmergencyContactName = null;
/**
* Emergency contact phone number
*/
@ApiMember(Description="Emergency contact phone number")
public String EmergencyContactPhone = null;
/**
* Emergency contact relationship
*/
@ApiMember(Description="Emergency contact relationship")
public String EmergencyContactType = null;
public String getXForwardedFor() { return XForwardedFor; }
public AddNewUserEndpoint setXForwardedFor(String value) { this.XForwardedFor = value; return this; }
public String getApiKey() { return ApiKey; }
public AddNewUserEndpoint setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getMemberId() { return MemberId; }
public AddNewUserEndpoint setMemberId(Integer value) { this.MemberId = value; return this; }
public Integer getStoreId() { return StoreId; }
public AddNewUserEndpoint setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public AddNewUserEndpoint setChainId(Integer value) { this.ChainId = value; return this; }
public Integer getPackageId() { return PackageId; }
public AddNewUserEndpoint setPackageId(Integer value) { this.PackageId = value; return this; }
public Integer getInstallmentId() { return InstallmentId; }
public AddNewUserEndpoint setInstallmentId(Integer value) { this.InstallmentId = value; return this; }
public Date getStartDate() { return StartDate; }
public AddNewUserEndpoint setStartDate(Date value) { this.StartDate = value; return this; }
public String getPromoCode() { return PromoCode; }
public AddNewUserEndpoint setPromoCode(String value) { this.PromoCode = value; return this; }
public Integer getStaffId() { return StaffId; }
public AddNewUserEndpoint setStaffId(Integer value) { this.StaffId = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public AddNewUserEndpoint setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public AddNewUserEndpoint setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
public String getFirstName() { return FirstName; }
public AddNewUserEndpoint setFirstName(String value) { this.FirstName = value; return this; }
public String getLastName() { return LastName; }
public AddNewUserEndpoint setLastName(String value) { this.LastName = value; return this; }
public String getEmail() { return Email; }
public AddNewUserEndpoint setEmail(String value) { this.Email = value; return this; }
public String getGender() { return Gender; }
public AddNewUserEndpoint setGender(String value) { this.Gender = value; return this; }
public String getAddress() { return Address; }
public AddNewUserEndpoint setAddress(String value) { this.Address = value; return this; }
public String getCity() { return City; }
public AddNewUserEndpoint setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public AddNewUserEndpoint setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public AddNewUserEndpoint setZip(String value) { this.Zip = value; return this; }
public String getPhone() { return Phone; }
public AddNewUserEndpoint setPhone(String value) { this.Phone = value; return this; }
public String getWorkPhone() { return WorkPhone; }
public AddNewUserEndpoint setWorkPhone(String value) { this.WorkPhone = value; return this; }
public Date getDateOfBirth() { return DateOfBirth; }
public AddNewUserEndpoint setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
public String getCellPhone() { return CellPhone; }
public AddNewUserEndpoint setCellPhone(String value) { this.CellPhone = value; return this; }
public String getNote() { return Note; }
public AddNewUserEndpoint setNote(String value) { this.Note = value; return this; }
public String getExternalId() { return ExternalId; }
public AddNewUserEndpoint setExternalId(String value) { this.ExternalId = value; return this; }
public String getUsername() { return Username; }
public AddNewUserEndpoint setUsername(String value) { this.Username = value; return this; }
public Integer getReferralTypeId() { return ReferralTypeId; }
public AddNewUserEndpoint setReferralTypeId(Integer value) { this.ReferralTypeId = value; return this; }
public String getEmergencyContactName() { return EmergencyContactName; }
public AddNewUserEndpoint setEmergencyContactName(String value) { this.EmergencyContactName = value; return this; }
public String getEmergencyContactPhone() { return EmergencyContactPhone; }
public AddNewUserEndpoint setEmergencyContactPhone(String value) { this.EmergencyContactPhone = value; return this; }
public String getEmergencyContactType() { return EmergencyContactType; }
public AddNewUserEndpoint setEmergencyContactType(String value) { this.EmergencyContactType = value; return this; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
public static class AddNewUserResponse extends ApiResponse2Base
{
public String incompleteAgreementToken = null;
public Integer memberId = null;
public Integer contractId = null;
public String getIncompleteAgreementToken() { return incompleteAgreementToken; }
public AddNewUserResponse setIncompleteAgreementToken(String value) { this.incompleteAgreementToken = value; return this; }
public Integer getMemberId() { return memberId; }
public AddNewUserResponse setMemberId(Integer value) { this.memberId = value; return this; }
public Integer getContractId() { return contractId; }
public AddNewUserResponse setContractId(Integer value) { this.contractId = value; return this; }
}
public static class ApiResponse2Base
{
public Boolean success = null;
public String message = null;
public Boolean isSuccess() { return success; }
public ApiResponse2Base setSuccess(Boolean value) { this.success = value; return this; }
public String getMessage() { return message; }
public ApiResponse2Base setMessage(String value) { this.message = value; return this; }
}
}
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>