Site Tools


guides:ws_payloads_lock_unlock_finalize

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
guides:ws_payloads_lock_unlock_finalize [2020/08/24 23:20] brett.zamoraguides:ws_payloads_lock_unlock_finalize [2020/08/24 23:30] (current) brett.zamora
Line 167: Line 167:
 Payloads that are 'Retrieved' must be locked before they can be retrieved. If the retrieval is successful and any validation requirements are satisfied, then the remote payload can be deleted with the [[guides:ws_payloads_delete_payload|payloads:delete_payload]] web service, otherwise the payload can be unlocked and the callers application will determine the next steps in their flow. Payloads that are 'Retrieved' must be locked before they can be retrieved. If the retrieval is successful and any validation requirements are satisfied, then the remote payload can be deleted with the [[guides:ws_payloads_delete_payload|payloads:delete_payload]] web service, otherwise the payload can be unlocked and the callers application will determine the next steps in their flow.
  
-The sample code snippet that appears below shows the usage for all 3 web services. (Lock, Unlock, Finalize) +The sample code snippets that appear below show the usage for all 3 web services. (Lock, Unlock, Finalize)
- +
-These snippet of code was derived from the [[guides:web_service_toolbox_project|Web Service Toolbox]] that is available on the CeRTNA Wiki. The sample application is intended for easy to read demonstration purposes and not production quality code. The [[guides:web_service_toolbox_project|Web Service Toolbox]] application is documented, on the CeRTNA Wiki, to aid in understanding the code snippet shown below.+
  
 +These snippet of code was derived from the [[guides:web_service_toolbox_project|Web Service Toolbox]] that is available on the CeRTNA Wiki. The sample application is intended for easy to read demonstration purposes and not production quality code. The [[guides:web_service_toolbox_project|Web Service Toolbox]] application is documented, on the CeRTNA Wiki, to aid in understanding the code snippets shown below.
  
  
 +**Snippet 1: Lock/Unlock**
  
  
Line 274: Line 274:
 } }
 </code> </code>
 +
 +
 +**Snippet 2: Finalize**
 +
 +The following is just a fragment of code that was copied over from the [[guides:ws_payloads_send_payload|payloads:send_payload]] documentation
 +
 +<code C#>
 +var jsonResult2 = JsonConvert.DeserializeObject<dynamic>(response.Content);
 +string strRemoteFileName = jsonResult2.result;
 +
 +// You must finalize the remote file to change the extension from .tmp to .xml
 +            
 +string strAction = "finalize";
 +
 +strURL = null;
 +client = null;
 +request = null;
 +response = null;
 +
 +strURL = "https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/" + strRepositoryType + "/" + strRemoteFileName + "?operation=" + strAction;  
 +
 +client = new RestClient(strURL);
 +request = new RestRequest(Method.PATCH);
 +
 +request.AddHeader("Cache-Control", "no-cache");
 +request.AddHeader("access_token", token);
 +response = client.Execute(request);
 +
 +if (response.IsSuccessful)
 +{
 +    tbMessageLine.Text = "XML file " + strFileName+" successfully sent.";
 +    rc = true;
 +}
 +else
 +{
 +    var jsonResult3 = JsonConvert.DeserializeObject<dynamic>(response.Content);
 +    string strMessage = jsonResult3.Exception.Message;
 +    tbMessageLine.Text = strMessage;
 +}
 +</code>
 +
 +
  
  
guides/ws_payloads_lock_unlock_finalize.1598311243.txt.gz · Last modified: by brett.zamora