ClubReady Api

ContractTextEndpoint

The following routes are available for this service:
GET	/sales/agreement/contract	Get a contracts HTML verbiage	Get the agreements contract in HTML. Uses the Incomplete Agreements Token to identify the contract verbiage, and converts it into HTML, and returns it to the requestor. The header `X-Forwarded-For` is NOT required. It can be set to the IP address of the end user, or left blank.

**ContractTextEndpoint** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Authentication Key
StoreId	query	int	Yes	ID# of the store to get contract for.
ChainId	query	int?	No
IncompleteAgreementToken	query	string	Yes	Token for Incomplete Agreement to get details for
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**ContractTextResponse** Parameters:
Name	Parameter	Data Type	Required	Description
contractHtml	form	string	No
incompleteAgreementToken	form	string	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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sales/agreement/contract HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	contractHtml: String,
	incompleteAgreementToken: String,
	success: False,
	message: String
}