Differences

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

--- guides:ws_submitterrequest [2024/01/12 19:05] – brett.zamora
+++ guides:ws_submitterrequest [2024/01/12 20:53] (current) – brett.zamora
@@ Line 35: / Line 35: @@
 <color #7092be>Request Parameters</color>
-{{tablelayout?colwidth="150px,75px,100px,275px"&rowsFixed=1&rowsVisible=10&float=center}}
+{{tablelayout?colwidth="150px,75px,100px,275px"&rowsFixed=1&rowsVisible=15&float=center}}
 ^ Parm Name ^ Req/Opt ^ Format ^ Description ^
-| RequestID | Required | [string] | Use 0 when calling the web service. |
+| RequestID | Required | [string] | Use 0 when for the intial submitterRequest or use a Request ID when re-submitting a corrected submitterRequest. Including instances where an updated MOU or COI will be provided. |
 | SubmitterTypeID | Required | [string] | Must be on of the following numeric codes: 1 (Title Company) 2 (Lender) 8 (Government) 32 (Other) |
 | PrimaryName | Required | [string] | (Max Len: 255) This name must be unique by Submitter Name, City, State. Please provide name in uppercase. Be sure to escape this value for special characters. |
@@ Line 72: / Line 72: @@
 **Endpoint: (With Parameters)**
-<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/submitterRequest?RequestID=0&SubmitterTypeID=32&PrimaryName=EXAMPLE PRIMARY NAME&Address1=123 EXAMPLE ST.&Address2=&City=EXAMPLE CITY&StateName=CA&PostalCode=12345&COIExpirationDate=12/25/2024</nowiki>
+<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/submitterRequest?RequestID=0&SubmitterTypeID=32&PrimaryName=EXAMPLE PRIMARY NAME&Address1=123 EXAMPLE ST.&Address2=&City=EXAMPLE CITY&StateName=CA&PostalCode=12345&COIExpirationDate=12/25/2024&UpdateMOU=true&UpdateCOI=true</nowiki>
@@ Line 121: / Line 121: @@
 The submitterRequest web service is the first step in a New Submitter Request **workflow** as documented in the following C# snippet.
+It is important to note that when using the submitterRequest web service, the parameter value passed for docType must be either "MOU" or "COI". This distinguishes the submitterRequest from the updateMOUCOIRequest web service call where the docType must be "MOURequest" or "COIRequest".
+These docType values help the server-side processes determine where to store the uploaded PDF document. CeRTNA keeps both the original request PDF documents as well as the approved PDF documents.
@@ Line 142: / Line 146: @@
 As per the workflow snippet, CeRTNA expects that the required MOU and/or COI will be submitted as part of the workflow for creating a New Submitter Request. If the MOU and/or COI is not provide, the New Submitter Request will be rejected by CeRTNA staff.
+**Comment 5:**
+In preceding examples you will see references to objects like tbRequestID.Text or tbSubmitterTypeID.Text and names that start with 'tb'. These objects are field references on the WPF form that is part of the sample application uploaded to the Wiki. The sample application was written for the purposes of writing documentation as well as CeRTNA testing of our web services. The method that you use to supply the required properties for the web services will be dependent on your implementation. Pointing this out, simple to alleviate any confusion over where the 'tb' type variable references are coming from.
+Below is a sample of the WPF form. The fields are filled based on the workflow being tested and the button being clicked.
+{{ :guides:images:ws_wpf_ui_for_reference.png |}}