JiwaAPI

<back to all web services

v_SY_WebhookSubscriber_MessagesQuery

Requires Authentication
v_SY_WebhookSubscriber_MessagesQuery Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDqueryGuid?No
SubscriberIDInqueryGuid[]No
SubscriptionIDqueryGuid?No
SubscriptionIDInqueryGuid[]No
MessageIDqueryGuid?No
MessageIDInqueryGuid[]No
EventNamequerystringNo
EventNameStartsWithquerystringNo
EventNameEndsWithquerystringNo
EventNameContainsquerystringNo
EventNameLikequerystringNo
EventNameBetweenquerystring[]No
EventNameInquerystring[]No
URLquerystringNo
URLStartsWithquerystringNo
URLEndsWithquerystringNo
URLContainsquerystringNo
URLLikequerystringNo
URLBetweenquerystring[]No
URLInquerystring[]No
BodyquerystringNo
BodyStartsWithquerystringNo
BodyEndsWithquerystringNo
BodyContainsquerystringNo
BodyLikequerystringNo
BodyBetweenquerystring[]No
BodyInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
Retriesqueryint?No
RetriesGreaterThanOrEqualToqueryint?No
RetriesGreaterThanqueryint?No
RetriesLessThanqueryint?No
RetriesLessThanOrEqualToqueryint?No
RetriesNotEqualToqueryint?No
RetriesBetweenqueryint[]No
RetriesInqueryint[]No
AddedDateTimequeryDateTime?No
AddedDateTimeGreaterThanOrEqualToqueryDateTime?No
AddedDateTimeGreaterThanqueryDateTime?No
AddedDateTimeLessThanqueryDateTime?No
AddedDateTimeLessThanOrEqualToqueryDateTime?No
AddedDateTimeNotEqualToqueryDateTime?No
AddedDateTimeBetweenqueryDateTime[]No
AddedDateTimeInqueryDateTime[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
LastMessageResponseHTTPCodequeryint?No
LastMessageResponseHTTPCodeGreaterThanOrEqualToqueryint?No
LastMessageResponseHTTPCodeGreaterThanqueryint?No
LastMessageResponseHTTPCodeLessThanqueryint?No
LastMessageResponseHTTPCodeLessThanOrEqualToqueryint?No
LastMessageResponseHTTPCodeNotEqualToqueryint?No
LastMessageResponseHTTPCodeBetweenqueryNullable<Int32>[]No
LastMessageResponseHTTPCodeInqueryNullable<Int32>[]No
LastMessageResponseMessagequerystringNo
LastMessageResponseMessageStartsWithquerystringNo
LastMessageResponseMessageEndsWithquerystringNo
LastMessageResponseMessageContainsquerystringNo
LastMessageResponseMessageLikequerystringNo
LastMessageResponseMessageBetweenquerystring[]No
LastMessageResponseMessageInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_SY_WebhookSubscriber_Messages Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDformGuidNo
SubscriptionIDformGuidNo
MessageIDformGuidNo
EventNameformstringNo
URLformstringNo
BodyformstringNo
ItemNoformintNo
StatusformbyteNo
RetriesformintNo
AddedDateTimeformDateTimeNo
LastSavedDateTimeformDateTimeNo
LastMessageResponseHTTPCodeformint?No
LastMessageResponseMessageformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/v_SY_WebhookSubscriber_MessagesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<v_SY_WebhookSubscriber_MessagesQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <AddedDateTime>0001-01-01T00:00:00</AddedDateTime>
  <AddedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </AddedDateTimeBetween>
  <AddedDateTimeGreaterThan>0001-01-01T00:00:00</AddedDateTimeGreaterThan>
  <AddedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</AddedDateTimeGreaterThanOrEqualTo>
  <AddedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </AddedDateTimeIn>
  <AddedDateTimeLessThan>0001-01-01T00:00:00</AddedDateTimeLessThan>
  <AddedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</AddedDateTimeLessThanOrEqualTo>
  <AddedDateTimeNotEqualTo>0001-01-01T00:00:00</AddedDateTimeNotEqualTo>
  <Body>String</Body>
  <BodyBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BodyBetween>
  <BodyContains>String</BodyContains>
  <BodyEndsWith>String</BodyEndsWith>
  <BodyIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BodyIn>
  <BodyLike>String</BodyLike>
  <BodyStartsWith>String</BodyStartsWith>
  <EventName>String</EventName>
  <EventNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventNameBetween>
  <EventNameContains>String</EventNameContains>
  <EventNameEndsWith>String</EventNameEndsWith>
  <EventNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventNameIn>
  <EventNameLike>String</EventNameLike>
  <EventNameStartsWith>String</EventNameStartsWith>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <LastMessageResponseHTTPCode>0</LastMessageResponseHTTPCode>
  <LastMessageResponseHTTPCodeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LastMessageResponseHTTPCodeBetween>
  <LastMessageResponseHTTPCodeGreaterThan>0</LastMessageResponseHTTPCodeGreaterThan>
  <LastMessageResponseHTTPCodeGreaterThanOrEqualTo>0</LastMessageResponseHTTPCodeGreaterThanOrEqualTo>
  <LastMessageResponseHTTPCodeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LastMessageResponseHTTPCodeIn>
  <LastMessageResponseHTTPCodeLessThan>0</LastMessageResponseHTTPCodeLessThan>
  <LastMessageResponseHTTPCodeLessThanOrEqualTo>0</LastMessageResponseHTTPCodeLessThanOrEqualTo>
  <LastMessageResponseHTTPCodeNotEqualTo>0</LastMessageResponseHTTPCodeNotEqualTo>
  <LastMessageResponseMessage>String</LastMessageResponseMessage>
  <LastMessageResponseMessageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastMessageResponseMessageBetween>
  <LastMessageResponseMessageContains>String</LastMessageResponseMessageContains>
  <LastMessageResponseMessageEndsWith>String</LastMessageResponseMessageEndsWith>
  <LastMessageResponseMessageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastMessageResponseMessageIn>
  <LastMessageResponseMessageLike>String</LastMessageResponseMessageLike>
  <LastMessageResponseMessageStartsWith>String</LastMessageResponseMessageStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <MessageID>00000000-0000-0000-0000-000000000000</MessageID>
  <MessageIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </MessageIDIn>
  <Retries>0</Retries>
  <RetriesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </RetriesBetween>
  <RetriesGreaterThan>0</RetriesGreaterThan>
  <RetriesGreaterThanOrEqualTo>0</RetriesGreaterThanOrEqualTo>
  <RetriesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </RetriesIn>
  <RetriesLessThan>0</RetriesLessThan>
  <RetriesLessThanOrEqualTo>0</RetriesLessThanOrEqualTo>
  <RetriesNotEqualTo>0</RetriesNotEqualTo>
  <Status>0</Status>
  <StatusBetween>AA==</StatusBetween>
  <StatusGreaterThan>0</StatusGreaterThan>
  <StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
  <StatusIn>AA==</StatusIn>
  <StatusLessThan>0</StatusLessThan>
  <StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
  <StatusNotEqualTo>0</StatusNotEqualTo>
  <SubscriberID>00000000-0000-0000-0000-000000000000</SubscriberID>
  <SubscriberIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubscriberIDIn>
  <SubscriptionID>00000000-0000-0000-0000-000000000000</SubscriptionID>
  <SubscriptionIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubscriptionIDIn>
  <URL>String</URL>
  <URLBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </URLBetween>
  <URLContains>String</URLContains>
  <URLEndsWith>String</URLEndsWith>
  <URLIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </URLIn>
  <URLLike>String</URLLike>
  <URLStartsWith>String</URLStartsWith>
</v_SY_WebhookSubscriber_MessagesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_SY_WebhookSubscriber_Messages7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:v_SY_WebhookSubscriber_Messages>
      <d2p1:_x003C_AddedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_AddedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Body_x003E_k__BackingField>String</d2p1:_x003C_Body_x003E_k__BackingField>
      <d2p1:_x003C_EventName_x003E_k__BackingField>String</d2p1:_x003C_EventName_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastMessageResponseHTTPCode_x003E_k__BackingField>0</d2p1:_x003C_LastMessageResponseHTTPCode_x003E_k__BackingField>
      <d2p1:_x003C_LastMessageResponseMessage_x003E_k__BackingField>String</d2p1:_x003C_LastMessageResponseMessage_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_MessageID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_MessageID_x003E_k__BackingField>
      <d2p1:_x003C_Retries_x003E_k__BackingField>0</d2p1:_x003C_Retries_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_SubscriberID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SubscriberID_x003E_k__BackingField>
      <d2p1:_x003C_SubscriptionID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SubscriptionID_x003E_k__BackingField>
      <d2p1:_x003C_URL_x003E_k__BackingField>String</d2p1:_x003C_URL_x003E_k__BackingField>
    </d2p1:v_SY_WebhookSubscriber_Messages>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfv_SY_WebhookSubscriber_Messages7kRqkrSv>