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.

import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="", ResponseType=AddResponse.class, StatusCode=200)
open class AgreementAddEndpoint : IAddEndpoint, IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * Api Authentication Key
    */
    @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    var ApiKey:String? = null

    /**
    * Member Id of the user buying the Package
    */
    @ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
    var MemberId:Int? = null

    var ChainId:Int? = null
    /**
    * Id of the store for the user
    */
    @ApiMember(Description="Id of the store for the user", IsRequired=true)
    var StoreId:Int? = null

    /**
    * Package Id number of the package being purchased
    */
    @ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
    var PackageId:Int? = 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.")
    var InstallmentId:Int? = null

    /**
    * Date contract takes affect
    */
    @ApiMember(Description="Date contract takes affect")
    var StartDate:Date? = null

    /**
    * Promo code to apply a discount.
    */
    @ApiMember(Description="Promo code to apply a discount.")
    var PromoCode:String? = null

    /**
    * Staff Id of salesperson who sold the agreement.
    */
    @ApiMember(Description="Staff Id of salesperson who sold the agreement.")
    var StaffId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class AddResponse : ApiResponse2Base()
{
    var incompleteAgreementToken:String? = null
    var contractId:Int? = null
}

open class ApiResponse2Base
{
    var success:Boolean? = null
    var message:String? = null
}

Kotlin AgreementAddEndpoint DTOs

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>