| POST | /users/notes/create | Add multiple notes. |
|---|
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 SubmittedNote() =
member val UserId:Int32 = new Int32() with get,set
member val Subject:String = null with get,set
member val Text:String = null with get,set
[<AllowNullLiteral>]
type CreateUserNotesRequestDto() =
inherit ApiDtoBase()
member val PostedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
member val UserNotes:ResizeArray<SubmittedNote> = new ResizeArray<SubmittedNote>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type CreateUserNotesRequest() =
inherit CreateUserNotesRequestDto()
///<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>
///Notes are being posted by this ClubReady User ID.
///</summary>
[<ApiMember(DataType="integer", Description="Notes are being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")>]
member val PostedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Create notes
///</summary>
[<ApiMember(Description="Create notes", IsRequired=true, Name="UserNotes")>]
member val UserNotes:ResizeArray<SubmittedNote> = new ResizeArray<SubmittedNote>() 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 CreateUserNotesResponseDto() =
inherit ApiResponseBase()
member val NoteIds:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set
[<AllowNullLiteral>]
type CreateUserNotesResponse() =
inherit CreateUserNotesResponseDto()
member val NoteIds:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set
F# CreateUserNotesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/notes/create HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
StoreId: 0,
PostedBy: 0,
UserNotes:
[
{
UserId: 0,
Subject: String,
Text: String
}
],
RestrictedId: 0,
RestrictedResourceType: Store,
ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
NoteIds:
[
0
],
Success: False,
Message: String
}