Site Tools


guides:web_service_toolbox_project

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:web_service_toolbox_project [2020/08/24 19:02] brett.zamoraguides:web_service_toolbox_project [2020/08/25 01:32] (current) brett.zamora
Line 46: Line 46:
 {{ :guides:images:wst_folderitems-02.png |}} {{ :guides:images:wst_folderitems-02.png |}}
  
-The Folder Item Details function demonstrates the use of the [[guides:ws_payloads_get_repository_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.+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.
  
  
Line 76: Line 76:
 | [[guides:ws_payloads_lock_unlock_finalize|payloads:lock_unlock_finalize_payload]] | Lock, unlock, or finalize (rename the file extension) a payload. | | [[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. | | [[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.
  
  
guides/web_service_toolbox_project.1598295739.txt.gz · Last modified: by brett.zamora