ClubManager.Api

<back to all web services

FindMessage

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Message
import Foundation
import ServiceStack

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Message")
public class FindMessage : QueryDb<MessageInstance>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class MessageInstance : Codable
{
    public var messageId:Int?
    public var dueDate:Date?
    public var sentDate:Date?
    public var processed:Bool?
    public var failures:Int?
    public var instanceId:Int?
    public var messageSid:String?
    public var messageTemplate:MessageTemplateInstance?
    // @References(typeof(MessageTemplateInstance))
    public var messageTemplateId:Int?

    public var openedDate:Date?
    public var bouncedDate:Date?
    public var deliveredDate:Date?
    public var unsubscribedDate:Date?
    public var spamReportDate:Date?
    public var user:UserInstance?
    // @References(typeof(UserInstance))
    public var userId:Int?

    public var instanceType:Int?

    required public init(){}
}

public class MessageTemplateInstance : Codable
{
    public var messageTemplateId:Int?
    public var name:String?
    public var subject:String?
    public var body:String?
    public var reportId:Int?
    public var templateType:Int?
    public var created:Date?
    public var createdBy:Int?
    public var modified:Date?
    public var modifiedBy:Int?
    public var deleted:Date?
    public var deletedBy:Int?
    public var eventType:Int?
    public var contentType:Int?
    public var hidden:Bool?
    public var parentMessageTemplateId:Int?
    public var inclusionTags:String?
    public var exclusionTags:String?

    required public init(){}
}

public class UserInstance : Codable
{
    public var userId:Int?
    public var userName:String?
    public var name:String?
    public var email:String?
    public var mobilePhone:String?
    public var enabled:Bool?
    public var lastLogin:Date?
    public var created:Date?
    public var training:Bool?
    public var deleted:Bool?
    public var coursesCompleted:Int?
    public var displayHomeNotification:Bool?
    public var twoFactorEnabled:Bool?
    public var emailConfirmed:Bool?
    public var mobilePhoneConfirmed:Bool?
    public var notifications:Bool?
    public var changePassword:Date?
    public var activated:Date?

    required public init(){}
}

Swift FindMessage 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 /api/Query/Message HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</FindMessage>

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

<QueryResponseOfMessageInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:MessageInstance>
      <d2p1:BouncedDate>0001-01-01T00:00:00</d2p1:BouncedDate>
      <d2p1:DeliveredDate>0001-01-01T00:00:00</d2p1:DeliveredDate>
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:Failures>0</d2p1:Failures>
      <d2p1:InstanceId>0</d2p1:InstanceId>
      <d2p1:InstanceType>0</d2p1:InstanceType>
      <d2p1:MessageId>0</d2p1:MessageId>
      <d2p1:MessageSid>String</d2p1:MessageSid>
      <d2p1:MessageTemplate>
        <d2p1:Body>String</d2p1:Body>
        <d2p1:ContentType>0</d2p1:ContentType>
        <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
        <d2p1:CreatedBy>0</d2p1:CreatedBy>
        <d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
        <d2p1:DeletedBy>0</d2p1:DeletedBy>
        <d2p1:EventType>0</d2p1:EventType>
        <d2p1:ExclusionTags>String</d2p1:ExclusionTags>
        <d2p1:Hidden>false</d2p1:Hidden>
        <d2p1:InclusionTags>String</d2p1:InclusionTags>
        <d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
        <d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
        <d2p1:ModifiedBy>0</d2p1:ModifiedBy>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ParentMessageTemplateId>0</d2p1:ParentMessageTemplateId>
        <d2p1:ReportId>0</d2p1:ReportId>
        <d2p1:Subject>String</d2p1:Subject>
        <d2p1:TemplateType>0</d2p1:TemplateType>
      </d2p1:MessageTemplate>
      <d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
      <d2p1:OpenedDate>0001-01-01T00:00:00</d2p1:OpenedDate>
      <d2p1:Processed>false</d2p1:Processed>
      <d2p1:SentDate>0001-01-01T00:00:00</d2p1:SentDate>
      <d2p1:SpamReportDate>0001-01-01T00:00:00</d2p1:SpamReportDate>
      <d2p1:UnsubscribedDate>0001-01-01T00:00:00</d2p1:UnsubscribedDate>
      <d2p1:User>
        <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
        <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
        <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
        <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
        <d2p1:Enabled>false</d2p1:Enabled>
        <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
        <d2p1:MobilePhone>String</d2p1:MobilePhone>
        <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Notifications>false</d2p1:Notifications>
        <d2p1:Training>false</d2p1:Training>
        <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:UserName>String</d2p1:UserName>
      </d2p1:User>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:MessageInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfMessageInstancePEZRWkv_P>