ClubReady Api

CreateUserNotesRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateUserNotesRequest : CreateUserNotesRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * ClubReady Club ID (StoreID internally)
    */
    @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * Notes are being posted by this ClubReady User ID.
    */
    @ApiMember(DataType="integer", Description="Notes are being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")
    var PostedBy:Int? = null

    /**
    * Create notes
    */
    @ApiMember(Description="Create notes", IsRequired=true, Name="UserNotes")
    var UserNotes:ArrayList<SubmittedNote> = ArrayList<SubmittedNote>()

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class CreateUserNotesRequestDto : ApiDtoBase()
{
    var PostedBy:Int? = null
    var UserNotes:ArrayList<SubmittedNote> = ArrayList<SubmittedNote>()
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

open class SubmittedNote
{
    var UserId:Int? = null
    var Subject:String? = null
    var Text:String? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class CreateUserNotesResponse : CreateUserNotesResponseDto()
{
    var NoteIds:ArrayList<Long> = ArrayList<Long>()
}

open class CreateUserNotesResponseDto : ApiResponseBase()
{
    var NoteIds:ArrayList<Long> = ArrayList<Long>()
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

Kotlin 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.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">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>
</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>