DokuWiki

Site Tools

Trace:
guides:ws_updatecoirequest

Differences

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

Link to this comparison view

Next revision		Previous revision
guides:ws_updatecoirequest [2022/11/10 00:21] – created brett.zamoraguides:ws_updatecoirequest [2024/01/16 16:10] (current) – brett.zamora
Line 1: Line 1:
 ==== Web Service: updateCOIRequest ==== ==== Web Service: updateCOIRequest ====
  
 +<color #ed1c24>**Please note: CeRTNA will remove this web service on June 1, 2024. Please use the updateMOUCOIRequest web service in place of this one.**</color>
  
 The updateCOIRequest web service is used to send an updated Certificate of Insurance (COI) document to CeRTNA. The COI document is linked to a specific submitter, so the correct Submitter ID must be provided when calling the web service. The updateCOIRequest web service is used to send an updated Certificate of Insurance (COI) document to CeRTNA. The COI document is linked to a specific submitter, so the correct Submitter ID must be provided when calling the web service.
  
-As with other CeRTNA web services, you must use the login workflow to obtain a soft-token that can be used when calling the updateCOIRequest 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 updateCOIRequest 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.
Line 13: Line 16:
 {{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}} {{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}}
 ^ Method ^ URL ^ ^ Method ^ URL ^
-| POST | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/submitterRequest</nowiki> |+| POST | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/updateCOIRequest</nowiki> |
  
  
Line 33: Line 36:
 ^ 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 calling the web service. |
-| SubmitterTypeID | Required | [string] | Must be on of the following numeric codes: 1 (Title Company) 2 (Lender) 8 (Government) 32 (Other) | +| COIExpirationDate | Required | [string] | The date the updated COI will expire. | 
-| PrimaryName | Required | [string] | This name must be unique by Submitter Name, City, State. Please provide name in uppercase. | +| SubmitterID | Required | [string] | The Submitter ID associated with the updated COI. |
-| Address1 | Required | [string] | Street address 1. | +
-| Address2 | Required | [string] | Street address 2. This can be an empty string. | +
-| City | Required | [string] | City name. | +
-| StateName | Required | [string] | Two character state id. | +
-| 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. | +
- +
- +
- +
- +
- +
  
  
Line 53: Line 44:
 {{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 submitterRequest is successfully created, the RequestID will be returned in the result property of the response. The RequestID is needed when sending along the associateed MOU and/or COI documents for the New Submitter Request. |+| 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. |
 | 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 submitterRequest 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 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.
  
  
Line 65: Line 56:
 **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/updateCOIRequest?RequestID=0&COIExpirationDate=12/25/2024&SubmitterID=1234</nowiki>
  
  
Line 86: Line 77:
 <code json> <code json>
 { {
-    "result": "15"+    "result": "35"
 } }
 </code> </code>
Line 99: Line 90:
 { {
     "Exception": {     "Exception": {
-        "Code": "SubmitterRequestExists", +        "Code": "SubmitterNotFound", 
-        "Message": "12|EXAMPLE PRIMARY NAME|EXAMPLE CITY, CA|EXAMPLE AGENT"+        "Message": "SUBMITTER ID 1234 is not found or does not belong to the requesting organization."
     }     }
 } }
Line 113: Line 104:
 **Comment 1:** **Comment 1:**
  
-The submitterRequest web service is the first step in a New Submitter Request **workflow** as documented in the following C# snippet.+The updateCOIRequest web service is the first step in an Update COI Request **workflow** as documented in the following C# snippet.
  
  
-{{page>[:guides:sample_submitterrequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}+{{page>[:guides:sample_updatecoirequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
 **Comment 2:** **Comment 2:**
  
-The following C# snippet shows how to login and call the submitterRequest 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 updateCOIRequest 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_submitterrequest_snippet&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}+{{page>[:guides:sample_updatecoirequest_snippet&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
Line 134: Line 125:
 **Comment 4:** **Comment 4:**
  
-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 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. 
guides/ws_updatecoirequest.1668039670.txt.gz · Last modified: by brett.zamora