ClubReady Api

TagUserRequest

The following routes are available for this service:
POST	/users/{UserId}/tags/create	Add a tag to a user account.

namespace ClubReady.Core.Api.Models

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

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type TagUserRequestDto() = 
        inherit ApiDtoBase()
        member val UserId:Int32 = new Int32() with get,set
        member val Tag:String = null with get,set

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

    [<AllowNullLiteral>]
    type TagUserRequest() = 
        inherit TagUserRequestDto()
        ///<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>
        ///ClubReady Club ID (StoreID internally)
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

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

        ///<summary>
        ///Tag (Up to 100 characters)
        ///</summary>
        [<ApiMember(DataType="string", Description="Tag (Up to 100 characters)", IsRequired=true, Name="Tag", ParameterType="query")>]
        member val Tag: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 ApiResponseBase() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type TagUserResponseDto() = 
        inherit ApiResponseBase()

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

F# TagUserRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /users/{UserId}/tags/create HTTP/1.1 
Host: clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","StoreId":0,"UserId":0,"Tag":"String","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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