ClubManager.Api

FindMessage

**Requires Authentication**
Required role:	API

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

namespace ClubManager.Api.Services.Query

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MessageTemplateInstance() = 
        member val MessageTemplateId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Subject:String = null with get,set
        member val Body:String = null with get,set
        member val ReportId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TemplateType:Int32 = new Int32() with get,set
        member val Created:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Modified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModifiedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EventType:Int32 = new Int32() with get,set
        member val ContentType:Int32 = new Int32() with get,set
        member val Hidden:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ParentMessageTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InclusionTags:String = null with get,set
        member val ExclusionTags:String = null with get,set

    [<AllowNullLiteral>]
    type UserInstance() = 
        member val UserId:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val CoursesCompleted:Int32 = new Int32() with get,set
        member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MessageInstance() = 
        member val MessageId:Int32 = new Int32() with get,set
        member val DueDate:DateTime = new DateTime() with get,set
        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Processed:Boolean = new Boolean() with get,set
        member val Failures:Int32 = new Int32() with get,set
        member val InstanceId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MessageSid:String = null with get,set
        member val MessageTemplate:MessageTemplateInstance = null with get,set
        [<References(typeof<MessageTemplateInstance>)>]
        member val MessageTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val OpenedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val BouncedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeliveredDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UnsubscribedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SpamReportDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val User:UserInstance = null with get,set
        [<References(typeof<UserInstance>)>]
        member val UserId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val InstanceType:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Message")>]
    [<AllowNullLiteral>]
    type FindMessage() = 
        inherit QueryDb<MessageInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

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