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 | |
Header | query | string | No | |
HeaderStartsWith | query | string | No | |
HeaderEndsWith | query | string | No | |
HeaderContains | query | string | No | |
HeaderLike | query | string | No | |
HeaderBetween | query | string[] | No | |
HeaderIn | query | string[] | No | |
Body | query | string | No | |
BodyStartsWith | query | string | No | |
BodyEndsWith | query | string | No | |
BodyContains | query | string | No | |
BodyLike | query | string | No | |
BodyBetween | query | string[] | No | |
BodyIn | query | string[] | No | |
Footer | query | string | No | |
FooterStartsWith | query | string | No | |
FooterEndsWith | query | string | No | |
FooterContains | query | string | No | |
FooterLike | query | string | No | |
FooterBetween | query | string[] | No | |
FooterIn | query | string[] | No | |
ToField | query | string | No | |
ToFieldStartsWith | query | string | No | |
ToFieldEndsWith | query | string | No | |
ToFieldContains | query | string | No | |
ToFieldLike | query | string | No | |
ToFieldBetween | query | string[] | No | |
ToFieldIn | query | string[] | No | |
FromField | query | string | No | |
FromFieldStartsWith | query | string | No | |
FromFieldEndsWith | query | string | No | |
FromFieldContains | query | string | No | |
FromFieldLike | query | string | No | |
FromFieldBetween | query | string[] | No | |
FromFieldIn | query | string[] | No | |
CCField | query | string | No | |
CCFieldStartsWith | query | string | No | |
CCFieldEndsWith | query | string | No | |
CCFieldContains | query | string | No | |
CCFieldLike | query | string | No | |
CCFieldBetween | query | string[] | No | |
CCFieldIn | query | string[] | No | |
BCCField | query | string | No | |
BCCFieldStartsWith | query | string | No | |
BCCFieldEndsWith | query | string | No | |
BCCFieldContains | query | string | No | |
BCCFieldLike | query | string | No | |
BCCFieldBetween | query | string[] | No | |
BCCFieldIn | query | string[] | No | |
Subject | query | string | No | |
SubjectStartsWith | query | string | No | |
SubjectEndsWith | query | string | No | |
SubjectContains | query | string | No | |
SubjectLike | query | string | No | |
SubjectBetween | query | string[] | No | |
SubjectIn | query | string[] | No | |
RequestReadReceipt | query | bool? | No | |
RowHash | query | byte[] | 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 | |
Header | form | string | No | |
Body | form | string | No | |
Footer | form | string | No | |
ToField | form | string | No | |
FromField | form | string | No | |
CCField | form | string | No | |
BCCField | form | string | No | |
Subject | form | string | No | |
RequestReadReceipt | form | bool | No | |
RowHash | form | byte[] | 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/SY_RemittanceAdviceEmailTemplatesQuery 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"],"Header":"String","HeaderStartsWith":"String","HeaderEndsWith":"String","HeaderContains":"String","HeaderLike":"String","HeaderBetween":["String"],"HeaderIn":["String"],"Body":"String","BodyStartsWith":"String","BodyEndsWith":"String","BodyContains":"String","BodyLike":"String","BodyBetween":["String"],"BodyIn":["String"],"Footer":"String","FooterStartsWith":"String","FooterEndsWith":"String","FooterContains":"String","FooterLike":"String","FooterBetween":["String"],"FooterIn":["String"],"ToField":"String","ToFieldStartsWith":"String","ToFieldEndsWith":"String","ToFieldContains":"String","ToFieldLike":"String","ToFieldBetween":["String"],"ToFieldIn":["String"],"FromField":"String","FromFieldStartsWith":"String","FromFieldEndsWith":"String","FromFieldContains":"String","FromFieldLike":"String","FromFieldBetween":["String"],"FromFieldIn":["String"],"CCField":"String","CCFieldStartsWith":"String","CCFieldEndsWith":"String","CCFieldContains":"String","CCFieldLike":"String","CCFieldBetween":["String"],"CCFieldIn":["String"],"BCCField":"String","BCCFieldStartsWith":"String","BCCFieldEndsWith":"String","BCCFieldContains":"String","BCCFieldLike":"String","BCCFieldBetween":["String"],"BCCFieldIn":["String"],"Subject":"String","SubjectStartsWith":"String","SubjectEndsWith":"String","SubjectContains":"String","SubjectLike":"String","SubjectBetween":["String"],"SubjectIn":["String"],"RequestReadReceipt":false,"RowHash":"AA==","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","Header":"String","Body":"String","Footer":"String","ToField":"String","FromField":"String","CCField":"String","BCCField":"String","Subject":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}