DokuWiki

This is an old revision of the document!

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.

Request Endpoint

Method	URL
POST	https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/submitterRequest

Request Body

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

Request Headers

Key	Value
Content-Type	application/json
access_token	{soft-token}

Request Parameters

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.

JSON Response Parameters

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.

Sample Request

Endpoint:

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

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.

Sample Response

Status Code: 200

{
    "result": "15"
}

OR

Status Code: 500 (When an error occurs.)

(example 1)

{
    "Exception": {
        "Code": "SubmitterRequestExists",
        "Message": "12|EXAMPLE PRIMARY NAME|EXAMPLE CITY, CA|EXAMPLE AGENT"
    }
}

Additional Comments

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.

// The following strBase64DocValue value is retrieved from the DOCUMENT child node of the EMBEDDED_FILE node in the XML document.
 
string strBase64DocValue = " SUkqALLnAAAtVZDKI+R4jhk…";  // Get your Base64 string from the XML doc.
 
string strBase64HashValue = getBase64Hash(strBase64DocValue);  // Use this value in your web service call
 
public static string getBase64Hash(string strB64Source)
{
Encoding u8 = Encoding.UTF8; // We use UTF8 encoding
 
byte[] b64Bytes = u8.GetBytes(strB64Source); // Put the Document B64 string into a byte array
 
byte[] b64HashBytes = SHA384.Create().ComputeHash(b64Bytes);  // Compute the SHA384 hash
 
//Convert the SHA384 hash to a Base64 string
 
string strB64Value = System.Convert.ToBase64String(b64HashBytes, 0, b64HashBytes.Length); 
 
return strB64Value;
}

Comment 2: