This is an old revision of the document!
Table of Contents
CeRTNA Sample Web Service Toolbox Project
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.
The application demonstrates functions like:
- Logging in to obtain a soft-token for use with the various web services.
- Obtaining a list of payloads that reside in a remote folder (repository).
- 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: (Web Service Toolbox)
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
- RestSharp
The project uses the Windows Presentation Foundation (WPF) classes for the UI.
Following is a brief outline of how to use the tool:
After starting the tool, the following UI will be displayed:
Note: For all of the functions described below, your web service userid and password are required.
Folder Item Details
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.
A list of the payloads contained in the selected folder/repository will be displayed in the grid as shown below:
The Folder Item Details function demonstrates the use of the 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
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:
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.
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:
| Web Service:Function | Description |
|---|---|
| payloads:retrieve_payload | Retrieve a payload from the specified repository. |
| payloads:send_payload | Send a payload from the specified repository. |
| payloads:lock_unlock_finalize_payload | Lock, unlock, or finalize (rename the file extension) a payload. |
| payloads:delete_payload | Delete a payload from the specified repository. |