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.
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 CreateZipWhipMessageRequestDto() = 
        inherit ApiDtoBase()
        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
        member val PostedBy:Nullable<Int32> = new Nullable<Int32>() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type CreateZipWhipMessageRequest() = 
        inherit CreateZipWhipMessageRequestDto()
        ///<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>
        ///Create note for this ClubReady User ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///Subject of the message (Up to 255 characters)
        ///</summary>
        [<ApiMember(DataType="string", Description="Subject of the message (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")>]
        member val Subject:String = null with get,set

        ///<summary>
        ///Text body of the message (Up to 2000 characters)
        ///</summary>
        [<ApiMember(DataType="string", Description="Text body of the message (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")>]
        member val Text:String = null 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 CreateZipWhipMessageResponseDto() = 
        inherit ApiResponseBase()
        member val NoteId:Int64 = new Int64() with get,set
        member val ContactLogId:Int32 = new Int32() with get,set
        member val TaskId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CreateZipWhipMessageResponse() = 
        inherit CreateZipWhipMessageResponseDto()
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val NoteId:Int64 = new Int64() with get,set
        member val ContactLogId:Int32 = new Int32() with get,set
        member val TaskId:Int32 = new Int32() with get,set

F# 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>