DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

===== CeRTNA Web Services =====

CeRTNA supports a variety of web services. In order to use our web services, you will need web service credentials. If you would like to access the CeRTNA web services, please contact CeRTNA to obtain web service credentials.

As shown in the following high-level diagram, CeRTNA web services use a common 'soft-token' architecture.

To receive a 'soft-token' you must successfully authenticate. Once you have successfully authenticated, you will receive a 'soft-token' that can be used for subsequent web service calls. Your 'soft-token' is valid for the duration of your SSL session.

CeRTNA currently supports the following web services. You can click on the web service name to view a more detailed document for the selected web service.

{{tablelayout?colwidth="300px,300px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Web Service Name ^ Description ^
| [[guides:ws_login|Login]] | Used to authenticate and to obtain a soft-token. |
| [[guides:ws_store_checksum|StoreChecksum]] | Used to store the checksum of a Base64Document string in the CeRTNA Portal. |
| [[guides:ws_validatechecksum|ValidateChecksum]] | The ValidateChecksum web service is intended to be used by a client to verify that a document-level checksum calculated locally matches the document-level checksum that was supplied by the alternate party. |
| [[guides:ws_transaction|Transaction]] | The Transaction web service is used to obtain the current status of a transaction and optionally the transaction history. |

The following web services are based on a hierarchical REST API structure that is rooted with the payloads web service. For ease of documentation, the extensions to the payloads web service are categorized as 'functions' and although each function is documented separately, each is function is a child and/or extension to the payloads service and the correct syntax is documented in the Request Endpoint section for each function.

The web service functions listed in the following table support CeRTNA's 'Remote Folder' functionality which is an architecture that allows REQUEST and RESPONSE files to be sent to or retrieved from folders that reside outside of the county or submitters internal network

{{tablelayout?colwidth="300px,300px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Web Service:Function^ Description ^
| [[guides:ws_payloads_get_repository_names|payloads:get_repository_names]] | Get supported repository names with payload counts. |
| [[guides:ws_payloads_get_repository_file_names|payloads:get_repository_file_names]] | Get a list of file names in the specified repository. |
| [[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. |

The following web services were added to support the automation of New Submitter Requests and Update COI Requests. This group of web services consists of 3 services as shown below. Click on the web service name for more detailed information about the web service.

{{tablelayout?colwidth="300px,300px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Web ServiceName^ Description ^
| [[guides:ws_submitterrequest|submitterRequest]] | Send a New Submitter Request. |
| [[guides:ws_updatecoirequest|updateCOIRequest]] | Send an Update COI Request. |
| [[guides:sample_postdocument_snippet|postDocument]] | Snippet. |
| [[guides:ws_postdocument|postDocument]] | Send an MOU or COI supporting PDF document. |

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International