| 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 | |
| Source | query | string | No | |
| SourceStartsWith | query | string | No | |
| SourceEndsWith | query | string | No | |
| SourceContains | query | string | No | |
| SourceLike | query | string | No | |
| SourceBetween | query | string[] | No | |
| SourceIn | query | string[] | No | |
| LinkName | query | string | No | |
| LinkNameStartsWith | query | string | No | |
| LinkNameEndsWith | query | string | No | |
| LinkNameContains | query | string | No | |
| LinkNameLike | query | string | No | |
| LinkNameBetween | query | string[] | No | |
| LinkNameIn | query | string[] | No | |
| Caption | query | string | No | |
| CaptionStartsWith | query | string | No | |
| CaptionEndsWith | query | string | No | |
| CaptionContains | query | string | No | |
| CaptionLike | query | string | No | |
| CaptionBetween | query | string[] | No | |
| CaptionIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| ScriptText | query | string | No | |
| ScriptTextStartsWith | query | string | No | |
| ScriptTextEndsWith | query | string | No | |
| ScriptTextContains | query | string | No | |
| ScriptTextLike | query | string | No | |
| ScriptTextBetween | query | string[] | No | |
| ScriptTextIn | 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 |
| 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 | |
| Source | form | string | No | |
| LinkName | form | string | No | |
| Caption | form | string | No | |
| Description | form | string | No | |
| ScriptText | form | string | No | |
| LastSavedDateTime | form | DateTime | 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_MessageLinksQuery 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"],"Source":"String","SourceStartsWith":"String","SourceEndsWith":"String","SourceContains":"String","SourceLike":"String","SourceBetween":["String"],"SourceIn":["String"],"LinkName":"String","LinkNameStartsWith":"String","LinkNameEndsWith":"String","LinkNameContains":"String","LinkNameLike":"String","LinkNameBetween":["String"],"LinkNameIn":["String"],"Caption":"String","CaptionStartsWith":"String","CaptionEndsWith":"String","CaptionContains":"String","CaptionLike":"String","CaptionBetween":["String"],"CaptionIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"ScriptText":"String","ScriptTextStartsWith":"String","ScriptTextEndsWith":"String","ScriptTextContains":"String","ScriptTextLike":"String","ScriptTextBetween":["String"],"ScriptTextIn":["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"],"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","Source":"String","LinkName":"String","Caption":"String","Description":"String","ScriptText":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}