ClubReady Api

AddNewUserEndpoint

The following routes are available for this service:
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.

**AddNewUserEndpoint** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	Yes	IP address of the end user
ApiKey	query	string	Yes	Api Authentication Key
MemberId	query	int	Yes	Member Id of the user buying the Package
StoreId	body	int?	Yes	Id of the store for the user
ChainId	body	int?	No
PackageId	body	int	Yes	Package Id number of the package being purchased
InstallmentId	body	int?	No	Installment Plan Id being purchased. If empty, the default package will be selected.
StartDate	body	DateTime?	No	Date contract takes affect
PromoCode	body	string	No	Promo code to apply a discount.
StaffId	body	int?	No	Staff Id of salesperson who sold the agreement.
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No
FirstName	body	string	Yes	First Name
LastName	body	string	Yes	Last Name
Email	body	string	Yes	Email Address
Gender	body	string	No	Gender
Address	body	string	No	Address
City	body	string	No	City
State	body	string	No	State
Zip	body	string	No	Zip Code
Phone	body	string	No	Home phone
WorkPhone	body	string	No	Work phone
DateOfBirth	body	DateTime?	No	Date of Birth
CellPhone	body	string	No	Cell phone
Note	body	string	No	Add an internal note for the new prospect
ExternalId	body	string	No	Unique Id for the user from your system. We store internally as ExternalUserId
Username	body	string	No	Username should be between 4 and 255 characters long
ReferralTypeId	body	int?	No	ReferralTypeId
EmergencyContactName	body	string	No	Emergency contact name
EmergencyContactPhone	body	string	No	Emergency contact phone number
EmergencyContactType	body	string	No	Emergency contact relationship

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**AddNewUserResponse** Parameters:
Name	Parameter	Data Type	Required
incompleteAgreementToken	form	string	No
memberId	form	int?	No
contractId	form	int?	No

**ApiResponse2Base** Parameters:
Name	Parameter	Data Type	Required	Description
success	form	bool	No
message	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>