RequestCancel Method

In This Topic

Syntax
Example
Requirements
- See Also

This transaction allows a user agent that does not own a Workitem to request that it be canceled. It corresponds to the UPS DIMSE N-ACTION operation "Request UPS Cancel". To cancel a Workitem that the user agent owns, i.e., that is in the IN PROGRESS state, the user agent uses the transaction

Syntax

public System.Net.Http.HttpResponseMessage RequestCancel( 
   System.string WorkItemUID,
   DicomDataSet ReasonForCancellation,
   DicomDataEncoding Encoding,
   System.string TransferSyntax
)

public function RequestCancel( 
    WorkItemUID: System.String;
    ReasonForCancellation: DicomDataSet;
    Encoding: DicomDataEncoding;
    TransferSyntax: System.String
): System.Net.Http.HttpResponseMessage;

public function RequestCancel( 
   WorkItemUID : System.String,
   ReasonForCancellation : DicomDataSet,
   Encoding : DicomDataEncoding,
   TransferSyntax : System.String
) : System.Net.Http.HttpResponseMessage;

public: System.Net.Http.HttpResponseMessage* RequestCancel( 
   System.string* WorkItemUID,
   DicomDataSet* ReasonForCancellation,
   DicomDataEncoding Encoding,
   System.string* TransferSyntax
)

public:
System.Net.Http.HttpResponseMessage^ RequestCancel( 
   System.String^ WorkItemUID,
   DicomDataSet^ ReasonForCancellation,
   DicomDataEncoding Encoding,
   System.String^ TransferSyntax
)

'Declaration
 
Public Function RequestCancel( _
   ByVal WorkItemUID As System.String, _
   Optional ByVal ReasonForCancellation As DicomDataSet, _
   Optional ByVal Encoding As DicomDataEncoding, _
   Optional ByVal TransferSyntax As System.String _
) As System.Net.Http.HttpResponseMessage

'Usage
 
Dim instance As WorkItemWebClient
Dim WorkItemUID As System.String
Dim ReasonForCancellation As DicomDataSet
Dim Encoding As DicomDataEncoding
Dim TransferSyntax As System.String
Dim value As System.Net.Http.HttpResponseMessage
 
value = instance.RequestCancel(WorkItemUID, ReasonForCancellation, Encoding, TransferSyntax)

Parameters

WorkItemUID: The WorkItem UID to request cancellation
ReasonForCancellation: Payload, if present, may describe the reason for requesting the cancellation of the WorkItem.
Encoding: The encoding to use (native/json/xml)
TransferSyntax: The transfer syntax used to encode and send the WorkItem See part 4 Table CC.2.2-1. Request UPS Cancel 0 Action Information for more details.

Return Value

HttpResponseMessage

Example

WorkItemWebClient wwc = new WorkItemWebClient(BaseUri);
DicomDataSet reason = new DicomDataSet
   {
       { Keyword.ReasonForCancellation, "patient not fit for procedure" },
       { Keyword.ContactURI, "medicalconnections.co.uk" },
       { Keyword.ContactDisplayName, "MC" },
      { Keyword.ProcedureStepDiscontinuationReasonCodeSequence, null }
   };
var rsp = wwc.RequestCancel("1.2.3.4.5.6.7.8.9", reason);
Log($"RequestCancellation response: {rsp.StatusCode}");

Requirements

Target Platforms: .NET CLR 4.8 or higher

Reference

WorkItemWebClient Class
WorkItemWebClient Members
ChangeState Method

Send Feedback