ClubReady Api

CreateUserNotesRequest

The following routes are available for this service:
POST	/users/notes/create	Add multiple notes.

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.Core.Api.Models
Imports ClubReady.Core.Api
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api

        Public Partial Class ApiDtoBase
            Implements IApiDtoBase
            Public Overridable Property ChainId As Nullable(Of Integer)
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class CreateUserNotesRequestDto
            Inherits ApiDtoBase
            Public Sub New()
                UserNotes = New List(Of SubmittedNote)
            End Sub

            Public Overridable Property PostedBy As Nullable(Of Integer)
            Public Overridable Property UserNotes As List(Of SubmittedNote)
        End Class

        Public Partial Class CreateUserNotesResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                NoteIds = New List(Of Long)
            End Sub

            Public Overridable Property NoteIds As List(Of Long)
        End Class

        Public Partial Class SubmittedNote
            Public Overridable Property UserId As Integer
            Public Overridable Property Subject As String
            Public Overridable Property Text As String
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class CreateUserNotesRequest
            Inherits CreateUserNotesRequestDto
            Implements IRestrictedApiRequest
            Public Sub New()
                UserNotes = New List(Of SubmittedNote)
            End Sub

            '''<Summary>
            '''IP address of the end user
            '''</Summary>
            <ApiMember(Description:="IP address of the end user", Name:="X-Forwarded-For", ParameterType:="header")>
            Public Overridable Property XForwardedFor As String

            '''<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>
            '''ClubReady Club ID (StoreID internally)
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady Club ID (StoreID internally)", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<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")>
            Public Overridable Property PostedBy As Nullable(Of Integer)

            '''<Summary>
            '''Create notes
            '''</Summary>
            <ApiMember(Description:="Create notes", IsRequired:=true, Name:="UserNotes")>
            Public Overridable Property UserNotes As List(Of SubmittedNote)

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

        Public Partial Class CreateUserNotesResponse
            Inherits CreateUserNotesResponseDto
            Public Sub New()
                NoteIds = New List(Of Long)
            End Sub

            Public Overridable Property NoteIds As List(Of Long)
        End Class
    End Namespace
End Namespace

VB.NET CreateUserNotesRequest 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/notes/create HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUserNotesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api">0</StoreId>
  <PostedBy xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</PostedBy>
  <UserNotes xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <SubmittedNote>
      <Subject>String</Subject>
      <Text>String</Text>
      <UserId>0</UserId>
    </SubmittedNote>
  </UserNotes>
  <XForwardedFor>String</XForwardedFor>
</CreateUserNotesRequest>

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

<CreateUserNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <NoteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:long>0</d2p1:long>
  </NoteIds>
</CreateUserNotesResponse>