JiwaAPI

<back to all web services

EM_MainQuery

Requires Authentication
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 .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 /csv/reply/EM_MainQuery HTTP/1.1 
Host: jiwaapi.stotthoare.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"EmailNo":"String","EmailNoStartsWith":"String","EmailNoEndsWith":"String","EmailNoContains":"String","EmailNoLike":"String","EmailNoBetween":["String"],"EmailNoIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"DateCreated":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedBetween":["0001-01-01T00:00:00.0000000"],"DateCreatedIn":["0001-01-01T00:00:00.0000000"],"DateSent":"0001-01-01T00:00:00.0000000","DateSentGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateSentGreaterThan":"0001-01-01T00:00:00.0000000","DateSentLessThan":"0001-01-01T00:00:00.0000000","DateSentLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateSentNotEqualTo":"0001-01-01T00:00:00.0000000","DateSentBetween":["0001-01-01T00:00:00.0000000"],"DateSentIn":["0001-01-01T00:00:00.0000000"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"SourceType":"String","SourceTypeStartsWith":"String","SourceTypeEndsWith":"String","SourceTypeContains":"String","SourceTypeLike":"String","SourceTypeBetween":["String"],"SourceTypeIn":["String"],"SourceDisplayNo":"String","SourceDisplayNoStartsWith":"String","SourceDisplayNoEndsWith":"String","SourceDisplayNoContains":"String","SourceDisplayNoLike":"String","SourceDisplayNoBetween":["String"],"SourceDisplayNoIn":["String"],"SY_Forms_ClassName":"String","SY_Forms_ClassNameStartsWith":"String","SY_Forms_ClassNameEndsWith":"String","SY_Forms_ClassNameContains":"String","SY_Forms_ClassNameLike":"String","SY_Forms_ClassNameBetween":["String"],"SY_Forms_ClassNameIn":["String"],"EmailStatus":0,"EmailStatusGreaterThanOrEqualTo":0,"EmailStatusGreaterThan":0,"EmailStatusLessThan":0,"EmailStatusLessThanOrEqualTo":0,"EmailStatusNotEqualTo":0,"EmailStatusBetween":[0],"EmailStatusIn":[0],"EmailFrom":"String","EmailFromStartsWith":"String","EmailFromEndsWith":"String","EmailFromContains":"String","EmailFromLike":"String","EmailFromBetween":["String"],"EmailFromIn":["String"],"EmailTo":"String","EmailToStartsWith":"String","EmailToEndsWith":"String","EmailToContains":"String","EmailToLike":"String","EmailToBetween":["String"],"EmailToIn":["String"],"EmailCC":"String","EmailCCStartsWith":"String","EmailCCEndsWith":"String","EmailCCContains":"String","EmailCCLike":"String","EmailCCBetween":["String"],"EmailCCIn":["String"],"EmailBCC":"String","EmailBCCStartsWith":"String","EmailBCCEndsWith":"String","EmailBCCContains":"String","EmailBCCLike":"String","EmailBCCBetween":["String"],"EmailBCCIn":["String"],"EmailSubject":"String","EmailSubjectStartsWith":"String","EmailSubjectEndsWith":"String","EmailSubjectContains":"String","EmailSubjectLike":"String","EmailSubjectBetween":["String"],"EmailSubjectIn":["String"],"EmailBody":"String","EmailBodyStartsWith":"String","EmailBodyEndsWith":"String","EmailBodyContains":"String","EmailBodyLike":"String","EmailBodyBetween":["String"],"EmailBodyIn":["String"],"RequestReadReceipt":false,"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

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