DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

==== Web Service: submitterRequest ====

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.)

Your user credentials allow the backend web service to ensure that your user request is properly assigned to your organzation.

<color #7092be>Request Endpoint</color>

{{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Method ^ URL ^
| POST | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/submitterRequest</nowiki> |

<color #7092be>Request Body</color>

This endpoint accepts request parameters using an text/plain format. (They are part of the endpoint URL)

<color #7092be>Request Headers</color>

{{tablelayout?colwidth="150px,450px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Key ^ Value ^
| Content-Type | application/json |
| access_token | {soft-token} |

<color #7092be>Request Parameters</color>

{{tablelayout?colwidth="150px,75px,100px,275px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Parm Name ^ Req/Opt ^ Format ^ Description ^
| 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) |
| PrimaryName | Required | [string] | This name must be unique by Submitter Name, City, State. Please provide name in uppercase. |
| 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. |

<color #7092be>JSON Response Parameters</color>

{{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}}
^ 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. |
| code | [string] | Exception conditions will result in code/message being returned. |
| 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.

<color #7092be>Sample Request</color>

**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>

**Headers:**

Content-Type: application/json

**Body:**

Body content is not required because the parameters are pass as text/plain content as part of the Endpoint URL.

<color #7092be>Sample Response</color>

Status Code: 200

<code json>
{
    "result": "15"
}
</code>

**OR**

Status Code: 500  (When an error occurs.)

<code json>
{
    "Exception": {
        "Code": "SubmitterRequestExists",
        "Message": "12|EXAMPLE PRIMARY NAME|EXAMPLE CITY, CA|EXAMPLE AGENT"
    }
}
</code>

<color #7092be>Additional Comments</color>

Comments and sample code are provided for reference purposes only and are not intended to show production quality code or all exception handling conditions and/or completed code blocks.

**Comment 1:**

The submitterRequest web service is the first step in a New Submitter Request **workflow** as documented in the following C# snippet.

{{page>[:guides:sample_submitterrequest_workflow&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}

**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.

{{page>[:guides:sample_submitterrequest_snippet&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International