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 | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | 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 | |
RequestReadReceipt | query | bool? | 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 | |
CreatedByStaffID | query | string | No | |
CreatedByStaffIDStartsWith | query | string | No | |
CreatedByStaffIDEndsWith | query | string | No | |
CreatedByStaffIDContains | query | string | No | |
CreatedByStaffIDLike | query | string | No | |
CreatedByStaffIDBetween | query | string[] | No | |
CreatedByStaffIDIn | query | string[] | No | |
CreatedDateTime | query | DateTime? | No | |
CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeGreaterThan | query | DateTime? | No | |
CreatedDateTimeLessThan | query | DateTime? | No | |
CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeNotEqualTo | query | DateTime? | No | |
CreatedDateTimeBetween | query | DateTime[] | No | |
CreatedDateTimeIn | query | DateTime[] | No | |
LastSavedByStaffID | query | string | No | |
LastSavedByStaffIDStartsWith | query | string | No | |
LastSavedByStaffIDEndsWith | query | string | No | |
LastSavedByStaffIDContains | query | string | No | |
LastSavedByStaffIDLike | query | string | No | |
LastSavedByStaffIDBetween | query | string[] | No | |
LastSavedByStaffIDIn | 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 | |
DefaultItem | 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 | |
Name | form | string | No | |
EmailFrom | form | string | No | |
EmailTo | form | string | No | |
RequestReadReceipt | form | bool? | No | |
EmailCC | form | string | No | |
EmailBCC | form | string | No | |
EmailSubject | form | string | No | |
EmailBody | form | string | No | |
CreatedByStaffID | form | string | No | |
CreatedDateTime | form | DateTime | No | |
LastSavedByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
DefaultItem | 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.
POST /json/reply/EM_TemplatesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
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: application/json 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"}}}