| GET | /Queries/EM_Main | Retrieves a list of email messages. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| EmailNo | query | string | No | |
| EmailNoStartsWith | query | string | No | |
| EmailNoEndsWith | query | string | No | |
| EmailNoContains | query | string | No | |
| EmailNoLike | query | string | No | |
| EmailNoBetween | query | string[] | No | |
| EmailNoIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| DateCreated | query | DateTime? | No | |
| DateCreatedGreaterThanOrEqualTo | query | DateTime? | No | |
| DateCreatedGreaterThan | query | DateTime? | No | |
| DateCreatedLessThan | query | DateTime? | No | |
| DateCreatedLessThanOrEqualTo | query | DateTime? | No | |
| DateCreatedNotEqualTo | query | DateTime? | No | |
| DateCreatedBetween | query | DateTime[] | No | |
| DateCreatedIn | query | DateTime[] | No | |
| DateSent | query | DateTime? | No | |
| DateSentGreaterThanOrEqualTo | query | DateTime? | No | |
| DateSentGreaterThan | query | DateTime? | No | |
| DateSentLessThan | query | DateTime? | No | |
| DateSentLessThanOrEqualTo | query | DateTime? | No | |
| DateSentNotEqualTo | query | DateTime? | No | |
| DateSentBetween | query | Nullable<DateTime>[] | No | |
| DateSentIn | query | Nullable<DateTime>[] | No | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| SourceID | query | string | No | |
| SourceIDStartsWith | query | string | No | |
| SourceIDEndsWith | query | string | No | |
| SourceIDContains | query | string | No | |
| SourceIDLike | query | string | No | |
| SourceIDBetween | query | string[] | No | |
| SourceIDIn | query | string[] | No | |
| SourceType | query | string | No | |
| SourceTypeStartsWith | query | string | No | |
| SourceTypeEndsWith | query | string | No | |
| SourceTypeContains | query | string | No | |
| SourceTypeLike | query | string | No | |
| SourceTypeBetween | query | string[] | No | |
| SourceTypeIn | query | string[] | No | |
| SourceDisplayNo | query | string | No | |
| SourceDisplayNoStartsWith | query | string | No | |
| SourceDisplayNoEndsWith | query | string | No | |
| SourceDisplayNoContains | query | string | No | |
| SourceDisplayNoLike | query | string | No | |
| SourceDisplayNoBetween | query | string[] | No | |
| SourceDisplayNoIn | query | string[] | No | |
| SY_Forms_ClassName | query | string | No | |
| SY_Forms_ClassNameStartsWith | query | string | No | |
| SY_Forms_ClassNameEndsWith | query | string | No | |
| SY_Forms_ClassNameContains | query | string | No | |
| SY_Forms_ClassNameLike | query | string | No | |
| SY_Forms_ClassNameBetween | query | string[] | No | |
| SY_Forms_ClassNameIn | query | string[] | No | |
| EmailStatus | query | byte? | No | |
| EmailStatusGreaterThanOrEqualTo | query | byte? | No | |
| EmailStatusGreaterThan | query | byte? | No | |
| EmailStatusLessThan | query | byte? | No | |
| EmailStatusLessThanOrEqualTo | query | byte? | No | |
| EmailStatusNotEqualTo | query | byte? | No | |
| EmailStatusBetween | query | Nullable<Byte>[] | No | |
| EmailStatusIn | query | Nullable<Byte>[] | No | |
| EmailFrom | query | string | No | |
| EmailFromStartsWith | query | string | No | |
| EmailFromEndsWith | query | string | No | |
| EmailFromContains | query | string | No | |
| EmailFromLike | query | string | No | |
| EmailFromBetween | query | string[] | No | |
| EmailFromIn | query | string[] | No | |
| EmailTo | query | string | No | |
| EmailToStartsWith | query | string | No | |
| EmailToEndsWith | query | string | No | |
| EmailToContains | query | string | No | |
| EmailToLike | query | string | No | |
| EmailToBetween | query | string[] | No | |
| EmailToIn | query | string[] | No | |
| EmailCC | query | string | No | |
| EmailCCStartsWith | query | string | No | |
| EmailCCEndsWith | query | string | No | |
| EmailCCContains | query | string | No | |
| EmailCCLike | query | string | No | |
| EmailCCBetween | query | string[] | No | |
| EmailCCIn | query | string[] | No | |
| EmailBCC | query | string | No | |
| EmailBCCStartsWith | query | string | No | |
| EmailBCCEndsWith | query | string | No | |
| EmailBCCContains | query | string | No | |
| EmailBCCLike | query | string | No | |
| EmailBCCBetween | query | string[] | No | |
| EmailBCCIn | query | string[] | No | |
| EmailSubject | query | string | No | |
| EmailSubjectStartsWith | query | string | No | |
| EmailSubjectEndsWith | query | string | No | |
| EmailSubjectContains | query | string | No | |
| EmailSubjectLike | query | string | No | |
| EmailSubjectBetween | query | string[] | No | |
| EmailSubjectIn | query | string[] | No | |
| EmailBody | query | string | No | |
| EmailBodyStartsWith | query | string | No | |
| EmailBodyEndsWith | query | string | No | |
| EmailBodyContains | query | string | No | |
| EmailBodyLike | query | string | No | |
| EmailBodyBetween | query | string[] | No | |
| EmailBodyIn | query | string[] | No | |
| RequestReadReceipt | query | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| EmailNo | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| DateCreated | form | DateTime | No | |
| DateSent | form | DateTime? | No | |
| StaffID | form | string | No | |
| Reference | form | string | No | |
| SourceID | form | string | No | |
| SourceType | form | string | No | |
| SourceDisplayNo | form | string | No | |
| SY_Forms_ClassName | form | string | No | |
| EmailStatus | form | byte? | No | |
| EmailFrom | form | string | No | |
| EmailTo | form | string | No | |
| EmailCC | form | string | No | |
| EmailBCC | form | string | No | |
| EmailSubject | form | string | No | |
| EmailBody | form | string | No | |
| RequestReadReceipt | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/EM_Main HTTP/1.1 Host: localhost Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"RecID":"String","EmailNo":"String","DateSent":"0001-01-01T00:00:00.0000000","StaffID":"String","Reference":"String","SourceID":"String","SourceType":"String","SourceDisplayNo":"String","SY_Forms_ClassName":"String","EmailStatus":0,"EmailFrom":"String","EmailTo":"String","EmailCC":"String","EmailBCC":"String","EmailSubject":"String","EmailBody":"String","RequestReadReceipt":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}