DokuWiki

Site Tools

Trace: • ws_payloads
guides:ws_submitterrequest

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_submitterrequest [2022/11/10 00:21] – brett.zamoraguides:ws_submitterrequest [2024/01/12 20:53] (current) – brett.zamora
Line 4: Line 4:
 The submitterRequest web service is used to send a 'new' submitter request to CeRTNA. The submitterRequest web service is used to send a 'new' submitter request to CeRTNA.
  
-As with other CeRTNA web services, you must use the login workflow to obtain a soft-token that can be used when calling the submitterRequest web service. (The Login workflow is documented in the examples shown below.)+As with other CeRTNA web services, you must use the login workflow to obtain a soft-token that can be used when calling the submitterRequest web service. 
 + 
 +Click this link ([[guides:ws_login|Login Workflow Example]]) to review the Login workflow.
  
 Your user credentials allow the backend web service to ensure that your user request is properly assigned to your organization. Your user credentials allow the backend web service to ensure that your user request is properly assigned to your organization.
  
 +This web service was updated in the CeRTNA January 2024 APEX update. It was expanded to support properties that indicate whether a MOU or COI or both will be submitted in support of this submitterRequest. Set the property values to true or  false to indicate if an MOU or COI or both should be expected to follow via the postDocument request.
 +
 +Additionally, in order to support follow-up resubmissions for requests that are in Failed or Rejected status, this web service now supports the ability for the end-user to provide a Request ID when calling the submitterRequest web service. If providing the Request ID for a resubmission (corrected issue) the current status must be in Failed or Rejected status for the request to be accepted.
  
 <color #7092be>Request Endpoint</color> <color #7092be>Request Endpoint</color>
Line 30: Line 35:
 <color #7092be>Request Parameters</color> <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 ^ ^ 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) | | SubmitterTypeID | Required | [string] | Must be on of the following numeric codes: 1 (Title Company) 2 (Lender) 8 (Government) 32 (Other) |
-| PrimaryName | Required | [string] | This name must be unique by Submitter Name, City, State. Please provide name in uppercase. | +| 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. | 
-| Address1 | Required | [string] | Street address 1. | +| Address1 | Required | [string] | (Max Len: 100) Street address 1. Be sure to escape this value for special characters. | 
-| Address2 | Required | [string] | Street address 2. This can be an empty string. | +| Address2 | Required | [string] | (Max Len: 100) Street address 2. This can be an empty string. Be sure to escape this value for special characters. | 
-| City | Required | [string] | City name. |+| City | Required | [string] | (Max Len: 100) City name. |
 | StateName | Required | [string] | Two character state id. | | StateName | Required | [string] | Two character state id. |
 | PostalCode | Required | [string] | Zip code. 5 or 9 character. | | PostalCode | Required | [string] | Zip code. 5 or 9 character. |
 | COIExpirationDate | Required | [string] | If the SubmitterTypeID is 32 (Other) then a COI Expiration Date is required otherwise an empty string can be provided. | | COIExpirationDate | Required | [string] | If the SubmitterTypeID is 32 (Other) then a COI Expiration Date is required otherwise an empty string can be provided. |
 +| UpdateMOU | Required | [string] | Indicates if a MOU will be uploaded with the postDocument call. (true or false.) |
 +| UpdateCOI | Required | [string] | Indicates if a COI will be uploaded with the postDocument call. (true or false.) |
  
  
Line 65: Line 72:
 **Endpoint: (With Parameters)** **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 114: Line 121:
  
 The submitterRequest web service is the first step in a New Submitter Request **workflow** as documented in the following C# snippet. 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 135: 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. 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 |}}
 +
 +
  
  
guides/ws_submitterrequest.1668039696.txt.gz · Last modified: by brett.zamora