ClubReady Api

<back to all web services

AddUserWaiverRequest

The following routes are available for this service:
POST/users/{UserId}/add-waiverAdd a waiver for a user.
import Foundation
import ServiceStack

public class AddUserWaiverRequest : IRestrictedApiRequest, Codable
{
    /**
    * Api Key - Grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
    public var storeId:Int

    /**
    * ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
    public var userId:Int

    /**
    * Form ID
    */
    // @ApiMember(DataType="integer", Description="Form ID", Name="FormId", ParameterType="query")
    public var formId:Int?

    /**
    * Base64 encoded PDF string
    */
    // @ApiMember(DataType="string", Description="Base64 encoded PDF string", IsRequired=true, Name="WaiverPdf", ParameterType="form")
    public var waiverPdf:String

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class AddUserWaiverResponse : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}


Swift AddUserWaiverRequest 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 /users/{UserId}/add-waiver HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddUserWaiverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey>String</ApiKey>
  <FormId>0</FormId>
  <StoreId>0</StoreId>
  <UserId>0</UserId>
  <WaiverPdf>String</WaiverPdf>
</AddUserWaiverRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddUserWaiverResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message>String</Message>
  <Success>false</Success>
</AddUserWaiverResponse>