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.
namespace ClubReady.Web.Api

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type AddUserWaiverRequest() = 
        ///<summary>
        ///Api Key - Grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Store ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")>]
        member val StoreId:Int32 = new Int32() with get,set

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///Form ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Form ID", Name="FormId", ParameterType="query")>]
        member val FormId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Base64 encoded PDF string
        ///</summary>
        [<ApiMember(DataType="string", Description="Base64 encoded PDF string", IsRequired=true, Name="WaiverPdf", ParameterType="form")>]
        member val WaiverPdf:String = null with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type AddUserWaiverResponse() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

F# AddUserWaiverRequest DTOs

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.

POST /users/{UserId}/add-waiver HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	UserId: 0,
	FormId: 0,
	WaiverPdf: String,
	RestrictedId: 0,
	RestrictedResourceType: Store
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String
}