ClubReady Api

<back to all web services

CreateZipWhipMessageRequest

The following routes are available for this service:
POST/users/{UserId}/zipwhipmessage/createAdd a ZipWhip message to a user account.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreateZipWhipMessageRequest extends CreateZipWhipMessageRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * ClubReady Club ID (StoreID internally)
        */
        @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = 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")
        public Integer UserId = 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")
        public String Subject = 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")
        public String Text = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CreateZipWhipMessageRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CreateZipWhipMessageRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public CreateZipWhipMessageRequest setUserId(Integer value) { this.UserId = value; return this; }
        public String getSubject() { return Subject; }
        public CreateZipWhipMessageRequest setSubject(String value) { this.Subject = value; return this; }
        public String getText() { return Text; }
        public CreateZipWhipMessageRequest setText(String value) { this.Text = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CreateZipWhipMessageRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CreateZipWhipMessageRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class CreateZipWhipMessageRequestDto extends ApiDtoBase
    {
        public Integer UserId = null;
        public String Subject = null;
        public String Text = null;
        public Integer PostedBy = null;
        
        public Integer getUserId() { return UserId; }
        public CreateZipWhipMessageRequestDto setUserId(Integer value) { this.UserId = value; return this; }
        public String getSubject() { return Subject; }
        public CreateZipWhipMessageRequestDto setSubject(String value) { this.Subject = value; return this; }
        public String getText() { return Text; }
        public CreateZipWhipMessageRequestDto setText(String value) { this.Text = value; return this; }
        public Integer getPostedBy() { return PostedBy; }
        public CreateZipWhipMessageRequestDto setPostedBy(Integer value) { this.PostedBy = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class CreateZipWhipMessageResponse extends CreateZipWhipMessageResponseDto
    {
        public Boolean Success = null;
        public String Message = null;
        public Long NoteId = null;
        public Integer ContactLogId = null;
        public Integer TaskId = null;
        
        public Boolean isSuccess() { return Success; }
        public CreateZipWhipMessageResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public CreateZipWhipMessageResponse setMessage(String value) { this.Message = value; return this; }
        public Long getNoteId() { return NoteId; }
        public CreateZipWhipMessageResponse setNoteId(Long value) { this.NoteId = value; return this; }
        public Integer getContactLogId() { return ContactLogId; }
        public CreateZipWhipMessageResponse setContactLogId(Integer value) { this.ContactLogId = value; return this; }
        public Integer getTaskId() { return TaskId; }
        public CreateZipWhipMessageResponse setTaskId(Integer value) { this.TaskId = value; return this; }
    }

    public static class CreateZipWhipMessageResponseDto extends ApiResponseBase
    {
        public Long NoteId = null;
        public Integer ContactLogId = null;
        public Integer TaskId = null;
        
        public Long getNoteId() { return NoteId; }
        public CreateZipWhipMessageResponseDto setNoteId(Long value) { this.NoteId = value; return this; }
        public Integer getContactLogId() { return ContactLogId; }
        public CreateZipWhipMessageResponseDto setContactLogId(Integer value) { this.ContactLogId = value; return this; }
        public Integer getTaskId() { return TaskId; }
        public CreateZipWhipMessageResponseDto setTaskId(Integer value) { this.TaskId = value; return this; }
    }

    public static class ApiResponseBase
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
    }

}

Java CreateZipWhipMessageRequest 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}/zipwhipmessage/create HTTP/1.1 
Host: www.clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","StoreId":0,"UserId":0,"Subject":"String","Text":"String","RestrictedId":0,"RestrictedResourceType":"Store","PostedBy":0,"ChainId":0}

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

{"Success":false,"Message":"String","NoteId":0,"ContactLogId":0,"TaskId":0}