Differences

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

--- guides:web_service_toolbox_project [2020/08/24 16:17] – created brett.zamora
+++ guides:web_service_toolbox_project [2020/08/25 01:32] (current) – brett.zamora
@@ Line 1: / Line 1: @@
 ===== CeRTNA Sample Web Service Toolbox Project =====
-CeRTNA has uploaded a sample Visual Studio 2015 C# project that provides a high-level demonstration of how to call the CeRTNA web services.
+CeRTNA has uploaded a sample Visual Studio 2015 C# project entitled Web Service Toolbox that provides a high-level demonstration of how to call the CeRTNA web services that are sending and retrieving payloads and checking a transaction status.
 **Disclaimer:** This sample project is provided as is for reference purposes only. It is not intended to represent production quality code.
@@ Line 7: / Line 7: @@
 The application demonstrates functions like:
-  * Obtaining the value of a Base64 document string from an XML file.
-  * Calculating a SHA384 Hash and converting the hash to a Base64 string.
   * Logging in to obtain a soft-token for use with the various web services.
-  * Calling StoreChecksum web service to store a checksum value.
+  * Obtaining a list of payloads that reside in a remote folder (repository).
-  * Calling the ValidateChecksum web service to validate a checksum value.
+  * Locking, unlocking, and deleting a payload from a remote folder (repository).
+  * Sending/Retrieving payloads to/from remote folders.
+  * Getting a transaction status and transaction history.
-The project can be downloaded by clicking this link: ({{guides:checksumtool.zip|Checksum Tool}})
+The project can be downloaded by clicking this link: ({{guides:web_service_toolbox.zip|Web Service Toolbox}})
-The ChecksumTool project uses the following NuGet packages, which you will need to install into your Visual Studio setup, if you do not already have them installed:
+The Web ServiceToolbox project uses the following NuGet packages, which you will need to install into your Visual Studio setup, if you do not already have them installed:
   * Newtonsoft.Json
@@ Line 28: / Line 28: @@
-{{ :guides:images:checksum_tool.png |}}
+{{ :guides:images:wst_startup-01.png |}}
+**Note:** For all of the functions described below, your web service userid and password are required.
-To use the tool, the typical order of steps would be:
-{{tablelayout?colwidth="200px,400px"&rowsFixed=1&rowsVisible=10&float=center}}
+==== Folder Item Details Description ====
-^ Step ^ Comment ^
-| Enter User Name & PW | These are special web service user accounts provided to you by CeRTNA. |
-| Select/Load an XML file | You can use a REQUEST or RESPONSE file. |
-| Enter a Doc Seq# | This identies which Doc Seq# contained in the XML file that you wish to work with. |
-| Click the Calculate button | The SHA3 checksum is calculated and displayed in the Base64 Document Checksum field. |
-| Click the Store button | The calculated checksum is stored in the CeRTNA Portal and a Checksum Key is returned and displayed in the Base64 Document Checksum Key field. |
-| Click the Validate button | The ChecksumKey and Checksum values displayed on the form are used to validate the locally calculated checksum value against the stored value in the database. |
-| Click the Reset button | This clears the form fields. |
+To view a list of payloads in a remote folder (repository), click the Folder Item Details radio button and then select the remote repository as shown below, from the dropdown list.
-**Note:** The Checksum Value field is unprotected so that you can modify the checksum value manually to test the negative result of the ValidateChecksum flow.
+{{ :guides:images:wst_folderitems-01.png |}}
-There are plenty of other tools available for testing web services as well. One of the tools CeRTNA works with is POSTMAN. You can download a free version of POSTMAN from the following URL: https://www.getpostman.com/apps
+A list of the payloads contained in the selected folder/repository will be displayed in the grid as shown below:
+{{ :guides:images:wst_folderitems-02.png |}}
+The Folder Item Details function demonstrates the use of the [[guides:ws_payloads_get_repository_file_names|payloads:get_repository_file_names]] web service. You can review the source code using Visual Studio or the snippet of code that is included in the web service documentation.
+==== Send/Retrieve Description ====
+To Send/Retrieve a payload to/from a remote folder/repository, click the Send/Retrieve radio button and then select a repository name from the dropdown list as shown below:
+{{ :guides:images:wst_sendretrieve-01.png |}}
+Click the Browse button to browse for the folder that will be used for payloads that will be uploaded (Send) or the folder where payloads that will be downloaded (Retrieve) will be stored.
+{{ :guides:images:wst_sendretrieve-02.png |}}
+Click the Send button to initiate the upload of all the payloads in the referenced Local Folder to the remote folder/repository that was selected in the dropdown list.
+Click the Retrieve button to initiate the download of all the payloads in selected remote folder/repository to the referenced Local Folder.
+The Send/Retrieve option demonstrates the use of the following web services/functions:
+{{tablelayout?colwidth="300px,300px"&rowsFixed=1&rowsVisible=10&float=center}}
+^ Web Service:Function^ Description ^
+| [[guides:ws_payloads_retrieve_payload|payloads:retrieve_payload]] | Retrieve a payload from the specified repository. |
+| [[guides:ws_payloads_send_payload|payloads:send_payload]] | Send a payload from the specified repository. |
+| [[guides:ws_payloads_lock_unlock_finalize|payloads:lock_unlock_finalize_payload]] | Lock, unlock, or finalize (rename the file extension) a payload. |
+| [[guides:ws_payloads_delete_payload|payloads:delete_payload]] | Delete a payload from the specified repository. |
+==== Lock/Unlock Description ====
+To exercise the Lock/Unlock web services, click the Lock/Unlock radio button and then select a repository name from the dropdown list as shown below:
+{{ :guides:images:wst_lockunlock-01.png |}}
+After selecting the repository, the Files dropdown list will be populated with the list of payloads currently in the selected repository. You can review the [[guides:ws_payloads_retrieve_payload|payloads:retrieve_payload]] web service for how to get a list of payload names from a remote folder/repository.
+Select a file from the dropdown list:
+{{ :guides:images:wst_lockunlock-02.png |}}
+Once a payload name is selected, you can experiment with the Lock, Unlock, and Delete web services by clicking the approprate button.
+==== Check Status Description ====
+To exercise the Transaction web service...
+  * Click the Check Status radio button.
+  * Enter a Submitter ID.
+  * Enter a Primary Reference value.
+  * Click the Transaction History checkbox (Optional)
+  * Click the Get Status button
+As shown below, the UI will be populated with the details of the transaction details and optionally the transaction history for the Submitter ID/Primary Reference combination that you entered.
+{{ :guides:images:wst_checkstatus-01.png |}}
+**Important Note:** You can only check the status of a transaction that is associated with the organization that your web service user is associated with.
+You can review the [[guides:ws_transaction|Transaction]] web service service for more details about how to check the status of a payload/transaction.