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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class AddUserWaiverRequest
            Implements IRestrictedApiRequest
            '''<Summary>
            '''Api Key - Grants access to resources
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Api Key - Grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Store ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Store ID", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Integer

            '''<Summary>
            '''ClubReady User ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady User ID", IsRequired:=true, Name:="UserId", ParameterType:="path")>
            Public Overridable Property UserId As Integer

            '''<Summary>
            '''Form ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Form ID", Name:="FormId", ParameterType:="query")>
            Public Overridable Property FormId As Nullable(Of Integer)

            '''<Summary>
            '''Base64 encoded PDF string
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Base64 encoded PDF string", IsRequired:=true, Name:="WaiverPdf", ParameterType:="form")>
            Public Overridable Property WaiverPdf As String

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class

        Public Partial Class AddUserWaiverResponse
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET AddUserWaiverRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Success":false,"Message":"String"}