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 Foundation
import ServiceStack

public 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")
    public var apiKey:String

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

    /**
    * 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 var userId:Int

    /**
    * 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 var subject:String

    /**
    * 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 var text:String

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case storeId
        case userId
        case subject
        case text
        case restrictedId
        case restrictedResourceType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        subject = try container.decodeIfPresent(String.self, forKey: .subject)
        text = try container.decodeIfPresent(String.self, forKey: .text)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if subject != nil { try container.encode(subject, forKey: .subject) }
        if text != nil { try container.encode(text, forKey: .text) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class CreateZipWhipMessageRequestDto : ApiDtoBase
{
    public var userId:Int
    public var subject:String
    public var text:String
    public var postedBy:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userId
        case subject
        case text
        case postedBy
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        subject = try container.decodeIfPresent(String.self, forKey: .subject)
        text = try container.decodeIfPresent(String.self, forKey: .text)
        postedBy = try container.decodeIfPresent(Int.self, forKey: .postedBy)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if subject != nil { try container.encode(subject, forKey: .subject) }
        if text != nil { try container.encode(text, forKey: .text) }
        if postedBy != nil { try container.encode(postedBy, forKey: .postedBy) }
    }
}

public class ApiDtoBase : Codable
{
    public var apiKey:String
    public var storeId:Int?
    public var chainId:Int?

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class CreateZipWhipMessageResponse : CreateZipWhipMessageResponseDto
{
    public var success:Bool
    public var message:String
    public var noteId:Int
    public var contactLogId:Int
    public var taskId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case success
        case message
        case noteId
        case contactLogId
        case taskId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        success = try container.decodeIfPresent(Bool.self, forKey: .success)
        message = try container.decodeIfPresent(String.self, forKey: .message)
        noteId = try container.decodeIfPresent(Int.self, forKey: .noteId)
        contactLogId = try container.decodeIfPresent(Int.self, forKey: .contactLogId)
        taskId = try container.decodeIfPresent(Int.self, forKey: .taskId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if success != nil { try container.encode(success, forKey: .success) }
        if message != nil { try container.encode(message, forKey: .message) }
        if noteId != nil { try container.encode(noteId, forKey: .noteId) }
        if contactLogId != nil { try container.encode(contactLogId, forKey: .contactLogId) }
        if taskId != nil { try container.encode(taskId, forKey: .taskId) }
    }
}

public class CreateZipWhipMessageResponseDto : ApiResponseBase
{
    public var noteId:Int
    public var contactLogId:Int
    public var taskId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case noteId
        case contactLogId
        case taskId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        noteId = try container.decodeIfPresent(Int.self, forKey: .noteId)
        contactLogId = try container.decodeIfPresent(Int.self, forKey: .contactLogId)
        taskId = try container.decodeIfPresent(Int.self, forKey: .taskId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if noteId != nil { try container.encode(noteId, forKey: .noteId) }
        if contactLogId != nil { try container.encode(contactLogId, forKey: .contactLogId) }
        if taskId != nil { try container.encode(taskId, forKey: .taskId) }
    }
}

public class ApiResponseBase : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

Swift 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>