ClubManager.Api

FindMessage

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Message

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Message")
open class FindMessage : QueryDb<MessageInstance>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    var Skip:Int? = null

    @DataMember(Order=2)
    var Take:Int? = null

    @DataMember(Order=3)
    var OrderBy:String? = null

    @DataMember(Order=4)
    var OrderByDesc:String? = null

    @DataMember(Order=5)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class MessageInstance
{
    var MessageId:Int? = null
    var DueDate:Date? = null
    var SentDate:Date? = null
    var Processed:Boolean? = null
    var Failures:Int? = null
    var InstanceId:Int? = null
    var MessageSid:String? = null
    var MessageTemplate:MessageTemplateInstance? = null
    @References(MessageTemplateInstance.class)
    var MessageTemplateId:Int? = null

    var OpenedDate:Date? = null
    var BouncedDate:Date? = null
    var DeliveredDate:Date? = null
    var UnsubscribedDate:Date? = null
    var SpamReportDate:Date? = null
    var User:UserInstance? = null
    @References(UserInstance.class)
    var UserId:Int? = null

    var InstanceType:Int? = null
}

open class MessageTemplateInstance
{
    var MessageTemplateId:Int? = null
    var Name:String? = null
    var Subject:String? = null
    var Body:String? = null
    var ReportId:Int? = null
    var TemplateType:Int? = null
    var Created:Date? = null
    var CreatedBy:Int? = null
    var Modified:Date? = null
    var ModifiedBy:Int? = null
    var Deleted:Date? = null
    var DeletedBy:Int? = null
    var EventType:Int? = null
    var ContentType:Int? = null
    var Hidden:Boolean? = null
    var ParentMessageTemplateId:Int? = null
    var InclusionTags:String? = null
    var ExclusionTags:String? = null
}

open class UserInstance
{
    var UserId:Int? = null
    var UserName:String? = null
    var Name:String? = null
    var Email:String? = null
    var MobilePhone:String? = null
    var Enabled:Boolean? = null
    var LastLogin:Date? = null
    var Created:Date? = null
    var Training:Boolean? = null
    var Deleted:Boolean? = null
    var CoursesCompleted:Int? = null
    var DisplayHomeNotification:Boolean? = null
    var TwoFactorEnabled:Boolean? = null
    var EmailConfirmed:Boolean? = null
    var MobilePhoneConfirmed:Boolean? = null
    var Notifications:Boolean? = null
    var ChangePassword:Date? = null
    var Activated:Date? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

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