JiwaAPI

<back to all web services

EM_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/EM_MainRetrieves a list of email messages.
EM_MainQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
EmailNoquerystringNo
EmailNoStartsWithquerystringNo
EmailNoEndsWithquerystringNo
EmailNoContainsquerystringNo
EmailNoLikequerystringNo
EmailNoBetweenquerystring[]No
EmailNoInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DateCreatedqueryDateTime?No
DateCreatedGreaterThanOrEqualToqueryDateTime?No
DateCreatedGreaterThanqueryDateTime?No
DateCreatedLessThanqueryDateTime?No
DateCreatedLessThanOrEqualToqueryDateTime?No
DateCreatedNotEqualToqueryDateTime?No
DateCreatedBetweenqueryDateTime[]No
DateCreatedInqueryDateTime[]No
DateSentqueryDateTime?No
DateSentGreaterThanOrEqualToqueryDateTime?No
DateSentGreaterThanqueryDateTime?No
DateSentLessThanqueryDateTime?No
DateSentLessThanOrEqualToqueryDateTime?No
DateSentNotEqualToqueryDateTime?No
DateSentBetweenqueryNullable<DateTime>[]No
DateSentInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
SourceTypequerystringNo
SourceTypeStartsWithquerystringNo
SourceTypeEndsWithquerystringNo
SourceTypeContainsquerystringNo
SourceTypeLikequerystringNo
SourceTypeBetweenquerystring[]No
SourceTypeInquerystring[]No
SourceDisplayNoquerystringNo
SourceDisplayNoStartsWithquerystringNo
SourceDisplayNoEndsWithquerystringNo
SourceDisplayNoContainsquerystringNo
SourceDisplayNoLikequerystringNo
SourceDisplayNoBetweenquerystring[]No
SourceDisplayNoInquerystring[]No
SY_Forms_ClassNamequerystringNo
SY_Forms_ClassNameStartsWithquerystringNo
SY_Forms_ClassNameEndsWithquerystringNo
SY_Forms_ClassNameContainsquerystringNo
SY_Forms_ClassNameLikequerystringNo
SY_Forms_ClassNameBetweenquerystring[]No
SY_Forms_ClassNameInquerystring[]No
EmailStatusquerybyte?No
EmailStatusGreaterThanOrEqualToquerybyte?No
EmailStatusGreaterThanquerybyte?No
EmailStatusLessThanquerybyte?No
EmailStatusLessThanOrEqualToquerybyte?No
EmailStatusNotEqualToquerybyte?No
EmailStatusBetweenqueryNullable<Byte>[]No
EmailStatusInqueryNullable<Byte>[]No
EmailFromquerystringNo
EmailFromStartsWithquerystringNo
EmailFromEndsWithquerystringNo
EmailFromContainsquerystringNo
EmailFromLikequerystringNo
EmailFromBetweenquerystring[]No
EmailFromInquerystring[]No
EmailToquerystringNo
EmailToStartsWithquerystringNo
EmailToEndsWithquerystringNo
EmailToContainsquerystringNo
EmailToLikequerystringNo
EmailToBetweenquerystring[]No
EmailToInquerystring[]No
EmailCCquerystringNo
EmailCCStartsWithquerystringNo
EmailCCEndsWithquerystringNo
EmailCCContainsquerystringNo
EmailCCLikequerystringNo
EmailCCBetweenquerystring[]No
EmailCCInquerystring[]No
EmailBCCquerystringNo
EmailBCCStartsWithquerystringNo
EmailBCCEndsWithquerystringNo
EmailBCCContainsquerystringNo
EmailBCCLikequerystringNo
EmailBCCBetweenquerystring[]No
EmailBCCInquerystring[]No
EmailSubjectquerystringNo
EmailSubjectStartsWithquerystringNo
EmailSubjectEndsWithquerystringNo
EmailSubjectContainsquerystringNo
EmailSubjectLikequerystringNo
EmailSubjectBetweenquerystring[]No
EmailSubjectInquerystring[]No
EmailBodyquerystringNo
EmailBodyStartsWithquerystringNo
EmailBodyEndsWithquerystringNo
EmailBodyContainsquerystringNo
EmailBodyLikequerystringNo
EmailBodyBetweenquerystring[]No
EmailBodyInquerystring[]No
RequestReadReceiptquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EM_Main Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
EmailNoformstringNo
LastSavedDateTimeformDateTimeNo
DateCreatedformDateTimeNo
DateSentformDateTime?No
StaffIDformstringNo
ReferenceformstringNo
SourceIDformstringNo
SourceTypeformstringNo
SourceDisplayNoformstringNo
SY_Forms_ClassNameformstringNo
EmailStatusformbyte?No
EmailFromformstringNo
EmailToformstringNo
EmailCCformstringNo
EmailBCCformstringNo
EmailSubjectformstringNo
EmailBodyformstringNo
RequestReadReceiptformbool?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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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"}}}