ClubReady Api

CreateZipWhipMessageRequest

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

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


open class CreateZipWhipMessageRequest : CreateZipWhipMessageRequestDto(), 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

    /**
    * Create note for this ClubReady User ID
    */
    @ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = null

    /**
    * Subject of the message (Up to 255 characters)
    */
    @ApiMember(DataType="string", Description="Subject of the message (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")
    var Subject:String? = null

    /**
    * Text body of the message (Up to 2000 characters)
    */
    @ApiMember(DataType="string", Description="Text body of the message (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")
    var Text:String? = null

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

open class CreateZipWhipMessageRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var Subject:String? = null
    var Text:String? = null
    var PostedBy:Int? = null
}

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

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

open class CreateZipWhipMessageResponse : CreateZipWhipMessageResponseDto()
{
    var Success:Boolean? = null
    var Message:String? = null
    var NoteId:Long? = null
    var ContactLogId:Int? = null
    var TaskId:Int? = null
}

open class CreateZipWhipMessageResponseDto : ApiResponseBase()
{
    var NoteId:Long? = null
    var ContactLogId:Int? = null
    var TaskId:Int? = null
}

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

Kotlin CreateZipWhipMessageRequest 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/{UserId}/zipwhipmessage/create HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateZipWhipMessageRequest 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>
  <Subject xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Subject>
  <Text xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Text>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</CreateZipWhipMessageRequest>

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

<CreateZipWhipMessageResponse 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>
  <ContactLogId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ContactLogId>
  <NoteId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</NoteId>
  <TaskId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TaskId>
</CreateZipWhipMessageResponse>