JiwaAPI

<back to all web services

WebhooksMessageResponsesGETRequest

The following routes are available for this service:
GET/Webhooks/Subscribers/{SubscriberID}/Messages/ResponsesRetrieves a list of all Webhook messages responses for a subscriber.
WebhooksMessageResponsesGETRequest Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_SY_WebhookSubscriber_MessageResponses Parameters:
NameParameterData TypeRequiredDescription
SubscriberIDformGuidNo
SubscriptionIDformGuidNo
MessageIDformGuidNo
MessageResponseIDformGuidNo
EventNameformstringNo
URLformstringNo
BodyformstringNo
MessageItemNoformintNo
StatusformbyteNo
RetriesformintNo
AddedDateTimeformDateTimeNo
MessageLastSavedDateTimeformDateTimeNo
HTTPCodeformintNo
MessageformstringNo
ItemNoformintNo
LastSavedDateTimeformDateTimeNo
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.

GET /Webhooks/Subscribers/{SubscriberID}/Messages/Responses HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_SY_WebhookSubscriber_MessageResponses7kRqkrSv 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_MessageResponses>
      <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_HTTPCode_x003E_k__BackingField>0</d2p1:_x003C_HTTPCode_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_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_MessageItemNo_x003E_k__BackingField>0</d2p1:_x003C_MessageItemNo_x003E_k__BackingField>
      <d2p1:_x003C_MessageLastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_MessageLastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_MessageResponseID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_MessageResponseID_x003E_k__BackingField>
      <d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_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_MessageResponses>
  </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_MessageResponses7kRqkrSv>