DicomObjects.NET8 Documentation
DicomObjects.DicomWeb Namespace / WorkItemWebClient Class / Subscribe Method
The Subscribe Target Resource
deletionlock query parameter in the Subscribe request
The AETitle of Subscriber
The Workitem UID for matching, required if Resource is Workitem
A Workitem Subscription will be created for any existing and future Workitem that matches the attribute/value pairs of the filter.
Example



In This Topic
    Subscribe Method
    In This Topic
    This transaction creates a Subscription to a Worklist or Workitem resource. It corresponds to the UPS DIMSE N-ACTION operation "Subscribe to Receive UPS Event Reports".
    Syntax
    'Declaration
     
    
    Public Function Subscribe( _
       ByVal Resource As SubscribeTargetResource, _
       ByVal DeletionLock As Boolean, _
       ByVal AETitle As String, _
       ByVal WorkItemUID As String, _
       ByVal FilterDataSet As DicomDataSet _
    ) As HttpResponseMessage
    'Usage
     
    
    Dim instance As WorkItemWebClient
    Dim Resource As SubscribeTargetResource
    Dim DeletionLock As Boolean
    Dim AETitle As String
    Dim WorkItemUID As String
    Dim FilterDataSet As DicomDataSet
    Dim value As HttpResponseMessage
     
    value = instance.Subscribe(Resource, DeletionLock, AETitle, WorkItemUID, FilterDataSet)

    Parameters

    Resource
    The Subscribe Target Resource
    DeletionLock
    deletionlock query parameter in the Subscribe request
    AETitle
    The AETitle of Subscriber
    WorkItemUID
    The Workitem UID for matching, required if Resource is Workitem
    FilterDataSet
    A Workitem Subscription will be created for any existing and future Workitem that matches the attribute/value pairs of the filter.

    Return Value

    A DicomObjects.DicomDataSet object that represents the retreived Workitem (UPS) object
    Example
    WorkItemWebClient wwc = new WorkItemWebClient(BaseUri);
    var ds = wwc.Retrieve("1.2.3.4.5.6.7.8.9");
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also