Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SubscriberID | query | Guid? | No | |
SubscriberIDIn | query | Guid[] | No | |
SubscriptionID | query | Guid? | No | |
SubscriptionIDIn | query | Guid[] | No | |
MessageID | query | Guid? | No | |
MessageIDIn | query | Guid[] | No | |
EventName | query | string | No | |
EventNameStartsWith | query | string | No | |
EventNameEndsWith | query | string | No | |
EventNameContains | query | string | No | |
EventNameLike | query | string | No | |
EventNameBetween | query | string[] | No | |
EventNameIn | query | string[] | No | |
URL | query | string | No | |
URLStartsWith | query | string | No | |
URLEndsWith | query | string | No | |
URLContains | query | string | No | |
URLLike | query | string | No | |
URLBetween | query | string[] | No | |
URLIn | 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 | |
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 | |
Status | query | byte? | No | |
StatusGreaterThanOrEqualTo | query | byte? | No | |
StatusGreaterThan | query | byte? | No | |
StatusLessThan | query | byte? | No | |
StatusLessThanOrEqualTo | query | byte? | No | |
StatusNotEqualTo | query | byte? | No | |
StatusBetween | query | byte[] | No | |
StatusIn | query | byte[] | No | |
Retries | query | int? | No | |
RetriesGreaterThanOrEqualTo | query | int? | No | |
RetriesGreaterThan | query | int? | No | |
RetriesLessThan | query | int? | No | |
RetriesLessThanOrEqualTo | query | int? | No | |
RetriesNotEqualTo | query | int? | No | |
RetriesBetween | query | int[] | No | |
RetriesIn | query | int[] | No | |
AddedDateTime | query | DateTime? | No | |
AddedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
AddedDateTimeGreaterThan | query | DateTime? | No | |
AddedDateTimeLessThan | query | DateTime? | No | |
AddedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
AddedDateTimeNotEqualTo | query | DateTime? | No | |
AddedDateTimeBetween | query | DateTime[] | No | |
AddedDateTimeIn | query | DateTime[] | 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 | |
LastMessageResponseHTTPCode | query | int? | No | |
LastMessageResponseHTTPCodeGreaterThanOrEqualTo | query | int? | No | |
LastMessageResponseHTTPCodeGreaterThan | query | int? | No | |
LastMessageResponseHTTPCodeLessThan | query | int? | No | |
LastMessageResponseHTTPCodeLessThanOrEqualTo | query | int? | No | |
LastMessageResponseHTTPCodeNotEqualTo | query | int? | No | |
LastMessageResponseHTTPCodeBetween | query | Nullable<Int32>[] | No | |
LastMessageResponseHTTPCodeIn | query | Nullable<Int32>[] | No | |
LastMessageResponseMessage | query | string | No | |
LastMessageResponseMessageStartsWith | query | string | No | |
LastMessageResponseMessageEndsWith | query | string | No | |
LastMessageResponseMessageContains | query | string | No | |
LastMessageResponseMessageLike | query | string | No | |
LastMessageResponseMessageBetween | query | string[] | No | |
LastMessageResponseMessageIn | query | string[] | 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 |
---|---|---|---|---|
SubscriberID | form | Guid | No | |
SubscriptionID | form | Guid | No | |
MessageID | form | Guid | No | |
EventName | form | string | No | |
URL | form | string | No | |
Body | form | string | No | |
ItemNo | form | int | No | |
Status | form | byte | No | |
Retries | form | int | No | |
AddedDateTime | form | DateTime | No | |
LastSavedDateTime | form | DateTime | No | |
LastMessageResponseHTTPCode | form | int? | No | |
LastMessageResponseMessage | form | string | 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/v_SY_WebhookSubscriber_MessagesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"SubscriberID":"00000000000000000000000000000000","SubscriberIDIn":["00000000-0000-0000-0000-000000000000"],"SubscriptionID":"00000000000000000000000000000000","SubscriptionIDIn":["00000000-0000-0000-0000-000000000000"],"MessageID":"00000000000000000000000000000000","MessageIDIn":["00000000-0000-0000-0000-000000000000"],"EventName":"String","EventNameStartsWith":"String","EventNameEndsWith":"String","EventNameContains":"String","EventNameLike":"String","EventNameBetween":["String"],"EventNameIn":["String"],"URL":"String","URLStartsWith":"String","URLEndsWith":"String","URLContains":"String","URLLike":"String","URLBetween":["String"],"URLIn":["String"],"Body":"String","BodyStartsWith":"String","BodyEndsWith":"String","BodyContains":"String","BodyLike":"String","BodyBetween":["String"],"BodyIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","Retries":0,"RetriesGreaterThanOrEqualTo":0,"RetriesGreaterThan":0,"RetriesLessThan":0,"RetriesLessThanOrEqualTo":0,"RetriesNotEqualTo":0,"RetriesBetween":[0],"RetriesIn":[0],"AddedDateTime":"0001-01-01T00:00:00.0000000","AddedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","AddedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","AddedDateTimeLessThan":"0001-01-01T00:00:00.0000000","AddedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","AddedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","AddedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"AddedDateTimeIn":["0001-01-01T00:00:00.0000000"],"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"],"LastMessageResponseHTTPCode":0,"LastMessageResponseHTTPCodeGreaterThanOrEqualTo":0,"LastMessageResponseHTTPCodeGreaterThan":0,"LastMessageResponseHTTPCodeLessThan":0,"LastMessageResponseHTTPCodeLessThanOrEqualTo":0,"LastMessageResponseHTTPCodeNotEqualTo":0,"LastMessageResponseHTTPCodeBetween":[0],"LastMessageResponseHTTPCodeIn":[0],"LastMessageResponseMessage":"String","LastMessageResponseMessageStartsWith":"String","LastMessageResponseMessageEndsWith":"String","LastMessageResponseMessageContains":"String","LastMessageResponseMessageLike":"String","LastMessageResponseMessageBetween":["String"],"LastMessageResponseMessageIn":["String"],"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":[{"EventName":"String","URL":"String","Body":"String","LastMessageResponseHTTPCode":0,"LastMessageResponseMessage":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}