ListDocumentSets

The listDocumentSets operation is a light weight, efficient method of obtaining simple message metadata from the ReferralNet service and is the method of choice to check for the lodgement of any new messages.

FilterDescription
ALLLists all document sets from the inbox, excluding those marked as deleted.
AFTERReturns a sorted decending list of all document sets that have been lodged after a specified UID, excluding those marked as deleted.
BEFOREReturns a sorted descending list of all document sets that have been lodged before a specified UID, excluding those marked as deleted.
EQUALLists a document set by a specified UID.
FROMReturns a sorted descending list of all document sets that have been lodged from and including a specified UID, excluding those marked as deleted.

The method returns a collection of 0..n document sets in descending order based on the date/time of registration, with each DocumentSet element exposing four identifying attributes;

NameDescription
uidThe unique identifier allotted to the DocumentSet.
classificationThe context / semantic type allocated to the DocumentSet.
templateClassificationThe sub classification of a parent urn:refnet:template classification.
dateTimeThe time the DocumentSet was created and registered with the ReferralNet service.
sizeThe total size of the DocumentSet, this is inclusive of metadata and associated attachments.

Examples

 
<ListDocumentSetsRequest xmlns="urn:global-health:referralnet">
   <Filter>AFTER</Filter>
   <uid>urn:refnet:uuid:ec430ea4-89f2-4b45-9eaf-5ce9ac605f62</uid>
</ListDocumentSetsRequest>
 
<ns6:DocumentSetsResponse xmlns:ns6="urn:global-health:referralnet">
  <ns3:RegistryResponse status="Success" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"></ns3:RegistryResponse>
  <ns6:DocumentSet>
     <ns6:uid>urn:refnet:uuid:7f5adb71-161e-4f23-b157-f7a75fbfe560</ns6:uid>
     <ns6:classification>urn:refnetinternal:read-receipt</ns6:classification>
     <ns6:dateTime>2008-10-17T11:28:46.640+08:00</ns6:dateTime>
     <ns6:size>0</ns6:size>
  </ns6:DocumentSet>
  <ns6:DocumentSet>
    <ns6:uid>urn:refnet:uuid:c1aaf8c8-bb9e-45f6-a481-d68e52745cd1</ns6:uid>
    <ns6:classification>urn:refnet:secure-message</ns6:classification>
    <ns6:dateTime>2008-10-17T11:28:29.890+08:00</ns6:dateTime>
    <ns6:size>6229</ns6:size>
  </ns6:DocumentSet>
  <ns6:DocumentSet>
    <ns6:uid>urn:refnet:uuid:b747637c-4591-4d92-b331-4ce0959e15ae</ns6:uid>
    <ns6:classification>urn:refnetinternal:read-receipt</ns6:classification>
    <ns6:dateTime>2008-10-17T11:10:56.530+08:00</ns6:dateTime>
    <ns6:size>0</ns6:size>
  </ns6:DocumentSet>
  <ns6:DocumentSet>
    <ns6:uid>urn:refnet:uuid:d4b087b8-c05d-4575-943a-68b93acaaa03</ns6:uid>
    <ns6:classification>urn:refnet:secure-message</ns6:classification>
    <ns6:dateTime>2008-10-17T11:10:52.243+08:00</ns6:dateTime>
    <ns6:size>6229</ns6:size>
  </ns6:DocumentSet>
  <ns6:DocumentSet>
    <ns6:uid>urn:refnet:uuid:d4b087b8-c05d-4575-943a-68b93atfff3</ns6:uid>
    <ns6:classification>urn:refnet:template</ns6:classification>
    <ns6:templateClassification>urn:template:something</ns6:templateClassification>
    <ns6:dateTime>2008-10-17T11:10:52.243+08:00</ns6:dateTime>
    <ns6:size>80</ns6:size>
  </ns6:DocumentSet>
</ns6:DocumentSetsResponse>
 
dev/refnet_list.txt · Last modified: 2009/03/12 05:12 by timc