RetrieveDocumentSetEvents

The RetrieveDocumentSetEvents method returns all instances of registered events associated to a specified DocumentSet. Both the source and recipient of the DocumentSet can obtain these events with the recipient the only entity able to register events.

EventDescription
????If the recipient system utilises the MarkDocumentSetEvent SOAP operation to set custom events (eg. SCHEDULED, WAITING etc) then these values will also be returned.
DELETEThe DocumentSet has been marked as logically deleted by the recipient, physical deletion occurs at the attachment body level.
NOTIFYA notification event has been registered against a DocumentSet, these notifications are governed by the recipient user profile.
READA DocumentSet has been successfully decrypted and processed by the recipient.
READ_FAILUREA DocumentSet has failed to be successfully decrypted and processed by the recipient.
RETRIEVEA DocumentSet has been retrieved / downloaded from the ReferralNet service by the intended recipient.
REVOKE Not Implemented
<RetrieveDocumentSetEvents xmlns="urn:global-health:referralnet">urn:1179jimv</RetrieveDocumentSetEvents>
<ns6:RetrieveDocumentSetEventsResponse xmlns:ns6="urn:global-health:referralnet">
   <ns3:RegistryResponse requestId="urn:1179jimv" status="Success" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
   </ns3:RegistryResponse>
   <ns6:Event>
      <ns6:Event>NOTIFY</ns6:Event>
      <ns6:EventDateTime>2008-11-01T09:36:52.153+09:00</ns6:EventDateTime>
   </ns6:Event>
   <ns6:Event>
      <ns6:Event>RETRIEVE</ns6:Event>
      <ns6:EventDateTime>2008-11-03T10:28:13.577+09:00</ns6:EventDateTime>
   </ns6:Event>
   <ns6:Event>
      <ns6:Event>READ</ns6:Event>
      <ns6:EventDateTime>2008-11-03T10:28:21.607+09:00</ns6:EventDateTime>
   </ns6:Event>
</ns6:RetrieveDocumentSetEventsResponse>

If a DocumentSet has been deleted via the DeleteDocumentSet operation, it will still be honoured in a RetrieveDocumentSetEvents operation, returning the DELETE event type in the response set.

<ns6:RetrieveDocumentSetEventsResponse xmlns:ns6="urn:global-health:referralnet">
   <ns3:RegistryResponse requestId="urn:1179jimv" status="Success" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
   </ns3:RegistryResponse>
   <ns6:Event>
      <ns6:Event>NOTIFY</ns6:Event>
      <ns6:EventDateTime>2008-11-01T09:36:52.153+09:00</ns6:EventDateTime>
   </ns6:Event>
   <ns6:Event>
      <ns6:Event>RETRIEVE</ns6:Event>
      <ns6:EventDateTime>2008-11-03T10:28:13.577+09:00</ns6:EventDateTime>
   </ns6:Event>
   <ns6:Event>
      <ns6:Event>READ</ns6:Event>
      <ns6:EventDateTime>2008-11-03T10:28:21.607+09:00</ns6:EventDateTime>
   </ns6:Event>
   <ns6:Event>
      <ns6:Event>DELETE</ns6:Event>
      <ns6:EventDateTime>2008-11-04T16:33:08.783+09:00</ns6:EventDateTime>
   </ns6:Event>
</ns6:RetrieveDocumentSetEventsResponse>

If the DocumentSet specified does not exist or is not owned by the requestor then the following response stream is returned.

<ns6:RetrieveDocumentSetEventsResponse xmlns:ns6="urn:global-health:referralnet">
   <ns3:RegistryResponse status="Failure" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
      <ns3:RegistryErrorList>
         <ns3:RegistryError codeContext="Failed to locate documentSet with id urn:1179jimvs" 
                            errorCode="SearchException" 
                            severity="Error">
         </ns3:RegistryError>
      </ns3:RegistryErrorList>
   </ns3:RegistryResponse>
</ns6:RetrieveDocumentSetEventsResponse>
 
dev/retrieve_document_set_events.txt · Last modified: 2009/10/22 02:38 by timc