DokuWiki

Site Tools

Trace: • sample_submitterrequest_snippet
guides:ws_postdocument

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_postdocument [2022/11/10 01:03] – brett.zamoraguides:ws_postdocument [2023/03/21 15:06] (current) – brett.zamora
Line 38: Line 38:
 | documentType | Required | [string] | This will be MOU or COI | | documentType | Required | [string] | This will be MOU or COI |
 | requestID | Required | [string] | This is the Request ID that was returned from a submitterRequest or updateCOIRequest web service call. | | requestID | Required | [string] | This is the Request ID that was returned from a submitterRequest or updateCOIRequest web service call. |
-| SubmitterID | Required | [string] | The Submitter ID associated with the updated COI. |+| SubmitterID | Dependent | [string] | The Submitter ID associated with the updated COI. This value is required if you are updating the COI. |
  
  
Line 45: Line 45:
 {{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}} {{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}}
 ^ Parm Name ^ Format ^ Description ^ ^ Parm Name ^ Format ^ Description ^
-| result | [string] | If the updateCOIRequest is successfully created, the RequestID will be returned in the result property of the response. The RequestID is needed when sending along the associated COI document for the Update COI Request. |+| result | [string] | If the upload is successful, the web service will return the name of the file that was saved in the MOU Library and/or COI Library. |
 | code | [string] | Exception conditions will result in code/message being returned. | | code | [string] | Exception conditions will result in code/message being returned. |
 | message | [string] | Longer description of exception condition. | | message | [string] | Longer description of exception condition. |
  
  
-As noted, any condition that results in an unsuccessful call to the updateCOIRequest web service will produce a JSON formatted response with a code and message property populated. Successful calls will result in the RequestID property being returned. The RequestID is a required parameter of the postDocument web service.+As noted, any condition that results in an unsuccessful call to the postDocument web service will produce a JSON formatted response with a code and message property populated. Successful calls will result in the result property being returned and the property will be populated with the file name that was stored in the library. The RequestID is a required parameter of the postDocument web service.
  
  
-<color #7092be>Sample Request</color>+<color #7092be>Sample Requests</color>
  
 **Endpoint: (With Parameters)** **Endpoint: (With Parameters)**
  
-<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/updateCOIRequest?RequestID=0&COIExpirationDate=12/25/2024&SubmitterID=1234</nowiki>+<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/postDocument?documentType=MOU&requestID=12</nowiki> 
 + 
 +or 
 + 
 +<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/postDocument?documentType=COI&requestID=8</nowiki>
  
  
Line 64: Line 68:
 Content-Type: application/json (For the login process) Content-Type: application/json (For the login process)
  
-Content-Type: text/plain (For the web service call)+Content-Type: application/pdf (For the web service call)
  
  
 **Body:** **Body:**
  
-Body content is not required because the parameters are pass as text/plain content as part of the Endpoint URL.+The PDF document that is being uploaded is added to the request body as a parameter. Refer to the examples below to see how this is accomplished.
  
 <color #7092be>Sample Response</color> <color #7092be>Sample Response</color>
Line 78: Line 82:
 <code json> <code json>
 { {
-    "result": "35"+    "result": "TEST AGENT 1-35-V5-MOU.PDF"
 } }
 </code> </code>
  
 +**OR**
 +
 +<code json>
 +{
 +    "result": "TEST AGENT 1-35-V5-COI.PDF"
 +}
 +</code>
  
 **OR** **OR**
Line 91: Line 102:
 { {
     "Exception": {     "Exception": {
-        "Code": "SubmitterNotFound", +        "Code": "UnexpectedError", 
-        "Message": "SUBMITTER ID 1234 is not found or does not belong to the requesting organization."+        "Message": "An unexpected error has occurred while processing your request."
     }     }
 } }
Line 105: Line 116:
 **Comment 1:** **Comment 1:**
  
-The updateCOIRequest web service is the first step in an Update COI Request **workflow** as documented in the following C# snippet.+The postDocument web service call is the final step in a New Submitter Request or Update COI Request **workflow** as documented in the following C# snippets. 
  
 +{{page>[:guides:sample_submitterrequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
 {{page>[:guides:sample_updatecoirequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}} {{page>[:guides:sample_updatecoirequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
Line 113: Line 126:
 **Comment 2:** **Comment 2:**
  
-The following C# snippet shows how to login and call the updateCOIRequest web service. In this example, the parameters that are being supplied to the web service are copied from the fields on WPF form.+The following C# snippet shows how to login and call the postDocument web service. In this example, the parameters that are being supplied to the web service are copied from the fields on WPF form.
  
-{{page>[:guides:sample_updatecoirequest_snippet&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}+{{page>[:guides:sample_postdocument_snippet&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
Line 126: Line 139:
 **Comment 4:** **Comment 4:**
  
-As per the workflow snippet, CeRTNA expects that the required COI will be submitted as part of the workflow for creating the Update COI Request. If the COI is not provided, the Update COI Request will be rejected by CeRTNA staff.+As per the workflow snippet, CeRTNA expects that the required MOU or COI will be submitted as part of the workflow for creating the New Submitter Request or Update COI Request. If the MOU or COI is not provided, the New Submitter Request or Update COI Request will be rejected by CeRTNA staff.
  
guides/ws_postdocument.1668042192.txt.gz · Last modified: by brett.zamora