JiwaAPI

<back to all web services

EM_TemplatesQuery

Requires Authentication
EM_TemplatesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
EmailFromquerystringNo
EmailFromStartsWithquerystringNo
EmailFromEndsWithquerystringNo
EmailFromContainsquerystringNo
EmailFromLikequerystringNo
EmailFromBetweenquerystring[]No
EmailFromInquerystring[]No
EmailToquerystringNo
EmailToStartsWithquerystringNo
EmailToEndsWithquerystringNo
EmailToContainsquerystringNo
EmailToLikequerystringNo
EmailToBetweenquerystring[]No
EmailToInquerystring[]No
RequestReadReceiptquerybool?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
CreatedByStaffIDquerystringNo
CreatedByStaffIDStartsWithquerystringNo
CreatedByStaffIDEndsWithquerystringNo
CreatedByStaffIDContainsquerystringNo
CreatedByStaffIDLikequerystringNo
CreatedByStaffIDBetweenquerystring[]No
CreatedByStaffIDInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryDateTime[]No
CreatedDateTimeInqueryDateTime[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DefaultItemquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EM_Templates Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
NameformstringNo
EmailFromformstringNo
EmailToformstringNo
RequestReadReceiptformbool?No
EmailCCformstringNo
EmailBCCformstringNo
EmailSubjectformstringNo
EmailBodyformstringNo
CreatedByStaffIDformstringNo
CreatedDateTimeformDateTimeNo
LastSavedByStaffIDformstringNo
LastSavedDateTimeformDateTimeNo
DefaultItemformbool?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_TemplatesQuery HTTP/1.1 
Host: api.jiwa.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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"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"],"RequestReadReceipt":false,"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"],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["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"],"DefaultItem":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","Name":"String","EmailFrom":"String","EmailTo":"String","RequestReadReceipt":false,"EmailCC":"String","EmailBCC":"String","EmailSubject":"String","EmailBody":"String","CreatedByStaffID":"String","LastSavedByStaffID":"String","DefaultItem":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}