API Method DirectAddressValidate
From Updox API
Contents |
Description
The following code samples describe the processes involved in "validating" a Direct address and discuss what happens behind the scenes with domain-level address validation and address-level validation.
Behind the Scenes
blah
Prerequisites
1 This API call requires Vendor-level credentials. The credentials should be populated into the applicationId and applicationPassword fields of the auth block:
{
...
"auth": {
"applicationId": "vendorId",
"applicationPassword": "vendorPassword",
"accountId": "",
"userId": ""
}
}
Code Samples
| Language | Source Code Examples |
|---|---|
| C# | public void TalkToUpdox() {
string json = new JavaScriptSerializer().Serialize(new {
recipient = "DrTom@DrTomsPractice.MyEHRDirect.com", // required
auth = new {
applicationId = "vendorId",
applicationPassword = "vendorPassword",
accountId = "",
userId = ""
}
});
string url = "https://updoxqa.com/io/directAddressValidate";
SendReceiveJSON(json, url);
}
private void SendReceiveJSON(string json, string url)
{
var httpWebRequest = WebRequest.Create(url);
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "POST";
using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
{
streamWriter.Write(json);
streamWriter.Flush();
streamWriter.Close();
var httpResponse = (HttpWebResponse) httpWebRequest.GetResponse();
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
var result = streamReader.ReadToEnd();
}
}
}
|
| Java |
public void TalkToUpdox() throws Exception {
String uri = "https://updoxqa.com/io/directAddressValidate";
ObjectMapper mapper = new ObjectMapper();
Map<String,Object> messageData = BuildMessage();
String jsonData = mapper.writeValueAsString(messageData);
HttpResponse httpResponse = SendReceiveJSON(jsonData, uri);
HttpEntity responseEntity = httpResponse.getEntity();
String response = EntityUtils.toString(responseEntity);
JsonNode actualObj = mapper.readTree(response);
System.out.println(actualObj.get("responseCode"));
System.out.println(actualObj.get("responseMessage"));
}
messageData.put("recipient", "DrTom@DrTomsPractice.MyEHRDirect.com");
private HttpResponse SendReceiveJSON(String jsonData, String uri) throws Exception {
HttpClient httpClient = new DefaultHttpClient();
HttpResponse response = null;
StringEntity params = new StringEntity(jsonData);
try {
HttpPost request = new HttpPost(uri);
request.addHeader("content-type", "application/json");
request.setEntity(params);
response = httpClient.execute(request);
} catch (Exception ex) {
// handle exception here
} finally {
httpClient.getConnectionManager().shutdown();
}
return response;
}
|
Messages
Destination Address
Request JSON
{
"recipient": "DrTom@DrTomsPractice.MyEHRDirect.com",
"auth": {
"applicationId": "vendorId",
"applicationPassword": "vendorPassword",
"accountId": "",
"userId": ""
}
}
HTTP Response Status
200 OK
Response JSON
{
"successful": true,
"responseMessage": "OK",
"responseCode": 2000,
"recipient": "contact:171099",
"name": "DrTom@DrTomsPractice.MyEHRDirect.com",
"directAddress": "DrTom@DrTomsPractice.MyEHRDirect.com",
"validDirectAddress": true,
"vettingRequired": false,
"reason": null
}
Relevant Response Codes
In addition to the General Error Set, this method may return the following values in the responseCode and responseMessage fields:
responseCode
|
responseMessage
|
|---|
