Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | Guid? | No | |
RecIDIn | query | Guid[] | No | |
SY_WebhookMessage_RecID | query | Guid? | No | |
SY_WebhookMessage_RecIDIn | query | Guid[] | No | |
HTTPCode | query | int? | No | |
HTTPCodeGreaterThanOrEqualTo | query | int? | No | |
HTTPCodeGreaterThan | query | int? | No | |
HTTPCodeLessThan | query | int? | No | |
HTTPCodeLessThanOrEqualTo | query | int? | No | |
HTTPCodeNotEqualTo | query | int? | No | |
HTTPCodeBetween | query | int[] | No | |
HTTPCodeIn | query | int[] | No | |
Message | query | string | No | |
MessageStartsWith | query | string | No | |
MessageEndsWith | query | string | No | |
MessageContains | query | string | No | |
MessageLike | query | string | No | |
MessageBetween | query | string[] | No | |
MessageIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | 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 | Guid | No | |
SY_WebhookMessage_RecID | form | Guid | No | |
HTTPCode | form | int | No | |
Message | form | string | No | |
ItemNo | form | int | 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_WebhookMessageResponseQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_WebhookMessage_RecID":"00000000000000000000000000000000","SY_WebhookMessage_RecIDIn":["00000000-0000-0000-0000-000000000000"],"HTTPCode":0,"HTTPCodeGreaterThanOrEqualTo":0,"HTTPCodeGreaterThan":0,"HTTPCodeLessThan":0,"HTTPCodeLessThanOrEqualTo":0,"HTTPCodeNotEqualTo":0,"HTTPCodeBetween":[0],"HTTPCodeIn":[0],"Message":"String","MessageStartsWith":"String","MessageEndsWith":"String","MessageContains":"String","MessageLike":"String","MessageBetween":["String"],"MessageIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"Message":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}