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
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
MessageInstance Parameters:
NameParameterData TypeRequiredDescription
MessageIdformintNo
DueDateformDateTimeNo
SentDateformDateTime?No
ProcessedformboolNo
FailuresformintNo
InstanceIdformint?No
MessageSidformstringNo
MessageTemplateformMessageTemplateInstanceNo
MessageTemplateIdformint?No
OpenedDateformDateTime?No
BouncedDateformDateTime?No
DeliveredDateformDateTime?No
UnsubscribedDateformDateTime?No
SpamReportDateformDateTime?No
UserformUserInstanceNo
UserIdformint?No
InstanceTypeformint?No
MessageTemplateInstance Parameters:
NameParameterData TypeRequiredDescription
MessageTemplateIdformintNo
NameformstringNo
SubjectformstringNo
BodyformstringNo
ReportIdformint?No
TemplateTypeformintNo
CreatedformDateTime?No
CreatedByformint?No
ModifiedformDateTime?No
ModifiedByformint?No
DeletedformDateTime?No
DeletedByformint?No
EventTypeformintNo
ContentTypeformintNo
Hiddenformbool?No
ParentMessageTemplateIdformint?No
InclusionTagsformstringNo
ExclusionTagsformstringNo
UserInstance Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
NameformstringNo
EmailformstringNo
MobilePhoneformstringNo
EnabledformboolNo
LastLoginformDateTime?No
CreatedformDateTimeNo
TrainingformboolNo
DeletedformboolNo
CoursesCompletedformintNo
DisplayHomeNotificationformbool?No
TwoFactorEnabledformboolNo
EmailConfirmedformboolNo
MobilePhoneConfirmedformboolNo
NotificationsformboolNo
ChangePasswordformDateTime?No
ActivatedformDateTime?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"MessageId":0,"DueDate":"0001-01-01T00:00:00.0000000","SentDate":"0001-01-01T00:00:00.0000000","Processed":false,"Failures":0,"InstanceId":0,"MessageSid":"String","MessageTemplate":{"MessageTemplateId":0,"Name":"String","Subject":"String","Body":"String","ReportId":0,"TemplateType":0,"Created":"0001-01-01T00:00:00.0000000","CreatedBy":0,"Modified":"0001-01-01T00:00:00.0000000","ModifiedBy":0,"Deleted":"0001-01-01T00:00:00.0000000","DeletedBy":0,"EventType":0,"ContentType":0,"Hidden":false,"ParentMessageTemplateId":0,"InclusionTags":"String","ExclusionTags":"String"},"MessageTemplateId":0,"OpenedDate":"0001-01-01T00:00:00.0000000","BouncedDate":"0001-01-01T00:00:00.0000000","DeliveredDate":"0001-01-01T00:00:00.0000000","UnsubscribedDate":"0001-01-01T00:00:00.0000000","SpamReportDate":"0001-01-01T00:00:00.0000000","User":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"UserId":0,"InstanceType":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}