| 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. |
|---|
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
// @ApiResponse(Description="", ResponseType="typeof(ClubReady.Web.Api.Sales.Agreement.AddNewUserResponse)", StatusCode=200)
export 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 XForwardedFor: string;
/**
* Api Authentication Key
*/
// @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
public ApiKey: string;
/**
* Member Id of the user buying the Package
*/
// @ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
public MemberId: number;
/**
* Id of the store for the user
*/
// @ApiMember(Description="Id of the store for the user", IsRequired=true)
public StoreId: number;
public ChainId?: number;
/**
* Package Id number of the package being purchased
*/
// @ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
public PackageId: number;
/**
* 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 InstallmentId?: number;
/**
* Date contract takes affect
*/
// @ApiMember(Description="Date contract takes affect")
public StartDate?: string;
/**
* Promo code to apply a discount.
*/
// @ApiMember(Description="Promo code to apply a discount.")
public PromoCode?: string;
/**
* Staff Id of salesperson who sold the agreement.
*/
// @ApiMember(Description="Staff Id of salesperson who sold the agreement.")
public StaffId?: number;
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
/**
* First Name
*/
// @ApiMember(Description="First Name", IsRequired=true)
public FirstName: string;
/**
* Last Name
*/
// @ApiMember(Description="Last Name", IsRequired=true)
public LastName: string;
/**
* Email Address
*/
// @ApiMember(Description="Email Address", IsRequired=true)
public Email: string;
/**
* Gender
*/
// @ApiMember(Description="Gender")
public Gender?: string;
/**
* Address
*/
// @ApiMember(Description="Address")
public Address?: string;
/**
* City
*/
// @ApiMember(Description="City")
public City?: string;
/**
* State
*/
// @ApiMember(Description="State")
public State?: string;
/**
* Zip Code
*/
// @ApiMember(Description="Zip Code")
public Zip?: string;
/**
* Home phone
*/
// @ApiMember(Description="Home phone")
public Phone?: string;
/**
* Work phone
*/
// @ApiMember(Description="Work phone")
public WorkPhone?: string;
/**
* Date of Birth
*/
// @ApiMember(Description="Date of Birth")
public DateOfBirth?: string;
/**
* Cell phone
*/
// @ApiMember(Description="Cell phone")
public CellPhone?: string;
/**
* Add an internal note for the new prospect
*/
// @ApiMember(Description="Add an internal note for the new prospect")
public Note?: string;
/**
* 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 ExternalId?: string;
/**
* Username should be between 4 and 255 characters long
*/
// @ApiMember(Description="Username should be between 4 and 255 characters long")
public Username?: string;
/**
* ReferralTypeId
*/
// @ApiMember(Description="ReferralTypeId")
public ReferralTypeId?: number;
/**
* Emergency contact name
*/
// @ApiMember(Description="Emergency contact name")
public EmergencyContactName?: string;
/**
* Emergency contact phone number
*/
// @ApiMember(Description="Emergency contact phone number")
public EmergencyContactPhone?: string;
/**
* Emergency contact relationship
*/
// @ApiMember(Description="Emergency contact relationship")
public EmergencyContactType?: string;
public constructor(init?: Partial<AddNewUserEndpoint>) { (Object as any).assign(this, init); }
}
export class ApiResponse2Base
{
public success: boolean;
public message?: string;
public constructor(init?: Partial<ApiResponse2Base>) { (Object as any).assign(this, init); }
}
export class AddNewUserResponse extends ApiResponse2Base
{
public incompleteAgreementToken?: string;
public memberId?: number;
public contractId?: number;
public constructor(init?: Partial<AddNewUserResponse>) { super(init); (Object as any).assign(this, init); }
}
TypeScript AddNewUserEndpoint 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 /sales/agreement/addNewUser HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
XForwardedFor: String,
ApiKey: String,
MemberId: 0,
StoreId: 0,
ChainId: 0,
PackageId: 0,
InstallmentId: 0,
StartDate: 0001-01-01,
PromoCode: String,
StaffId: 0,
RestrictedId: 0,
RestrictedResourceType: Store,
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,
Note: String,
ExternalId: String,
Username: String,
ReferralTypeId: 0,
EmergencyContactName: String,
EmergencyContactPhone: String,
EmergencyContactType: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
incompleteAgreementToken: String,
memberId: 0,
contractId: 0,
success: False,
message: String
}