ClubManager.Api

FindMessage

**Requires Authentication**
Required role:	API

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

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**MessageInstance** Parameters:
Name	Parameter	Data Type	Required
MessageId	form	int	No
DueDate	form	DateTime	No
SentDate	form	DateTime?	No
Processed	form	bool	No
Failures	form	int	No
InstanceId	form	int?	No
MessageSid	form	string	No
MessageTemplate	form	MessageTemplateInstance	No
MessageTemplateId	form	int?	No
OpenedDate	form	DateTime?	No
BouncedDate	form	DateTime?	No
DeliveredDate	form	DateTime?	No
UnsubscribedDate	form	DateTime?	No
SpamReportDate	form	DateTime?	No
User	form	UserInstance	No
UserId	form	int?	No
InstanceType	form	int?	No

**MessageTemplateInstance** Parameters:
Name	Parameter	Data Type	Required
MessageTemplateId	form	int	No
Name	form	string	No
Subject	form	string	No
Body	form	string	No
ReportId	form	int?	No
TemplateType	form	int	No
Created	form	DateTime?	No
CreatedBy	form	int?	No
Modified	form	DateTime?	No
ModifiedBy	form	int?	No
Deleted	form	DateTime?	No
DeletedBy	form	int?	No
EventType	form	int	No
ContentType	form	int	No
Hidden	form	bool?	No
ParentMessageTemplateId	form	int?	No
InclusionTags	form	string	No
ExclusionTags	form	string	No

**UserInstance** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
UserName	form	string	No
Name	form	string	No
Email	form	string	No
MobilePhone	form	string	No
Enabled	form	bool	No
LastLogin	form	DateTime?	No
Created	form	DateTime	No
Training	form	bool	No
Deleted	form	bool	No
CoursesCompleted	form	int	No
DisplayHomeNotification	form	bool?	No
TwoFactorEnabled	form	bool	No
EmailConfirmed	form	bool	No
MobilePhoneConfirmed	form	bool	No
Notifications	form	bool	No
ChangePassword	form	DateTime?	No
Activated	form	DateTime?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <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>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
</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>