ClubReady Api

AgreementAddEndpoint

The following routes are available for this service:
POST	/sales/agreement/add	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 PaymentMethods property is an array of objects describing how you want ClubReady to take payment while selling the PackageId/InstallmentPlanId. If omitted (or null), the preferred on-file profile will be used. The header `X-Forwarded-For` is required and should be set to the IP address of the end user.

**AgreementAddEndpoint** 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
ChainId	body	int?	No
StoreId	body	int?	Yes	Id of the store for the user
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

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**AddResponse** Parameters:
Name	Parameter	Data Type	Required	Description
incompleteAgreementToken	form	string	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/add HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgreementAddEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Agreement">
  <ApiKey>String</ApiKey>
  <ChainId>0</ChainId>
  <InstallmentId>0</InstallmentId>
  <MemberId>0</MemberId>
  <PackageId>0</PackageId>
  <PromoCode>String</PromoCode>
  <StaffId>0</StaffId>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <StoreId>0</StoreId>
  <XForwardedFor>String</XForwardedFor>
</AgreementAddEndpoint>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddResponse 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>
</AddResponse>