Updox IO Docs API Documentation

PingActions

Ping /io/Ping

Ping the server for a response without any authentication

Try it! Toggle Notes/Code Samples

Ping

Ping the server for a response without any authentication

Prerequisites

This API call requires No Authentication .

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Ping {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Ping codeSample = new UpdoxCodeSample_Ping();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Ping";
			PingRequest pingRequest = new PingRequest();

			//set up credentials
			pingRequest.auth.applicationId = "applicationId";
			pingRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(pingRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "Ping", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PingResponse pingResponse = javascriptSerializer.Deserialize<PingResponse>(jsonResponse);

			Console.WriteLine(pingResponse.responseCode);
			Console.WriteLine(pingResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PingRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PingResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_Ping {

	public static void main(String[] args) {
		UpdoxCodeSample_Ping codeSample = new UpdoxCodeSample_Ping();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Ping";

		PingRequest pingRequest = new PingRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = pingRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(pingRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'Ping', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PingResponse pingResponse = mapper.readValue(jsonResponse, PingResponse.class);

		System.out.println(pingResponse.getResponseCode());
		System.out.println(pingResponse.getResponseMessage());
	}

	private class PingRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PingResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PingWithAccountAuth /io/PingWithAccountAuth

Ping the server for a response with application and account level authentication

Try it! Toggle Notes/Code Samples

PingWithAccountAuth

Ping the server for a response with application and account level authentication

Prerequisites

This API call requires Application Credentials and an Account Identifier . The credentials should be populated into the applicationId and applicationPassword fields, and the identifier should be populated into the accountId field of the auth block.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PingWithAccountAuth {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PingWithAccountAuth codeSample = new UpdoxCodeSample_PingWithAccountAuth();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PingWithAccountAuth";
			PingWithAccountAuthRequest pingWithAccountAuthRequest = new PingWithAccountAuthRequest();

			//set up credentials
			pingWithAccountAuthRequest.auth.applicationId = "applicationId";
			pingWithAccountAuthRequest.auth.applicationPassword = "applicationPassword";
			pingWithAccountAuthRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(pingWithAccountAuthRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PingWithAccountAuth", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PingWithAccountAuthResponse pingWithAccountAuthResponse = javascriptSerializer.Deserialize<PingWithAccountAuthResponse>(jsonResponse);

			Console.WriteLine(pingWithAccountAuthResponse.responseCode);
			Console.WriteLine(pingWithAccountAuthResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PingWithAccountAuthRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PingWithAccountAuthResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PingWithAccountAuth {

	public static void main(String[] args) {
		UpdoxCodeSample_PingWithAccountAuth codeSample = new UpdoxCodeSample_PingWithAccountAuth();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PingWithAccountAuth";

		PingWithAccountAuthRequest pingWithAccountAuthRequest = new PingWithAccountAuthRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = pingWithAccountAuthRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(pingWithAccountAuthRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PingWithAccountAuth', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PingWithAccountAuthResponse pingWithAccountAuthResponse = mapper.readValue(jsonResponse, PingWithAccountAuthResponse.class);

		System.out.println(pingWithAccountAuthResponse.getResponseCode());
		System.out.println(pingWithAccountAuthResponse.getResponseMessage());
	}

	private class PingWithAccountAuthRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PingWithAccountAuthResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PingWithApplicationAuth /io/PingWithApplicationAuth

Ping the server for a response with application level authentication

Try it! Toggle Notes/Code Samples

PingWithApplicationAuth

Ping the server for a response with application level authentication

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PingWithApplicationAuth {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PingWithApplicationAuth codeSample = new UpdoxCodeSample_PingWithApplicationAuth();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PingWithApplicationAuth";
			PingWithApplicationAuthRequest pingWithApplicationAuthRequest = new PingWithApplicationAuthRequest();

			//set up credentials
			pingWithApplicationAuthRequest.auth.applicationId = "applicationId";
			pingWithApplicationAuthRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(pingWithApplicationAuthRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PingWithApplicationAuth", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PingWithApplicationAuthResponse pingWithApplicationAuthResponse = javascriptSerializer.Deserialize<PingWithApplicationAuthResponse>(jsonResponse);

			Console.WriteLine(pingWithApplicationAuthResponse.responseCode);
			Console.WriteLine(pingWithApplicationAuthResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PingWithApplicationAuthRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PingWithApplicationAuthResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PingWithApplicationAuth {

	public static void main(String[] args) {
		UpdoxCodeSample_PingWithApplicationAuth codeSample = new UpdoxCodeSample_PingWithApplicationAuth();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PingWithApplicationAuth";

		PingWithApplicationAuthRequest pingWithApplicationAuthRequest = new PingWithApplicationAuthRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = pingWithApplicationAuthRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(pingWithApplicationAuthRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PingWithApplicationAuth', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PingWithApplicationAuthResponse pingWithApplicationAuthResponse = mapper.readValue(jsonResponse, PingWithApplicationAuthResponse.class);

		System.out.println(pingWithApplicationAuthResponse.getResponseCode());
		System.out.println(pingWithApplicationAuthResponse.getResponseMessage());
	}

	private class PingWithApplicationAuthRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PingWithApplicationAuthResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PingWithAuth /io/PingWithAuth

Ping the server for a response with full authentication

Try it! Toggle Notes/Code Samples

PingWithAuth

Ping the server for a response with full authentication

Prerequisites

This API call requires Application Credentials , and an Account Identifier, and a User Identifier . The credentials should be populated into the applicationId and applicationPassword fields, and the identifiers should be populated into the accountId and the userId fields of the auth block.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PingWithAuth {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PingWithAuth codeSample = new UpdoxCodeSample_PingWithAuth();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PingWithAuth";
			PingWithAuthRequest pingWithAuthRequest = new PingWithAuthRequest();

			//set up credentials
			pingWithAuthRequest.auth.applicationId = "applicationId";
			pingWithAuthRequest.auth.applicationPassword = "applicationPassword";
			pingWithAuthRequest.auth.accountId = "accountId";
			pingWithAuthRequest.auth.userId = "userId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(pingWithAuthRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PingWithAuth", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PingWithAuthResponse pingWithAuthResponse = javascriptSerializer.Deserialize<PingWithAuthResponse>(jsonResponse);

			Console.WriteLine(pingWithAuthResponse.responseCode);
			Console.WriteLine(pingWithAuthResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PingWithAuthRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PingWithAuthResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PingWithAuth {

	public static void main(String[] args) {
		UpdoxCodeSample_PingWithAuth codeSample = new UpdoxCodeSample_PingWithAuth();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PingWithAuth";

		PingWithAuthRequest pingWithAuthRequest = new PingWithAuthRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = pingWithAuthRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(pingWithAuthRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PingWithAuth', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PingWithAuthResponse pingWithAuthResponse = mapper.readValue(jsonResponse, PingWithAuthResponse.class);

		System.out.println(pingWithAuthResponse.getResponseCode());
		System.out.println(pingWithAuthResponse.getResponseMessage());
	}

	private class PingWithAuthRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PingWithAuthResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AddressBookActions

AddressBookList /io/AddressBookList

Get all contacts associated with the supplied Account ID

Outdated: A newer version of this endpoint is available.

Try it! Toggle Notes/Code Samples

AddressBookList

Get all contacts associated with the supplied Account ID

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AddressBookList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AddressBookList codeSample = new UpdoxCodeSample_AddressBookList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AddressBookList";
			AddressBookListRequest addressBookListRequest = new AddressBookListRequest();

			//set up credentials
			addressBookListRequest.auth.applicationId = "applicationId";
			addressBookListRequest.auth.applicationPassword = "applicationPassword";
			addressBookListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(addressBookListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AddressBookList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AddressBookListResponse addressBookListResponse = javascriptSerializer.Deserialize<AddressBookListResponse>(jsonResponse);

			Console.WriteLine(addressBookListResponse.responseCode);
			Console.WriteLine(addressBookListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AddressBookListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AddressBookListResponse : UpdoxResponse {
			public List<RecipientObject> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AddressBookList {

	public static void main(String[] args) {
		UpdoxCodeSample_AddressBookList codeSample = new UpdoxCodeSample_AddressBookList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AddressBookList";

		AddressBookListRequest addressBookListRequest = new AddressBookListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = addressBookListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(addressBookListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AddressBookList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AddressBookListResponse addressBookListResponse = mapper.readValue(jsonResponse, AddressBookListResponse.class);

		System.out.println(addressBookListResponse.getResponseCode());
		System.out.println(addressBookListResponse.getResponseMessage());
	}

	private class AddressBookListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AddressBookListResponse extends UpdoxResponse {
		private List<RecipientObject> results;


		public List<RecipientObject> getResults() {
			return results;
		}

		public void setResults(List<RecipientObject> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AddressBookList/1.1 /io/AddressBookList/1.1

Get all contacts associated with the supplied Account ID.

Changes from v1.0 to v1.1:

zip - renamed in response object to postal for better international address support
country - new field in response object that specifies the ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the contact

Try it! Toggle Notes/Code Samples

AddressBookList/1.1

Get all contacts associated with the supplied Account ID.

Changes from v1.0 to v1.1:

zip - renamed in response object to postal for better international address support
country - new field in response object that specifies the ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the contact

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AddressBookList1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AddressBookList1_1 codeSample = new UpdoxCodeSample_AddressBookList1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AddressBookList1_1";
			AddressBookList1_1Request addressBookList1_1Request = new AddressBookList1_1Request();

			//set up credentials
			addressBookList1_1Request.auth.applicationId = "applicationId";
			addressBookList1_1Request.auth.applicationPassword = "applicationPassword";
			addressBookList1_1Request.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(addressBookList1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AddressBookList/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AddressBookList1_1Response addressBookList1_1Response = javascriptSerializer.Deserialize<AddressBookList1_1Response>(jsonResponse);

			Console.WriteLine(addressBookList1_1Response.responseCode);
			Console.WriteLine(addressBookList1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class AddressBookList1_1Request : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class InternationalRecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string country { get; set;}
			public string postal { get; set;}
		}

		public class AddressBookList1_1Response : UpdoxResponse {
			public List<InternationalRecipientObject> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AddressBookList1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_AddressBookList1_1 codeSample = new UpdoxCodeSample_AddressBookList1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AddressBookList1_1";

		AddressBookList1_1Request addressBookList1_1Request = new AddressBookList1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = addressBookList1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(addressBookList1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AddressBookList/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AddressBookList1_1Response addressBookList1_1Response = mapper.readValue(jsonResponse, AddressBookList1_1Response.class);

		System.out.println(addressBookList1_1Response.getResponseCode());
		System.out.println(addressBookList1_1Response.getResponseMessage());
	}

	private class AddressBookList1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class InternationalRecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String country;
		private String postal;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}
	}

	private static class AddressBookList1_1Response extends UpdoxResponse {
		private List<InternationalRecipientObject> results;


		public List<InternationalRecipientObject> getResults() {
			return results;
		}

		public void setResults(List<InternationalRecipientObject> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AddressBookSearch /io/AddressBookSearch

Searches the practice-level address book based of the requested search criteria

Parameter	Type	Value	Description
criteria	String		Min length 2 characters. Max length 50 characters. This is required.

Try it! Toggle Notes/Code Samples

AddressBookSearch

Searches the practice-level address book based of the requested search criteria

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AddressBookSearch {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AddressBookSearch codeSample = new UpdoxCodeSample_AddressBookSearch();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AddressBookSearch";
			AddressBookSearchRequest addressBookSearchRequest = new AddressBookSearchRequest();

			//set up credentials
			addressBookSearchRequest.auth.applicationId = "applicationId";
			addressBookSearchRequest.auth.applicationPassword = "applicationPassword";
			addressBookSearchRequest.auth.accountId = "accountId";
			addressBookSearchRequest.auth.userId = "userId";

			//set up request specific parameters
			addressBookSearchRequest.criteria = "criteria";

			//create the request
			string json = Utilities.buildRequestJson(addressBookSearchRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AddressBookSearch", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AddressBookSearchResponse addressBookSearchResponse = javascriptSerializer.Deserialize<AddressBookSearchResponse>(jsonResponse);

			Console.WriteLine(addressBookSearchResponse.responseCode);
			Console.WriteLine(addressBookSearchResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AddressBookSearchRequest : UpdoxRequest {
			public string criteria { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AddressBookSearchResponse : UpdoxResponse {
			public List<RecipientObject> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AddressBookSearch {

	public static void main(String[] args) {
		UpdoxCodeSample_AddressBookSearch codeSample = new UpdoxCodeSample_AddressBookSearch();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AddressBookSearch";

		AddressBookSearchRequest addressBookSearchRequest = new AddressBookSearchRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = addressBookSearchRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		addressBookSearchRequest.setCriteria("criteria");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(addressBookSearchRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AddressBookSearch', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AddressBookSearchResponse addressBookSearchResponse = mapper.readValue(jsonResponse, AddressBookSearchResponse.class);

		System.out.println(addressBookSearchResponse.getResponseCode());
		System.out.println(addressBookSearchResponse.getResponseMessage());
	}

	private class AddressBookSearchRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String criteria;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getCriteria() {
			return criteria;
		}

		public void setCriteria(String criteria) {
			this.criteria = criteria;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AddressBookSearchResponse extends UpdoxResponse {
		private List<RecipientObject> results;


		public List<RecipientObject> getResults() {
			return results;
		}

		public void setResults(List<RecipientObject> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ContactCreate /io/ContactCreate

Create contact with supplied information

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	If present, must be a valid postal code. Max length 15 characters.
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactCreate

Create contact with supplied information

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactCreate codeSample = new UpdoxCodeSample_ContactCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactCreate";
			ContactCreateRequest contactCreateRequest = new ContactCreateRequest();

			//set up credentials
			contactCreateRequest.auth.applicationId = "applicationId";
			contactCreateRequest.auth.applicationPassword = "applicationPassword";
			contactCreateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			contactCreateRequest.recipient = "recipient";
			contactCreateRequest.firstName = "firstName";
			contactCreateRequest.middleName = "middleName";
			contactCreateRequest.lastName = "lastName";
			contactCreateRequest.businessName = "businessName";
			contactCreateRequest.gender = "gender";
			contactCreateRequest.address1 = "address1";
			contactCreateRequest.address2 = "address2";
			contactCreateRequest.city = "Dublin";
			contactCreateRequest.state = "OH";
			contactCreateRequest.postal = "postal";
			contactCreateRequest.emailAddress = "test@test.com";
			contactCreateRequest.active = true;
			contactCreateRequest.dob = 1971-02-03;
			contactCreateRequest.faxNbr = "faxNbr";
			contactCreateRequest.contactType = "contactType";
			contactCreateRequest.homePhone = "6148675309";
			contactCreateRequest.mobilPhone = "6148675309";
			contactCreateRequest.workPhone = "6148675309";
			contactCreateRequest.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactCreateResponse contactCreateResponse = javascriptSerializer.Deserialize<ContactCreateResponse>(jsonResponse);

			Console.WriteLine(contactCreateResponse.responseCode);
			Console.WriteLine(contactCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ContactCreateRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactCreateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactCreate codeSample = new UpdoxCodeSample_ContactCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactCreate";

		ContactCreateRequest contactCreateRequest = new ContactCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactCreateRequest.setRecipient("recipient");
		contactCreateRequest.setFirstName("firstName");
		contactCreateRequest.setMiddleName("middleName");
		contactCreateRequest.setLastName("lastName");
		contactCreateRequest.setBusinessName("businessName");
		contactCreateRequest.setGender("gender");
		contactCreateRequest.setAddress1("address1");
		contactCreateRequest.setAddress2("address2");
		contactCreateRequest.setCity("Dublin");
		contactCreateRequest.setState("OH");
		contactCreateRequest.setPostal("postal");
		contactCreateRequest.setEmailAddress("test@test.com");
		contactCreateRequest.setActive(true);
		contactCreateRequest.setDob(new Date("1971-02-03"));
		contactCreateRequest.setFaxNbr("faxNbr");
		contactCreateRequest.setContactType("contactType");
		contactCreateRequest.setHomePhone("6148675309");
		contactCreateRequest.setMobilPhone("6148675309");
		contactCreateRequest.setWorkPhone("6148675309");
		contactCreateRequest.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactCreateResponse contactCreateResponse = mapper.readValue(jsonResponse, ContactCreateResponse.class);

		System.out.println(contactCreateResponse.getResponseCode());
		System.out.println(contactCreateResponse.getResponseMessage());
	}

	private class ContactCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactCreateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4330`	`contact already exists`
`4070`	`Invalid recipient`

ContactCreate/1.1 /io/ContactCreate/1.1

Create contact with supplied information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	The contact's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The contact's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactCreate/1.1

Create contact with supplied information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactCreate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactCreate1_1 codeSample = new UpdoxCodeSample_ContactCreate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactCreate1_1";
			ContactCreate1_1Request contactCreate1_1Request = new ContactCreate1_1Request();

			//set up credentials
			contactCreate1_1Request.auth.applicationId = "applicationId";
			contactCreate1_1Request.auth.applicationPassword = "applicationPassword";
			contactCreate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			contactCreate1_1Request.recipient = "recipient";
			contactCreate1_1Request.firstName = "firstName";
			contactCreate1_1Request.middleName = "middleName";
			contactCreate1_1Request.lastName = "lastName";
			contactCreate1_1Request.businessName = "businessName";
			contactCreate1_1Request.gender = "gender";
			contactCreate1_1Request.address1 = "address1";
			contactCreate1_1Request.address2 = "address2";
			contactCreate1_1Request.city = "Dublin";
			contactCreate1_1Request.state = "OH";
			contactCreate1_1Request.postal = "postal";
			contactCreate1_1Request.country = "country";
			contactCreate1_1Request.emailAddress = "test@test.com";
			contactCreate1_1Request.active = true;
			contactCreate1_1Request.dob = 1971-02-03;
			contactCreate1_1Request.faxNbr = "faxNbr";
			contactCreate1_1Request.contactType = "contactType";
			contactCreate1_1Request.homePhone = "6148675309";
			contactCreate1_1Request.mobilPhone = "6148675309";
			contactCreate1_1Request.workPhone = "6148675309";
			contactCreate1_1Request.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactCreate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactCreate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactCreate1_1Response contactCreate1_1Response = javascriptSerializer.Deserialize<ContactCreate1_1Response>(jsonResponse);

			Console.WriteLine(contactCreate1_1Response.responseCode);
			Console.WriteLine(contactCreate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class ContactCreate1_1Request : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactCreate1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactCreate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactCreate1_1 codeSample = new UpdoxCodeSample_ContactCreate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactCreate1_1";

		ContactCreate1_1Request contactCreate1_1Request = new ContactCreate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactCreate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactCreate1_1Request.setRecipient("recipient");
		contactCreate1_1Request.setFirstName("firstName");
		contactCreate1_1Request.setMiddleName("middleName");
		contactCreate1_1Request.setLastName("lastName");
		contactCreate1_1Request.setBusinessName("businessName");
		contactCreate1_1Request.setGender("gender");
		contactCreate1_1Request.setAddress1("address1");
		contactCreate1_1Request.setAddress2("address2");
		contactCreate1_1Request.setCity("Dublin");
		contactCreate1_1Request.setState("OH");
		contactCreate1_1Request.setPostal("postal");
		contactCreate1_1Request.setCountry("country");
		contactCreate1_1Request.setEmailAddress("test@test.com");
		contactCreate1_1Request.setActive(true);
		contactCreate1_1Request.setDob(new Date("1971-02-03"));
		contactCreate1_1Request.setFaxNbr("faxNbr");
		contactCreate1_1Request.setContactType("contactType");
		contactCreate1_1Request.setHomePhone("6148675309");
		contactCreate1_1Request.setMobilPhone("6148675309");
		contactCreate1_1Request.setWorkPhone("6148675309");
		contactCreate1_1Request.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactCreate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactCreate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactCreate1_1Response contactCreate1_1Response = mapper.readValue(jsonResponse, ContactCreate1_1Response.class);

		System.out.println(contactCreate1_1Response.getResponseCode());
		System.out.println(contactCreate1_1Response.getResponseMessage());
	}

	private class ContactCreate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactCreate1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4330`	`contact already exists`
`4070`	`Invalid recipient`

ContactDelete /io/ContactDelete

Delete supplied contact

Parameter	Type	Value	Description
recipient	String		String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.

Try it! Toggle Notes/Code Samples

ContactDelete

Delete supplied contact

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactDelete {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactDelete codeSample = new UpdoxCodeSample_ContactDelete();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactDelete";
			ContactDeleteRequest contactDeleteRequest = new ContactDeleteRequest();

			//set up credentials
			contactDeleteRequest.auth.applicationId = "applicationId";
			contactDeleteRequest.auth.applicationPassword = "applicationPassword";
			contactDeleteRequest.auth.accountId = "accountId";

			//set up request specific parameters
			contactDeleteRequest.recipient = "recipient";

			//create the request
			string json = Utilities.buildRequestJson(contactDeleteRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactDelete", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactDeleteResponse contactDeleteResponse = javascriptSerializer.Deserialize<ContactDeleteResponse>(jsonResponse);

			Console.WriteLine(contactDeleteResponse.responseCode);
			Console.WriteLine(contactDeleteResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ContactDeleteRequest : UpdoxRequest {
			public string recipient { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class ContactDeleteResponse : UpdoxResponse {
			public List<RecipientObject> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ContactDelete {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactDelete codeSample = new UpdoxCodeSample_ContactDelete();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactDelete";

		ContactDeleteRequest contactDeleteRequest = new ContactDeleteRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactDeleteRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactDeleteRequest.setRecipient("recipient");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactDeleteRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactDelete', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactDeleteResponse contactDeleteResponse = mapper.readValue(jsonResponse, ContactDeleteResponse.class);

		System.out.println(contactDeleteResponse.getResponseCode());
		System.out.println(contactDeleteResponse.getResponseMessage());
	}

	private class ContactDeleteRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class ContactDeleteResponse extends UpdoxResponse {
		private List<RecipientObject> results;


		public List<RecipientObject> getResults() {
			return results;
		}

		public void setResults(List<RecipientObject> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ContactSave /io/ContactSave

Create or Save the supplied contact information

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	If present, must be a valid postal code. Max length 15 characters.
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactSave

Create or Save the supplied contact information

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactSave codeSample = new UpdoxCodeSample_ContactSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactSave";
			ContactSaveRequest contactSaveRequest = new ContactSaveRequest();

			//set up credentials
			contactSaveRequest.auth.applicationId = "applicationId";
			contactSaveRequest.auth.applicationPassword = "applicationPassword";
			contactSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			contactSaveRequest.recipient = "recipient";
			contactSaveRequest.firstName = "firstName";
			contactSaveRequest.middleName = "middleName";
			contactSaveRequest.lastName = "lastName";
			contactSaveRequest.businessName = "businessName";
			contactSaveRequest.gender = "gender";
			contactSaveRequest.address1 = "address1";
			contactSaveRequest.address2 = "address2";
			contactSaveRequest.city = "Dublin";
			contactSaveRequest.state = "OH";
			contactSaveRequest.postal = "postal";
			contactSaveRequest.emailAddress = "test@test.com";
			contactSaveRequest.active = true;
			contactSaveRequest.dob = 1971-02-03;
			contactSaveRequest.faxNbr = "faxNbr";
			contactSaveRequest.contactType = "contactType";
			contactSaveRequest.homePhone = "6148675309";
			contactSaveRequest.mobilPhone = "6148675309";
			contactSaveRequest.workPhone = "6148675309";
			contactSaveRequest.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactSaveResponse contactSaveResponse = javascriptSerializer.Deserialize<ContactSaveResponse>(jsonResponse);

			Console.WriteLine(contactSaveResponse.responseCode);
			Console.WriteLine(contactSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ContactSaveRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactSaveResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactSave {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactSave codeSample = new UpdoxCodeSample_ContactSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactSave";

		ContactSaveRequest contactSaveRequest = new ContactSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactSaveRequest.setRecipient("recipient");
		contactSaveRequest.setFirstName("firstName");
		contactSaveRequest.setMiddleName("middleName");
		contactSaveRequest.setLastName("lastName");
		contactSaveRequest.setBusinessName("businessName");
		contactSaveRequest.setGender("gender");
		contactSaveRequest.setAddress1("address1");
		contactSaveRequest.setAddress2("address2");
		contactSaveRequest.setCity("Dublin");
		contactSaveRequest.setState("OH");
		contactSaveRequest.setPostal("postal");
		contactSaveRequest.setEmailAddress("test@test.com");
		contactSaveRequest.setActive(true);
		contactSaveRequest.setDob(new Date("1971-02-03"));
		contactSaveRequest.setFaxNbr("faxNbr");
		contactSaveRequest.setContactType("contactType");
		contactSaveRequest.setHomePhone("6148675309");
		contactSaveRequest.setMobilPhone("6148675309");
		contactSaveRequest.setWorkPhone("6148675309");
		contactSaveRequest.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactSaveResponse contactSaveResponse = mapper.readValue(jsonResponse, ContactSaveResponse.class);

		System.out.println(contactSaveResponse.getResponseCode());
		System.out.println(contactSaveResponse.getResponseMessage());
	}

	private class ContactSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactSaveResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4070`	`Invalid recipient`

ContactSave/1.1 /io/ContactSave/1.1

Create or save the supplied contact information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	The contact's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The contact's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactSave/1.1

Create or save the supplied contact information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactSave1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactSave1_1 codeSample = new UpdoxCodeSample_ContactSave1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactSave1_1";
			ContactSave1_1Request contactSave1_1Request = new ContactSave1_1Request();

			//set up credentials
			contactSave1_1Request.auth.applicationId = "applicationId";
			contactSave1_1Request.auth.applicationPassword = "applicationPassword";
			contactSave1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			contactSave1_1Request.recipient = "recipient";
			contactSave1_1Request.firstName = "firstName";
			contactSave1_1Request.middleName = "middleName";
			contactSave1_1Request.lastName = "lastName";
			contactSave1_1Request.businessName = "businessName";
			contactSave1_1Request.gender = "gender";
			contactSave1_1Request.address1 = "address1";
			contactSave1_1Request.address2 = "address2";
			contactSave1_1Request.city = "Dublin";
			contactSave1_1Request.state = "OH";
			contactSave1_1Request.postal = "postal";
			contactSave1_1Request.country = "country";
			contactSave1_1Request.emailAddress = "test@test.com";
			contactSave1_1Request.active = true;
			contactSave1_1Request.dob = 1971-02-03;
			contactSave1_1Request.faxNbr = "faxNbr";
			contactSave1_1Request.contactType = "contactType";
			contactSave1_1Request.homePhone = "6148675309";
			contactSave1_1Request.mobilPhone = "6148675309";
			contactSave1_1Request.workPhone = "6148675309";
			contactSave1_1Request.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactSave1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactSave/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactSave1_1Response contactSave1_1Response = javascriptSerializer.Deserialize<ContactSave1_1Response>(jsonResponse);

			Console.WriteLine(contactSave1_1Response.responseCode);
			Console.WriteLine(contactSave1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class ContactSave1_1Request : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactSave1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactSave1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactSave1_1 codeSample = new UpdoxCodeSample_ContactSave1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactSave1_1";

		ContactSave1_1Request contactSave1_1Request = new ContactSave1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactSave1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactSave1_1Request.setRecipient("recipient");
		contactSave1_1Request.setFirstName("firstName");
		contactSave1_1Request.setMiddleName("middleName");
		contactSave1_1Request.setLastName("lastName");
		contactSave1_1Request.setBusinessName("businessName");
		contactSave1_1Request.setGender("gender");
		contactSave1_1Request.setAddress1("address1");
		contactSave1_1Request.setAddress2("address2");
		contactSave1_1Request.setCity("Dublin");
		contactSave1_1Request.setState("OH");
		contactSave1_1Request.setPostal("postal");
		contactSave1_1Request.setCountry("country");
		contactSave1_1Request.setEmailAddress("test@test.com");
		contactSave1_1Request.setActive(true);
		contactSave1_1Request.setDob(new Date("1971-02-03"));
		contactSave1_1Request.setFaxNbr("faxNbr");
		contactSave1_1Request.setContactType("contactType");
		contactSave1_1Request.setHomePhone("6148675309");
		contactSave1_1Request.setMobilPhone("6148675309");
		contactSave1_1Request.setWorkPhone("6148675309");
		contactSave1_1Request.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactSave1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactSave/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactSave1_1Response contactSave1_1Response = mapper.readValue(jsonResponse, ContactSave1_1Response.class);

		System.out.println(contactSave1_1Response.getResponseCode());
		System.out.println(contactSave1_1Response.getResponseMessage());
	}

	private class ContactSave1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactSave1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4070`	`Invalid recipient`

ContactUpdate /io/ContactUpdate

Update contact with supplied information

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	If present, must be a valid postal code. Max length 15 characters.
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactUpdate

Update contact with supplied information

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactUpdate codeSample = new UpdoxCodeSample_ContactUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactUpdate";
			ContactUpdateRequest contactUpdateRequest = new ContactUpdateRequest();

			//set up credentials
			contactUpdateRequest.auth.applicationId = "applicationId";
			contactUpdateRequest.auth.applicationPassword = "applicationPassword";
			contactUpdateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			contactUpdateRequest.recipient = "recipient";
			contactUpdateRequest.firstName = "firstName";
			contactUpdateRequest.middleName = "middleName";
			contactUpdateRequest.lastName = "lastName";
			contactUpdateRequest.businessName = "businessName";
			contactUpdateRequest.gender = "gender";
			contactUpdateRequest.address1 = "address1";
			contactUpdateRequest.address2 = "address2";
			contactUpdateRequest.city = "Dublin";
			contactUpdateRequest.state = "OH";
			contactUpdateRequest.postal = "postal";
			contactUpdateRequest.emailAddress = "test@test.com";
			contactUpdateRequest.active = true;
			contactUpdateRequest.dob = 1971-02-03;
			contactUpdateRequest.faxNbr = "faxNbr";
			contactUpdateRequest.contactType = "contactType";
			contactUpdateRequest.homePhone = "6148675309";
			contactUpdateRequest.mobilPhone = "6148675309";
			contactUpdateRequest.workPhone = "6148675309";
			contactUpdateRequest.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactUpdateResponse contactUpdateResponse = javascriptSerializer.Deserialize<ContactUpdateResponse>(jsonResponse);

			Console.WriteLine(contactUpdateResponse.responseCode);
			Console.WriteLine(contactUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ContactUpdateRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactUpdateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactUpdate codeSample = new UpdoxCodeSample_ContactUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactUpdate";

		ContactUpdateRequest contactUpdateRequest = new ContactUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactUpdateRequest.setRecipient("recipient");
		contactUpdateRequest.setFirstName("firstName");
		contactUpdateRequest.setMiddleName("middleName");
		contactUpdateRequest.setLastName("lastName");
		contactUpdateRequest.setBusinessName("businessName");
		contactUpdateRequest.setGender("gender");
		contactUpdateRequest.setAddress1("address1");
		contactUpdateRequest.setAddress2("address2");
		contactUpdateRequest.setCity("Dublin");
		contactUpdateRequest.setState("OH");
		contactUpdateRequest.setPostal("postal");
		contactUpdateRequest.setEmailAddress("test@test.com");
		contactUpdateRequest.setActive(true);
		contactUpdateRequest.setDob(new Date("1971-02-03"));
		contactUpdateRequest.setFaxNbr("faxNbr");
		contactUpdateRequest.setContactType("contactType");
		contactUpdateRequest.setHomePhone("6148675309");
		contactUpdateRequest.setMobilPhone("6148675309");
		contactUpdateRequest.setWorkPhone("6148675309");
		contactUpdateRequest.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactUpdateResponse contactUpdateResponse = mapper.readValue(jsonResponse, ContactUpdateResponse.class);

		System.out.println(contactUpdateResponse.getResponseCode());
		System.out.println(contactUpdateResponse.getResponseMessage());
	}

	private class ContactUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactUpdateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4331`	`contact does not exist`

ContactUpdate/1.1 /io/ContactUpdate/1.1

Update contact with supplied information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Parameter	Type	Description
recipient	String	String value for Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.
firstName	String	Min length 1 characters. Max length 50 characters.
middleName	String	Max length 50 characters.
lastName	String	Min length 1 characters. Max length 50 characters.
businessName	String	Min length 1 characters. Max length 100 characters.
gender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	The contact's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The contact's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
emailAddress	String	Min length 1 characters. Max length 255 characters.
active	Boolean	Active flag.
dob	Date	Format yyyy-mm-dd.
faxNbr	String	Min length 1 characters. Max length 20 characters.
contactType	String	If a patient, must be designated 'patient'. Min length 1 characters. Max length 32 characters.
homePhone	String	Min length 1 characters. Max length 20 characters.
mobilPhone	String	Min length 1 characters. Max length 20 characters.
workPhone	String	Min length 1 characters. Max length 20 characters.
workExt	String	Min length 1 characters. Max length 8 characters.

Try it! Toggle Notes/Code Samples

ContactUpdate/1.1

Update contact with supplied information.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the contact's address

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactUpdate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactUpdate1_1 codeSample = new UpdoxCodeSample_ContactUpdate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactUpdate1_1";
			ContactUpdate1_1Request contactUpdate1_1Request = new ContactUpdate1_1Request();

			//set up credentials
			contactUpdate1_1Request.auth.applicationId = "applicationId";
			contactUpdate1_1Request.auth.applicationPassword = "applicationPassword";
			contactUpdate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			contactUpdate1_1Request.recipient = "recipient";
			contactUpdate1_1Request.firstName = "firstName";
			contactUpdate1_1Request.middleName = "middleName";
			contactUpdate1_1Request.lastName = "lastName";
			contactUpdate1_1Request.businessName = "businessName";
			contactUpdate1_1Request.gender = "gender";
			contactUpdate1_1Request.address1 = "address1";
			contactUpdate1_1Request.address2 = "address2";
			contactUpdate1_1Request.city = "Dublin";
			contactUpdate1_1Request.state = "OH";
			contactUpdate1_1Request.postal = "postal";
			contactUpdate1_1Request.country = "country";
			contactUpdate1_1Request.emailAddress = "test@test.com";
			contactUpdate1_1Request.active = true;
			contactUpdate1_1Request.dob = 1971-02-03;
			contactUpdate1_1Request.faxNbr = "faxNbr";
			contactUpdate1_1Request.contactType = "contactType";
			contactUpdate1_1Request.homePhone = "6148675309";
			contactUpdate1_1Request.mobilPhone = "6148675309";
			contactUpdate1_1Request.workPhone = "6148675309";
			contactUpdate1_1Request.workExt = "workExt";

			//create the request
			string json = Utilities.buildRequestJson(contactUpdate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactUpdate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactUpdate1_1Response contactUpdate1_1Response = javascriptSerializer.Deserialize<ContactUpdate1_1Response>(jsonResponse);

			Console.WriteLine(contactUpdate1_1Response.responseCode);
			Console.WriteLine(contactUpdate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class ContactUpdate1_1Request : UpdoxRequest {
			public string recipient { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string gender { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string emailAddress { get; set;}
			public bool active { get; set;}
			public String dob { get; set;}
			public string faxNbr { get; set;}
			public string contactType { get; set;}
			public string homePhone { get; set;}
			public string mobilPhone { get; set;}
			public string workPhone { get; set;}
			public string workExt { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ContactUpdate1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Date;

public class UpdoxCodeSample_ContactUpdate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactUpdate1_1 codeSample = new UpdoxCodeSample_ContactUpdate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactUpdate1_1";

		ContactUpdate1_1Request contactUpdate1_1Request = new ContactUpdate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactUpdate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		contactUpdate1_1Request.setRecipient("recipient");
		contactUpdate1_1Request.setFirstName("firstName");
		contactUpdate1_1Request.setMiddleName("middleName");
		contactUpdate1_1Request.setLastName("lastName");
		contactUpdate1_1Request.setBusinessName("businessName");
		contactUpdate1_1Request.setGender("gender");
		contactUpdate1_1Request.setAddress1("address1");
		contactUpdate1_1Request.setAddress2("address2");
		contactUpdate1_1Request.setCity("Dublin");
		contactUpdate1_1Request.setState("OH");
		contactUpdate1_1Request.setPostal("postal");
		contactUpdate1_1Request.setCountry("country");
		contactUpdate1_1Request.setEmailAddress("test@test.com");
		contactUpdate1_1Request.setActive(true);
		contactUpdate1_1Request.setDob(new Date("1971-02-03"));
		contactUpdate1_1Request.setFaxNbr("faxNbr");
		contactUpdate1_1Request.setContactType("contactType");
		contactUpdate1_1Request.setHomePhone("6148675309");
		contactUpdate1_1Request.setMobilPhone("6148675309");
		contactUpdate1_1Request.setWorkPhone("6148675309");
		contactUpdate1_1Request.setWorkExt("workExt");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactUpdate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactUpdate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactUpdate1_1Response contactUpdate1_1Response = mapper.readValue(jsonResponse, ContactUpdate1_1Response.class);

		System.out.println(contactUpdate1_1Response.getResponseCode());
		System.out.println(contactUpdate1_1Response.getResponseMessage());
	}

	private class ContactUpdate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String businessName;
    	private String gender;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String emailAddress;
    	private boolean active;
    	private Date dob;
    	private String faxNbr;
    	private String contactType;
    	private String homePhone;
    	private String mobilPhone;
    	private String workPhone;
    	private String workExt;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Date getDob() {
			return dob;
		}

		public void setDob(Date dob) {
			this.dob = dob;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getMobilPhone() {
			return mobilPhone;
		}

		public void setMobilPhone(String mobilPhone) {
			this.mobilPhone = mobilPhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExt() {
			return workExt;
		}

		public void setWorkExt(String workExt) {
			this.workExt = workExt;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ContactUpdate1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4330`	`contact already exists`
`4070`	`Invalid recipient`

AppointmentActions

AppointmentCountGet /io/AppointmentCountGet

Get appointment counts within a date range (maximum of 92 days). If only one date is provided the range will be for that month, either from or to the date provided. If no date is provided the current month up until today will be retrieved.

Parameter	Type	Value	Description
fromDate	String		Get appointment counts from date, format yyyy-mm-dd.
toDate	String		Get appointment counts to date, format yyyy-mm-dd.

Try it! Toggle Notes/Code Samples

AppointmentCountGet

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentCountGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentCountGet codeSample = new UpdoxCodeSample_AppointmentCountGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentCountGet";
			AppointmentCountGetRequest appointmentCountGetRequest = new AppointmentCountGetRequest();

			//set up credentials
			appointmentCountGetRequest.auth.applicationId = "applicationId";
			appointmentCountGetRequest.auth.applicationPassword = "applicationPassword";
			appointmentCountGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			appointmentCountGetRequest.fromDate = "fromDate";
			appointmentCountGetRequest.toDate = "toDate";

			//create the request
			string json = Utilities.buildRequestJson(appointmentCountGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentCountGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentCountGetResponse appointmentCountGetResponse = javascriptSerializer.Deserialize<AppointmentCountGetResponse>(jsonResponse);

			Console.WriteLine(appointmentCountGetResponse.responseCode);
			Console.WriteLine(appointmentCountGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentCountGetRequest : UpdoxRequest {
			public string fromDate { get; set;}
			public string toDate { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AppointmentCountGetResult {
			public String fromDate { get; set;}
			public String toDate { get; set;}
			public int approved { get; set;}
			public int cancelled { get; set;}
			public int practiceHold { get; set;}
			public int patientHold { get; set;}
			public int scheduled { get; set;}
		}

		public class AppointmentCountGetResponse : UpdoxResponse {
			public AppointmentCountGetResult result { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import org.joda.time.LocalDate;

public class UpdoxCodeSample_AppointmentCountGet {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentCountGet codeSample = new UpdoxCodeSample_AppointmentCountGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentCountGet";

		AppointmentCountGetRequest appointmentCountGetRequest = new AppointmentCountGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentCountGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		appointmentCountGetRequest.setFromDate("fromDate");
		appointmentCountGetRequest.setToDate("toDate");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentCountGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentCountGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentCountGetResponse appointmentCountGetResponse = mapper.readValue(jsonResponse, AppointmentCountGetResponse.class);

		System.out.println(appointmentCountGetResponse.getResponseCode());
		System.out.println(appointmentCountGetResponse.getResponseMessage());
	}

	private class AppointmentCountGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDate;
    	private String toDate;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDate() {
			return fromDate;
		}

		public void setFromDate(String fromDate) {
			this.fromDate = fromDate;
		}

		public String getToDate() {
			return toDate;
		}

		public void setToDate(String toDate) {
			this.toDate = toDate;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AppointmentCountGetResult {
		private LocalDate fromDate;
		private LocalDate toDate;
		private Integer approved;
		private Integer cancelled;
		private Integer practiceHold;
		private Integer patientHold;
		private Integer scheduled;


		public LocalDate getFromDate() {
			return fromDate;
		}

		public void setFromDate(LocalDate fromDate) {
			this.fromDate = fromDate;
		}

		public LocalDate getToDate() {
			return toDate;
		}

		public void setToDate(LocalDate toDate) {
			this.toDate = toDate;
		}

		public Integer getApproved() {
			return approved;
		}

		public void setApproved(Integer approved) {
			this.approved = approved;
		}

		public Integer getCancelled() {
			return cancelled;
		}

		public void setCancelled(Integer cancelled) {
			this.cancelled = cancelled;
		}

		public Integer getPracticeHold() {
			return practiceHold;
		}

		public void setPracticeHold(Integer practiceHold) {
			this.practiceHold = practiceHold;
		}

		public Integer getPatientHold() {
			return patientHold;
		}

		public void setPatientHold(Integer patientHold) {
			this.patientHold = patientHold;
		}

		public Integer getScheduled() {
			return scheduled;
		}

		public void setScheduled(Integer scheduled) {
			this.scheduled = scheduled;
		}
	}

	private static class AppointmentCountGetResponse extends UpdoxResponse {
		private AppointmentCountGetResult result;


		public AppointmentCountGetResult getResult() {
			return result;
		}

		public void setResult(AppointmentCountGetResult result) {
			this.result = result;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4021`	`Invalid date format`

AppointmentStatusUpdate /io/AppointmentStatusUpdate

Update the status of an appointment

Parameter	Type	Value	Description
id	String		The unique ID of the appointment. This is required.
status	String		The status to update the appointment with. Must be one of the following values: confirmed, cancelled. This is required.

Try it! Toggle Notes/Code Samples

AppointmentStatusUpdate

Update the status of an appointment

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentStatusUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentStatusUpdate codeSample = new UpdoxCodeSample_AppointmentStatusUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentStatusUpdate";
			AppointmentStatusUpdateRequest appointmentStatusUpdateRequest = new AppointmentStatusUpdateRequest();

			//set up credentials
			appointmentStatusUpdateRequest.auth.applicationId = "applicationId";
			appointmentStatusUpdateRequest.auth.applicationPassword = "applicationPassword";
			appointmentStatusUpdateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			appointmentStatusUpdateRequest.id = "id";
			appointmentStatusUpdateRequest.status = "status";

			//create the request
			string json = Utilities.buildRequestJson(appointmentStatusUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentStatusUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentStatusUpdateResponse appointmentStatusUpdateResponse = javascriptSerializer.Deserialize<AppointmentStatusUpdateResponse>(jsonResponse);

			Console.WriteLine(appointmentStatusUpdateResponse.responseCode);
			Console.WriteLine(appointmentStatusUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentStatusUpdateRequest : UpdoxRequest {
			public string id { get; set;}
			public string status { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AppointmentStatusUpdateResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_AppointmentStatusUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentStatusUpdate codeSample = new UpdoxCodeSample_AppointmentStatusUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentStatusUpdate";

		AppointmentStatusUpdateRequest appointmentStatusUpdateRequest = new AppointmentStatusUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentStatusUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		appointmentStatusUpdateRequest.setId("id");
		appointmentStatusUpdateRequest.setStatus("status");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentStatusUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentStatusUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentStatusUpdateResponse appointmentStatusUpdateResponse = mapper.readValue(jsonResponse, AppointmentStatusUpdateResponse.class);

		System.out.println(appointmentStatusUpdateResponse.getResponseCode());
		System.out.println(appointmentStatusUpdateResponse.getResponseMessage());
	}

	private class AppointmentStatusUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String id;
    	private String status;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AppointmentStatusUpdateResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6210`	`at least one value must be provided`
`6213`	`record does not exist for ID`

AppointmentStatusesGetByDate /io/AppointmentStatusesGetByDate

Get statuses from a list of appointment IDs or date (range)

Parameter	Type	Value	Description
dateFrom	String		The appointment start date of the date range to return statuses. The value must be in the format yyyy-mm-dd. This is required.
dateTo	String		The appointment end date of the date range to return statuses. If not provided, defaults to end of day of dateFrom value. The value must be in the format yyyy-mm-dd.

Try it! Toggle Notes/Code Samples

AppointmentStatusesGetByDate

Get statuses from a list of appointment IDs or date (range)

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentStatusesGetByDate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentStatusesGetByDate codeSample = new UpdoxCodeSample_AppointmentStatusesGetByDate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentStatusesGetByDate";
			AppointmentStatusesGetByDateRequest appointmentStatusesGetByDateRequest = new AppointmentStatusesGetByDateRequest();

			//set up credentials
			appointmentStatusesGetByDateRequest.auth.applicationId = "applicationId";
			appointmentStatusesGetByDateRequest.auth.applicationPassword = "applicationPassword";
			appointmentStatusesGetByDateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			appointmentStatusesGetByDateRequest.dateFrom = "dateFrom";
			appointmentStatusesGetByDateRequest.dateTo = "dateTo";

			//create the request
			string json = Utilities.buildRequestJson(appointmentStatusesGetByDateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentStatusesGetByDate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentStatusesGetByDateResponse appointmentStatusesGetByDateResponse = javascriptSerializer.Deserialize<AppointmentStatusesGetByDateResponse>(jsonResponse);

			Console.WriteLine(appointmentStatusesGetByDateResponse.responseCode);
			Console.WriteLine(appointmentStatusesGetByDateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentStatusesGetByDateRequest : UpdoxRequest {
			public string dateFrom { get; set;}
			public string dateTo { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ApptReminderStatus {
			public long reminderId { get; set;}
			public string reminderStatus { get; set;}
			public string reminderStatusDate { get; set;}
			public string reminderType { get; set;}
		}

		public class AppointmentStatus {
			public long appointmentId { get; set;}
			public string externalAppointmentId { get; set;}
			public string appointmentStatus { get; set;}
			public List<ApptReminderStatus> reminders { get; set;}
		}

		public class AppointmentStatusesGetByDateResponse : UpdoxResponse {
			public List<AppointmentStatus> appointmentStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentStatusesGetByDate {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentStatusesGetByDate codeSample = new UpdoxCodeSample_AppointmentStatusesGetByDate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentStatusesGetByDate";

		AppointmentStatusesGetByDateRequest appointmentStatusesGetByDateRequest = new AppointmentStatusesGetByDateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentStatusesGetByDateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		appointmentStatusesGetByDateRequest.setDateFrom("dateFrom");
		appointmentStatusesGetByDateRequest.setDateTo("dateTo");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentStatusesGetByDateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentStatusesGetByDate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentStatusesGetByDateResponse appointmentStatusesGetByDateResponse = mapper.readValue(jsonResponse, AppointmentStatusesGetByDateResponse.class);

		System.out.println(appointmentStatusesGetByDateResponse.getResponseCode());
		System.out.println(appointmentStatusesGetByDateResponse.getResponseMessage());
	}

	private class AppointmentStatusesGetByDateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String dateFrom;
    	private String dateTo;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getDateFrom() {
			return dateFrom;
		}

		public void setDateFrom(String dateFrom) {
			this.dateFrom = dateFrom;
		}

		public String getDateTo() {
			return dateTo;
		}

		public void setDateTo(String dateTo) {
			this.dateTo = dateTo;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ApptReminderStatus {
		private long reminderId;
		private String reminderStatus;
		private String reminderStatusDate;
		private String reminderType;


		public long getReminderId() {
			return reminderId;
		}

		public void setReminderId(long reminderId) {
			this.reminderId = reminderId;
		}

		public String getReminderStatus() {
			return reminderStatus;
		}

		public void setReminderStatus(String reminderStatus) {
			this.reminderStatus = reminderStatus;
		}

		public String getReminderStatusDate() {
			return reminderStatusDate;
		}

		public void setReminderStatusDate(String reminderStatusDate) {
			this.reminderStatusDate = reminderStatusDate;
		}

		public String getReminderType() {
			return reminderType;
		}

		public void setReminderType(String reminderType) {
			this.reminderType = reminderType;
		}
	}

	private static class AppointmentStatus {
		private long appointmentId;
		private String externalAppointmentId;
		private String appointmentStatus;
		private List<ApptReminderStatus> reminders;


		public long getAppointmentId() {
			return appointmentId;
		}

		public void setAppointmentId(long appointmentId) {
			this.appointmentId = appointmentId;
		}

		public String getExternalAppointmentId() {
			return externalAppointmentId;
		}

		public void setExternalAppointmentId(String externalAppointmentId) {
			this.externalAppointmentId = externalAppointmentId;
		}

		public String getAppointmentStatus() {
			return appointmentStatus;
		}

		public void setAppointmentStatus(String appointmentStatus) {
			this.appointmentStatus = appointmentStatus;
		}

		public List<ApptReminderStatus> getReminders() {
			return reminders;
		}

		public void setReminders(List<ApptReminderStatus> reminders) {
			this.reminders = reminders;
		}
	}

	private static class AppointmentStatusesGetByDateResponse extends UpdoxResponse {
		private List<AppointmentStatus> appointmentStatuses;


		public List<AppointmentStatus> getAppointmentStatuses() {
			return appointmentStatuses;
		}

		public void setAppointmentStatuses(List<AppointmentStatus> appointmentStatuses) {
			this.appointmentStatuses = appointmentStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentStatusesGetByIds /io/AppointmentStatusesGetByIds

Get statuses from a list of appointment IDs

Parameter	Type	Value	Description
appointmentIds	List	add remove	The appointment IDs to get statuses from.

	String

Try it! Toggle Notes/Code Samples

AppointmentStatusesGetByIds

Get statuses from a list of appointment IDs

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentStatusesGetByIds {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentStatusesGetByIds codeSample = new UpdoxCodeSample_AppointmentStatusesGetByIds();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentStatusesGetByIds";
			AppointmentStatusesGetByIdsRequest appointmentStatusesGetByIdsRequest = new AppointmentStatusesGetByIdsRequest();

			//set up credentials
			appointmentStatusesGetByIdsRequest.auth.applicationId = "applicationId";
			appointmentStatusesGetByIdsRequest.auth.applicationPassword = "applicationPassword";
			appointmentStatusesGetByIdsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> appointmentIds = new List<string>();
			string appointmentIdsString = "appointmentIds";
			appointmentIds.Add(appointmentIdsString);
			appointmentStatusesGetByIdsRequest.appointmentIds = appointmentIds;

			//create the request
			string json = Utilities.buildRequestJson(appointmentStatusesGetByIdsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentStatusesGetByIds", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentStatusesGetByIdsResponse appointmentStatusesGetByIdsResponse = javascriptSerializer.Deserialize<AppointmentStatusesGetByIdsResponse>(jsonResponse);

			Console.WriteLine(appointmentStatusesGetByIdsResponse.responseCode);
			Console.WriteLine(appointmentStatusesGetByIdsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentStatusesGetByIdsRequest : UpdoxRequest {
			public List<string> appointmentIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ApptReminderStatus {
			public long reminderId { get; set;}
			public string reminderStatus { get; set;}
			public string reminderStatusDate { get; set;}
			public string reminderType { get; set;}
		}

		public class AppointmentStatus {
			public long appointmentId { get; set;}
			public string externalAppointmentId { get; set;}
			public string appointmentStatus { get; set;}
			public List<ApptReminderStatus> reminders { get; set;}
		}

		public class AppointmentStatusesGetByIdsResponse : UpdoxResponse {
			public List<AppointmentStatus> appointmentStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentStatusesGetByIds {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentStatusesGetByIds codeSample = new UpdoxCodeSample_AppointmentStatusesGetByIds();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentStatusesGetByIds";

		AppointmentStatusesGetByIdsRequest appointmentStatusesGetByIdsRequest = new AppointmentStatusesGetByIdsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentStatusesGetByIdsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> appointmentIds = new ArrayList<>();
		String appointmentIdsString = "appointmentIds";
		appointmentIds.add(appointmentIdsString);
		appointmentStatusesGetByIdsRequest.setAppointmentIds(appointmentIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentStatusesGetByIdsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentStatusesGetByIds', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentStatusesGetByIdsResponse appointmentStatusesGetByIdsResponse = mapper.readValue(jsonResponse, AppointmentStatusesGetByIdsResponse.class);

		System.out.println(appointmentStatusesGetByIdsResponse.getResponseCode());
		System.out.println(appointmentStatusesGetByIdsResponse.getResponseMessage());
	}

	private class AppointmentStatusesGetByIdsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> appointmentIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getAppointmentIds() {
			return appointmentIds;
		}

		public void setAppointmentIds(List<String> appointmentIds) {
			this.appointmentIds = appointmentIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ApptReminderStatus {
		private long reminderId;
		private String reminderStatus;
		private String reminderStatusDate;
		private String reminderType;


		public long getReminderId() {
			return reminderId;
		}

		public void setReminderId(long reminderId) {
			this.reminderId = reminderId;
		}

		public String getReminderStatus() {
			return reminderStatus;
		}

		public void setReminderStatus(String reminderStatus) {
			this.reminderStatus = reminderStatus;
		}

		public String getReminderStatusDate() {
			return reminderStatusDate;
		}

		public void setReminderStatusDate(String reminderStatusDate) {
			this.reminderStatusDate = reminderStatusDate;
		}

		public String getReminderType() {
			return reminderType;
		}

		public void setReminderType(String reminderType) {
			this.reminderType = reminderType;
		}
	}

	private static class AppointmentStatus {
		private long appointmentId;
		private String externalAppointmentId;
		private String appointmentStatus;
		private List<ApptReminderStatus> reminders;


		public long getAppointmentId() {
			return appointmentId;
		}

		public void setAppointmentId(long appointmentId) {
			this.appointmentId = appointmentId;
		}

		public String getExternalAppointmentId() {
			return externalAppointmentId;
		}

		public void setExternalAppointmentId(String externalAppointmentId) {
			this.externalAppointmentId = externalAppointmentId;
		}

		public String getAppointmentStatus() {
			return appointmentStatus;
		}

		public void setAppointmentStatus(String appointmentStatus) {
			this.appointmentStatus = appointmentStatus;
		}

		public List<ApptReminderStatus> getReminders() {
			return reminders;
		}

		public void setReminders(List<ApptReminderStatus> reminders) {
			this.reminders = reminders;
		}
	}

	private static class AppointmentStatusesGetByIdsResponse extends UpdoxResponse {
		private List<AppointmentStatus> appointmentStatuses;


		public List<AppointmentStatus> getAppointmentStatuses() {
			return appointmentStatuses;
		}

		public void setAppointmentStatuses(List<AppointmentStatus> appointmentStatuses) {
			this.appointmentStatuses = appointmentStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6212`	`at least one id must be specified for the request`

AppointmentTypesDelete /io/AppointmentTypesDelete

Delete existing Updox appointment types by their Updox appointment type ID, returning those IDs that were successfully deleted/deactivated.

Parameter	Type	Value	Description
apptTypeIds	List	add remove	JSON List of Updox appointment type IDs which are returned in `AppointmentTypeSave` API.

	Long

Try it! Toggle Notes/Code Samples

AppointmentTypesDelete

Delete existing Updox appointment types by their Updox appointment type ID, returning those IDs that were successfully deleted/deactivated.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentTypesDelete {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentTypesDelete codeSample = new UpdoxCodeSample_AppointmentTypesDelete();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentTypesDelete";
			AppointmentTypesDeleteRequest appointmentTypesDeleteRequest = new AppointmentTypesDeleteRequest();

			//set up credentials
			appointmentTypesDeleteRequest.auth.applicationId = "applicationId";
			appointmentTypesDeleteRequest.auth.applicationPassword = "applicationPassword";
			appointmentTypesDeleteRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<long> apptTypeIds = new List<long>();
			long apptTypeIdsLong = 1L;
			apptTypeIds.Add(apptTypeIdsLong);
			appointmentTypesDeleteRequest.apptTypeIds = apptTypeIds;

			//create the request
			string json = Utilities.buildRequestJson(appointmentTypesDeleteRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentTypesDelete", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentTypesDeleteResponse appointmentTypesDeleteResponse = javascriptSerializer.Deserialize<AppointmentTypesDeleteResponse>(jsonResponse);

			Console.WriteLine(appointmentTypesDeleteResponse.responseCode);
			Console.WriteLine(appointmentTypesDeleteResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentTypesDeleteRequest : UpdoxRequest {
			public List<long> apptTypeIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AppointmentTypesDeleteResponse : UpdoxResponse {
			public List<long> inactiveIds { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentTypesDelete {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentTypesDelete codeSample = new UpdoxCodeSample_AppointmentTypesDelete();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentTypesDelete";

		AppointmentTypesDeleteRequest appointmentTypesDeleteRequest = new AppointmentTypesDeleteRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentTypesDeleteRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<Long> apptTypeIds = new ArrayList<>();
		Long apptTypeIdsLong = 1L;
		apptTypeIds.add(apptTypeIdsLong);
		appointmentTypesDeleteRequest.setApptTypeIds(apptTypeIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentTypesDeleteRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentTypesDelete', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentTypesDeleteResponse appointmentTypesDeleteResponse = mapper.readValue(jsonResponse, AppointmentTypesDeleteResponse.class);

		System.out.println(appointmentTypesDeleteResponse.getResponseCode());
		System.out.println(appointmentTypesDeleteResponse.getResponseMessage());
	}

	private class AppointmentTypesDeleteRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<Long> apptTypeIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<Long> getApptTypeIds() {
			return apptTypeIds;
		}

		public void setApptTypeIds(List<Long> apptTypeIds) {
			this.apptTypeIds = apptTypeIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AppointmentTypesDeleteResponse extends UpdoxResponse {
		private List<Long> inactiveIds;


		public List<Long> getInactiveIds() {
			return inactiveIds;
		}

		public void setInactiveIds(List<Long> inactiveIds) {
			this.inactiveIds = inactiveIds;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentTypesRetrieve /io/AppointmentTypesRetrieve

Returns a list of the current appointment types made available by the provider.

Parameter	Type	Value	Description
showInactive	Boolean

Try it! Toggle Notes/Code Samples

AppointmentTypesRetrieve

Returns a list of the current appointment types made available by the provider.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentTypesRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentTypesRetrieve codeSample = new UpdoxCodeSample_AppointmentTypesRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentTypesRetrieve";
			AppointmentTypesRetrieveRequest appointmentTypesRetrieveRequest = new AppointmentTypesRetrieveRequest();

			//set up credentials
			appointmentTypesRetrieveRequest.auth.applicationId = "applicationId";
			appointmentTypesRetrieveRequest.auth.applicationPassword = "applicationPassword";
			appointmentTypesRetrieveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			appointmentTypesRetrieveRequest.showInactive = true;

			//create the request
			string json = Utilities.buildRequestJson(appointmentTypesRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentTypesRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentTypesRetrieveResponse appointmentTypesRetrieveResponse = javascriptSerializer.Deserialize<AppointmentTypesRetrieveResponse>(jsonResponse);

			Console.WriteLine(appointmentTypesRetrieveResponse.responseCode);
			Console.WriteLine(appointmentTypesRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AppointmentTypesRetrieveRequest : UpdoxRequest {
			public bool showInactive { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AppointmentType {
			public bool dEFAULT_REMINDER_TURN_OFF_STATE { get; set;}
			public long id { get; set;}
			public long pid { get; set;}
			public string externalId { get; set;}
			public string summary { get; set;}
			public long apptDuration { get; set;}
			public bool publick { get; set;}
			public bool active { get; set;}
			public bool reminderTurnOff { get; set;}
		}

		public class AppointmentTypesRetrieveResponse : UpdoxResponse {
			public List<AppointmentType> apptTypes { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentTypesRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentTypesRetrieve codeSample = new UpdoxCodeSample_AppointmentTypesRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentTypesRetrieve";

		AppointmentTypesRetrieveRequest appointmentTypesRetrieveRequest = new AppointmentTypesRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentTypesRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		appointmentTypesRetrieveRequest.setShowInactive(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentTypesRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentTypesRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentTypesRetrieveResponse appointmentTypesRetrieveResponse = mapper.readValue(jsonResponse, AppointmentTypesRetrieveResponse.class);

		System.out.println(appointmentTypesRetrieveResponse.getResponseCode());
		System.out.println(appointmentTypesRetrieveResponse.getResponseMessage());
	}

	private class AppointmentTypesRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private boolean showInactive;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public boolean isShowInactive() {
			return showInactive;
		}

		public void setShowInactive(boolean showInactive) {
			this.showInactive = showInactive;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AppointmentType {
		private boolean dEFAULT_REMINDER_TURN_OFF_STATE;
		private long id;
		private long pid;
		private String externalId;
		private String summary;
		private long apptDuration;
		private boolean publick;
		private boolean active;
		private boolean reminderTurnOff;


		public boolean isDEFAULT_REMINDER_TURN_OFF_STATE() {
			return dEFAULT_REMINDER_TURN_OFF_STATE;
		}

		public void setDEFAULT_REMINDER_TURN_OFF_STATE(boolean dEFAULT_REMINDER_TURN_OFF_STATE) {
			this.dEFAULT_REMINDER_TURN_OFF_STATE = dEFAULT_REMINDER_TURN_OFF_STATE;
		}

		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public long getPid() {
			return pid;
		}

		public void setPid(long pid) {
			this.pid = pid;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getSummary() {
			return summary;
		}

		public void setSummary(String summary) {
			this.summary = summary;
		}

		public long getApptDuration() {
			return apptDuration;
		}

		public void setApptDuration(long apptDuration) {
			this.apptDuration = apptDuration;
		}

		public boolean isPublick() {
			return publick;
		}

		public void setPublick(boolean publick) {
			this.publick = publick;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}
	}

	private static class AppointmentTypesRetrieveResponse extends UpdoxResponse {
		private List<AppointmentType> apptTypes;


		public List<AppointmentType> getApptTypes() {
			return apptTypes;
		}

		public void setApptTypes(List<AppointmentType> apptTypes) {
			this.apptTypes = apptTypes;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentTypesSave /io/AppointmentTypesSave

Update existing AppointmentTypes and create new ones for those that we do not currently have. Returns a list of the newly created appointment types made available by the provider.

Parameter	Type	Value
appts	List	add remove

id	Long
pid	Long
externalId	String
summary	String
apptDuration	Long
publick	Boolean
active	Boolean
reminderTurnOff	Boolean

Try it! Toggle Notes/Code Samples

AppointmentTypesSave

Update existing AppointmentTypes and create new ones for those that we do not currently have. Returns a list of the newly created appointment types made available by the provider.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentTypesSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentTypesSave codeSample = new UpdoxCodeSample_AppointmentTypesSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentTypesSave";
			AppointmentTypesSaveRequest appointmentTypesSaveRequest = new AppointmentTypesSaveRequest();

			//set up credentials
			appointmentTypesSaveRequest.auth.applicationId = "applicationId";
			appointmentTypesSaveRequest.auth.applicationPassword = "applicationPassword";
			appointmentTypesSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalAppointmentTypeRecordBad> appts = new List<ExternalAppointmentTypeRecordBad>();
			ExternalAppointmentTypeRecordBad externalAppointmentTypeRecordBad = new ExternalAppointmentTypeRecordBad();
			externalAppointmentTypeRecordBad.id = 1L;
			externalAppointmentTypeRecordBad.pid = 1L;
			externalAppointmentTypeRecordBad.externalId = "externalId";
			externalAppointmentTypeRecordBad.summary = "summary";
			externalAppointmentTypeRecordBad.apptDuration = 1L;
			externalAppointmentTypeRecordBad.publick = true;
			externalAppointmentTypeRecordBad.active = true;
			externalAppointmentTypeRecordBad.reminderTurnOff = true;
			appts.Add(externalAppointmentTypeRecordBad);
			appointmentTypesSaveRequest.appts = appts;

			//create the request
			string json = Utilities.buildRequestJson(appointmentTypesSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentTypesSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentTypesSaveResponse appointmentTypesSaveResponse = javascriptSerializer.Deserialize<AppointmentTypesSaveResponse>(jsonResponse);

			Console.WriteLine(appointmentTypesSaveResponse.responseCode);
			Console.WriteLine(appointmentTypesSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalAppointmentTypeRecordBad {
			public long id { get; set;}
			public long pid { get; set;}
			public string externalId { get; set;}
			public string summary { get; set;}
			public long apptDuration { get; set;}
			public bool publick { get; set;}
			public bool active { get; set;}
			public bool reminderTurnOff { get; set;}
		}

		public class AppointmentTypesSaveRequest : UpdoxRequest {
			public List<ExternalAppointmentTypeRecordBad> appts { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AppointmentTypesSaveResponse : UpdoxResponse {
			public List<long> newlyCreatedIds { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentTypesSave {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentTypesSave codeSample = new UpdoxCodeSample_AppointmentTypesSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentTypesSave";

		AppointmentTypesSaveRequest appointmentTypesSaveRequest = new AppointmentTypesSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentTypesSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalAppointmentTypeRecordBad> appts = new ArrayList<>();
		ExternalAppointmentTypeRecordBad externalAppointmentTypeRecordBad = new ExternalAppointmentTypeRecordBad();
		externalAppointmentTypeRecordBad.setId(1L);
		externalAppointmentTypeRecordBad.setPid(1L);
		externalAppointmentTypeRecordBad.setExternalId("externalId");
		externalAppointmentTypeRecordBad.setSummary("summary");
		externalAppointmentTypeRecordBad.setApptDuration(1L);
		externalAppointmentTypeRecordBad.setPublick(true);
		externalAppointmentTypeRecordBad.setActive(true);
		externalAppointmentTypeRecordBad.setReminderTurnOff(true);
		appts.add(externalAppointmentTypeRecordBad);
		appointmentTypesSaveRequest.setAppts(appts);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentTypesSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentTypesSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentTypesSaveResponse appointmentTypesSaveResponse = mapper.readValue(jsonResponse, AppointmentTypesSaveResponse.class);

		System.out.println(appointmentTypesSaveResponse.getResponseCode());
		System.out.println(appointmentTypesSaveResponse.getResponseMessage());
	}

	private static class ExternalAppointmentTypeRecordBad {
		private long id;
		private long pid;
		private String externalId;
		private String summary;
		private long apptDuration;
		private boolean publick;
		private boolean active;
		private boolean reminderTurnOff;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public long getPid() {
			return pid;
		}

		public void setPid(long pid) {
			this.pid = pid;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getSummary() {
			return summary;
		}

		public void setSummary(String summary) {
			this.summary = summary;
		}

		public long getApptDuration() {
			return apptDuration;
		}

		public void setApptDuration(long apptDuration) {
			this.apptDuration = apptDuration;
		}

		public boolean isPublick() {
			return publick;
		}

		public void setPublick(boolean publick) {
			this.publick = publick;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}
	}

	private class AppointmentTypesSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalAppointmentTypeRecordBad> appts;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalAppointmentTypeRecordBad> getAppts() {
			return appts;
		}

		public void setAppts(List<ExternalAppointmentTypeRecordBad> appts) {
			this.appts = appts;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AppointmentTypesSaveResponse extends UpdoxResponse {
		private List<Long> newlyCreatedIds;


		public List<Long> getNewlyCreatedIds() {
			return newlyCreatedIds;
		}

		public void setNewlyCreatedIds(List<Long> newlyCreatedIds) {
			this.newlyCreatedIds = newlyCreatedIds;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentTypesSync /io/AppointmentTypesSync

Creates or modifies one or more appointment types.

Parameter	Type	Value	Description
appointmentTypes	List	add remove	List of appointment types to sync. At least one is required.

id	String		The id of the appointment type. This is required.
updoxId	Long		The id of the appointment type in the Updox system. The value must be between 0 and 9223372036854775807.
summary	String		The summary of the appointment type. This is required.
duration	Int		The appointment type's duration, in minutes. The value must be between 0 and 2147483647.
publick	Boolean		Pass in true if the appointment type is public.
active	Boolean		Pass in true if the appointment type is active.
reminderTurnOff	Boolean		Pass in true to turn off reminders for this appointment type.

Try it! Toggle Notes/Code Samples

AppointmentTypesSync

Creates or modifies one or more appointment types.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentTypesSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentTypesSync codeSample = new UpdoxCodeSample_AppointmentTypesSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentTypesSync";
			AppointmentTypesSyncRequest appointmentTypesSyncRequest = new AppointmentTypesSyncRequest();

			//set up credentials
			appointmentTypesSyncRequest.auth.applicationId = "applicationId";
			appointmentTypesSyncRequest.auth.applicationPassword = "applicationPassword";
			appointmentTypesSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalAppointmentTypeRecord> appointmentTypes = new List<ExternalAppointmentTypeRecord>();
			ExternalAppointmentTypeRecord externalAppointmentTypeRecord = new ExternalAppointmentTypeRecord();
			externalAppointmentTypeRecord.id = "id";
			externalAppointmentTypeRecord.updoxId = 1L;
			externalAppointmentTypeRecord.summary = "summary";
			externalAppointmentTypeRecord.duration = 1;
			externalAppointmentTypeRecord.publick = true;
			externalAppointmentTypeRecord.active = true;
			externalAppointmentTypeRecord.reminderTurnOff = true;
			appointmentTypes.Add(externalAppointmentTypeRecord);
			appointmentTypesSyncRequest.appointmentTypes = appointmentTypes;

			//create the request
			string json = Utilities.buildRequestJson(appointmentTypesSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentTypesSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentTypesSyncResponse appointmentTypesSyncResponse = javascriptSerializer.Deserialize<AppointmentTypesSyncResponse>(jsonResponse);

			Console.WriteLine(appointmentTypesSyncResponse.responseCode);
			Console.WriteLine(appointmentTypesSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalAppointmentTypeRecord {
			public string id { get; set;}
			public long updoxId { get; set;}
			public string summary { get; set;}
			public int duration { get; set;}
			public bool publick { get; set;}
			public bool active { get; set;}
			public bool reminderTurnOff { get; set;}
		}

		public class AppointmentTypesSyncRequest : UpdoxRequest {
			public List<ExternalAppointmentTypeRecord> appointmentTypes { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class AppointmentTypesSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentTypesSync {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentTypesSync codeSample = new UpdoxCodeSample_AppointmentTypesSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentTypesSync";

		AppointmentTypesSyncRequest appointmentTypesSyncRequest = new AppointmentTypesSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentTypesSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalAppointmentTypeRecord> appointmentTypes = new ArrayList<>();
		ExternalAppointmentTypeRecord externalAppointmentTypeRecord = new ExternalAppointmentTypeRecord();
		externalAppointmentTypeRecord.setId("id");
		externalAppointmentTypeRecord.setUpdoxId(1L);
		externalAppointmentTypeRecord.setSummary("summary");
		externalAppointmentTypeRecord.setDuration(1);
		externalAppointmentTypeRecord.setPublick(true);
		externalAppointmentTypeRecord.setActive(true);
		externalAppointmentTypeRecord.setReminderTurnOff(true);
		appointmentTypes.add(externalAppointmentTypeRecord);
		appointmentTypesSyncRequest.setAppointmentTypes(appointmentTypes);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentTypesSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentTypesSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentTypesSyncResponse appointmentTypesSyncResponse = mapper.readValue(jsonResponse, AppointmentTypesSyncResponse.class);

		System.out.println(appointmentTypesSyncResponse.getResponseCode());
		System.out.println(appointmentTypesSyncResponse.getResponseMessage());
	}

	private static class ExternalAppointmentTypeRecord {
		private String id;
		private long updoxId;
		private String summary;
		private int duration;
		private boolean publick;
		private boolean active;
		private boolean reminderTurnOff;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(long updoxId) {
			this.updoxId = updoxId;
		}

		public String getSummary() {
			return summary;
		}

		public void setSummary(String summary) {
			this.summary = summary;
		}

		public int getDuration() {
			return duration;
		}

		public void setDuration(int duration) {
			this.duration = duration;
		}

		public boolean isPublick() {
			return publick;
		}

		public void setPublick(boolean publick) {
			this.publick = publick;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}
	}

	private class AppointmentTypesSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalAppointmentTypeRecord> appointmentTypes;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalAppointmentTypeRecord> getAppointmentTypes() {
			return appointmentTypes;
		}

		public void setAppointmentTypes(List<ExternalAppointmentTypeRecord> appointmentTypes) {
			this.appointmentTypes = appointmentTypes;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class AppointmentTypesSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentsSync /io/AppointmentsSync

Creates or modifies one or more patient appointments.

Parameter	Type	Value	Description
appointments	List	add remove

id	String		The id of the appointment (external id). This is required.
updoxId	Long		The id of the appointment in Updox system. This would typically be provided when an update was desired to an existing appointment and the external id was not known.
calendarId	String		The id of the calendar that this appointment will be associated with. This is required.
date	String		The datetime of the appointment, expected format is 'yyyy-mm-dd hh:mm'.
duration	Long		The duration of the appointment, in minutes.
patientId	String		The id of the patient that this appointment will be associated with.
typeId	String		The id of the type that this appointment belongs to.
summary	String		The summary of the appointment.
details	String		The extra details of the appointment.
blocked	Boolean		Pass in true if the appointment is actually a block time such as lunch break for the practice.
cancelled	Boolean		Pass in true if the appointment is cancelled.
locationId	String		The id of the location that this appointment is at.

Try it! Toggle Notes/Code Samples

AppointmentsSync

Creates or modifies one or more patient appointments.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

System will parse list of appointments and attempt to find existing records based on the id passed in. If no match is found and old id value is supplied, an additional check for that identifier will be performed prior to inserting a new record. If a match is not found, a new appointment is created with the information supplied.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentsSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentsSync codeSample = new UpdoxCodeSample_AppointmentsSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentsSync";
			AppointmentsSyncRequest appointmentsSyncRequest = new AppointmentsSyncRequest();

			//set up credentials
			appointmentsSyncRequest.auth.applicationId = "applicationId";
			appointmentsSyncRequest.auth.applicationPassword = "applicationPassword";
			appointmentsSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalAppointment> appointments = new List<ExternalAppointment>();
			ExternalAppointment externalAppointment = new ExternalAppointment();
			externalAppointment.id = "id";
			externalAppointment.updoxId = 1L;
			externalAppointment.calendarId = "calendarId";
			externalAppointment.date = "date";
			externalAppointment.duration = 1L;
			externalAppointment.patientId = "patientId";
			externalAppointment.typeId = "typeId";
			externalAppointment.summary = "summary";
			externalAppointment.details = "details";
			externalAppointment.blocked = true;
			externalAppointment.cancelled = true;
			externalAppointment.locationId = "locationId";
			appointments.Add(externalAppointment);
			appointmentsSyncRequest.appointments = appointments;

			//create the request
			string json = Utilities.buildRequestJson(appointmentsSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentsSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentsSyncResponse appointmentsSyncResponse = javascriptSerializer.Deserialize<AppointmentsSyncResponse>(jsonResponse);

			Console.WriteLine(appointmentsSyncResponse.responseCode);
			Console.WriteLine(appointmentsSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalAppointment {
			public string id { get; set;}
			public long updoxId { get; set;}
			public string calendarId { get; set;}
			public string date { get; set;}
			public long duration { get; set;}
			public string patientId { get; set;}
			public string typeId { get; set;}
			public string summary { get; set;}
			public string details { get; set;}
			public bool blocked { get; set;}
			public bool cancelled { get; set;}
			public string locationId { get; set;}
		}

		public class AppointmentsSyncRequest : UpdoxRequest {
			public List<ExternalAppointment> appointments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class AppointmentsSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentsSync {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentsSync codeSample = new UpdoxCodeSample_AppointmentsSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentsSync";

		AppointmentsSyncRequest appointmentsSyncRequest = new AppointmentsSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentsSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalAppointment> appointments = new ArrayList<>();
		ExternalAppointment externalAppointment = new ExternalAppointment();
		externalAppointment.setId("id");
		externalAppointment.setUpdoxId(1L);
		externalAppointment.setCalendarId("calendarId");
		externalAppointment.setDate("date");
		externalAppointment.setDuration(1L);
		externalAppointment.setPatientId("patientId");
		externalAppointment.setTypeId("typeId");
		externalAppointment.setSummary("summary");
		externalAppointment.setDetails("details");
		externalAppointment.setBlocked(true);
		externalAppointment.setCancelled(true);
		externalAppointment.setLocationId("locationId");
		appointments.add(externalAppointment);
		appointmentsSyncRequest.setAppointments(appointments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentsSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentsSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentsSyncResponse appointmentsSyncResponse = mapper.readValue(jsonResponse, AppointmentsSyncResponse.class);

		System.out.println(appointmentsSyncResponse.getResponseCode());
		System.out.println(appointmentsSyncResponse.getResponseMessage());
	}

	private static class ExternalAppointment {
		private String id;
		private long updoxId;
		private String calendarId;
		private String date;
		private long duration;
		private String patientId;
		private String typeId;
		private String summary;
		private String details;
		private boolean blocked;
		private boolean cancelled;
		private String locationId;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(long updoxId) {
			this.updoxId = updoxId;
		}

		public String getCalendarId() {
			return calendarId;
		}

		public void setCalendarId(String calendarId) {
			this.calendarId = calendarId;
		}

		public String getDate() {
			return date;
		}

		public void setDate(String date) {
			this.date = date;
		}

		public long getDuration() {
			return duration;
		}

		public void setDuration(long duration) {
			this.duration = duration;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getTypeId() {
			return typeId;
		}

		public void setTypeId(String typeId) {
			this.typeId = typeId;
		}

		public String getSummary() {
			return summary;
		}

		public void setSummary(String summary) {
			this.summary = summary;
		}

		public String getDetails() {
			return details;
		}

		public void setDetails(String details) {
			this.details = details;
		}

		public boolean isBlocked() {
			return blocked;
		}

		public void setBlocked(boolean blocked) {
			this.blocked = blocked;
		}

		public boolean isCancelled() {
			return cancelled;
		}

		public void setCancelled(boolean cancelled) {
			this.cancelled = cancelled;
		}

		public String getLocationId() {
			return locationId;
		}

		public void setLocationId(String locationId) {
			this.locationId = locationId;
		}
	}

	private class AppointmentsSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalAppointment> appointments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalAppointment> getAppointments() {
			return appointments;
		}

		public void setAppointments(List<ExternalAppointment> appointments) {
			this.appointments = appointments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class AppointmentsSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AppointmentsSync/1.1 /io/AppointmentsSync/1.1

Creates or modifies one or more patient appointments. Allows custom tokens for appointment reminders to be passed in

Outdated: As of April 2023, this API is a custom implementation that Updox is not currently expanding support for.

Parameter	Type	Value	Description
appointments	List	add remove

id	String		The id of the appointment (external id). This is required.
updoxId	Long		The id of the appointment in Updox system; this would typically be provided when an update to an existing appointment and the external id was not known.
calendarId	String		The id of the calendar that this appointment will be associated with. This is required.
date	String		The datetime of the appointment, expected format is 'yyyy-mm-dd hh:mm'. This is required.
duration	Long		The duration of the appointment in minutes.
patientId	String		The id of the patient that this appointment will be associated with.
typeId	String		The id of the type that this appointment belongs to.
summary	String		The summary of the appointment.
details	String		The extra details of the appointment.
blocked	Boolean		Pass in true if the appointment is actually a blocked time such as a lunch break for the practice.
cancelled	Boolean		Pass in true if the appointment is cancelled.
locationId	String		The id of the location that this appointment at.
reminderTokens	List	add remove	Custom tokens to be included in the reminders for this appointment.

key	String		The name of the token, must be one word, all lowercase without special characters. The maximum length is 32. This is required.
value	String		The value used to substitute the token in appointment reminders, should be consistent with the language preference. The maximum length is 1024. This is required.
language	String		The language that the token will be used in. Must be one of the following values: ENGLISH, SPANISH. This is required.

Try it! Toggle Notes/Code Samples

AppointmentsSync/1.1

Creates or modifies one or more patient appointments. Allows custom tokens for appointment reminders to be passed in

Outdated: As of April 2023, this API is a custom implementation that Updox is not currently expanding support for.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AppointmentsSync1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AppointmentsSync1_1 codeSample = new UpdoxCodeSample_AppointmentsSync1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AppointmentsSync1_1";
			AppointmentsSync1_1Request appointmentsSync1_1Request = new AppointmentsSync1_1Request();

			//set up credentials
			appointmentsSync1_1Request.auth.applicationId = "applicationId";
			appointmentsSync1_1Request.auth.applicationPassword = "applicationPassword";
			appointmentsSync1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			List<EmrReminderCustomTokenRequest> reminderTokens = new List<EmrReminderCustomTokenRequest>();
			EmrReminderCustomTokenRequest emrReminderCustomTokenRequest = new EmrReminderCustomTokenRequest();
			emrReminderCustomTokenRequest.key = "key";
			emrReminderCustomTokenRequest.value = "value";
			emrReminderCustomTokenRequest.language = "language";
			reminderTokens.Add(emrReminderCustomTokenRequest);
			List<EmrAppointmentWithCustomReminderTokensRequest> appointments = new List<EmrAppointmentWithCustomReminderTokensRequest>();
			EmrAppointmentWithCustomReminderTokensRequest emrAppointmentWithCustomReminderTokensRequest = new EmrAppointmentWithCustomReminderTokensRequest();
			emrAppointmentWithCustomReminderTokensRequest.id = "id";
			emrAppointmentWithCustomReminderTokensRequest.updoxId = 1L;
			emrAppointmentWithCustomReminderTokensRequest.calendarId = "calendarId";
			emrAppointmentWithCustomReminderTokensRequest.date = "date";
			emrAppointmentWithCustomReminderTokensRequest.duration = 1L;
			emrAppointmentWithCustomReminderTokensRequest.patientId = "patientId";
			emrAppointmentWithCustomReminderTokensRequest.typeId = "typeId";
			emrAppointmentWithCustomReminderTokensRequest.summary = "summary";
			emrAppointmentWithCustomReminderTokensRequest.details = "details";
			emrAppointmentWithCustomReminderTokensRequest.blocked = true;
			emrAppointmentWithCustomReminderTokensRequest.cancelled = true;
			emrAppointmentWithCustomReminderTokensRequest.locationId = "locationId";
			emrAppointmentWithCustomReminderTokensRequest.reminderTokens = reminderTokens;
			appointments.Add(emrAppointmentWithCustomReminderTokensRequest);
			appointmentsSync1_1Request.appointments = appointments;

			//create the request
			string json = Utilities.buildRequestJson(appointmentsSync1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AppointmentsSync/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AppointmentsSync1_1Response appointmentsSync1_1Response = javascriptSerializer.Deserialize<AppointmentsSync1_1Response>(jsonResponse);

			Console.WriteLine(appointmentsSync1_1Response.responseCode);
			Console.WriteLine(appointmentsSync1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EmrReminderCustomTokenRequest {
			public string key { get; set;}
			public string value { get; set;}
			public string language { get; set;}
		}

		public class EmrAppointmentWithCustomReminderTokensRequest {
			public string id { get; set;}
			public long updoxId { get; set;}
			public string calendarId { get; set;}
			public string date { get; set;}
			public long duration { get; set;}
			public string patientId { get; set;}
			public string typeId { get; set;}
			public string summary { get; set;}
			public string details { get; set;}
			public bool blocked { get; set;}
			public bool cancelled { get; set;}
			public string locationId { get; set;}
			public List<EmrReminderCustomTokenRequest> reminderTokens { get; set;}
		}

		public class AppointmentsSync1_1Request : UpdoxRequest {
			public List<EmrAppointmentWithCustomReminderTokensRequest> appointments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class AppointmentsSync1_1Response : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AppointmentsSync1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_AppointmentsSync1_1 codeSample = new UpdoxCodeSample_AppointmentsSync1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AppointmentsSync1_1";

		AppointmentsSync1_1Request appointmentsSync1_1Request = new AppointmentsSync1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = appointmentsSync1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<EmrReminderCustomTokenRequest> reminderTokens = new ArrayList<>();
		EmrReminderCustomTokenRequest emrReminderCustomTokenRequest = new EmrReminderCustomTokenRequest();
		emrReminderCustomTokenRequest.setKey("key");
		emrReminderCustomTokenRequest.setValue("value");
		emrReminderCustomTokenRequest.setLanguage("language");
		reminderTokens.add(emrReminderCustomTokenRequest);
	List<EmrAppointmentWithCustomReminderTokensRequest> appointments = new ArrayList<>();
		EmrAppointmentWithCustomReminderTokensRequest emrAppointmentWithCustomReminderTokensRequest = new EmrAppointmentWithCustomReminderTokensRequest();
		emrAppointmentWithCustomReminderTokensRequest.setId("id");
		emrAppointmentWithCustomReminderTokensRequest.setUpdoxId(1L);
		emrAppointmentWithCustomReminderTokensRequest.setCalendarId("calendarId");
		emrAppointmentWithCustomReminderTokensRequest.setDate("date");
		emrAppointmentWithCustomReminderTokensRequest.setDuration(1L);
		emrAppointmentWithCustomReminderTokensRequest.setPatientId("patientId");
		emrAppointmentWithCustomReminderTokensRequest.setTypeId("typeId");
		emrAppointmentWithCustomReminderTokensRequest.setSummary("summary");
		emrAppointmentWithCustomReminderTokensRequest.setDetails("details");
		emrAppointmentWithCustomReminderTokensRequest.setBlocked(true);
		emrAppointmentWithCustomReminderTokensRequest.setCancelled(true);
		emrAppointmentWithCustomReminderTokensRequest.setLocationId("locationId");
		emrAppointmentWithCustomReminderTokensRequest.setReminderTokens(reminderTokens);
		appointments.add(emrAppointmentWithCustomReminderTokensRequest);
		appointmentsSync1_1Request.setAppointments(appointments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(appointmentsSync1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AppointmentsSync/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AppointmentsSync1_1Response appointmentsSync1_1Response = mapper.readValue(jsonResponse, AppointmentsSync1_1Response.class);

		System.out.println(appointmentsSync1_1Response.getResponseCode());
		System.out.println(appointmentsSync1_1Response.getResponseMessage());
	}

	private static class EmrReminderCustomTokenRequest {
		private String key;
		private String value;
		private String language;


		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}

		public String getValue() {
			return value;
		}

		public void setValue(String value) {
			this.value = value;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}
	}

	private static class EmrAppointmentWithCustomReminderTokensRequest {
		private String id;
		private long updoxId;
		private String calendarId;
		private String date;
		private long duration;
		private String patientId;
		private String typeId;
		private String summary;
		private String details;
		private boolean blocked;
		private boolean cancelled;
		private String locationId;
		private List<EmrReminderCustomTokenRequest> reminderTokens;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(long updoxId) {
			this.updoxId = updoxId;
		}

		public String getCalendarId() {
			return calendarId;
		}

		public void setCalendarId(String calendarId) {
			this.calendarId = calendarId;
		}

		public String getDate() {
			return date;
		}

		public void setDate(String date) {
			this.date = date;
		}

		public long getDuration() {
			return duration;
		}

		public void setDuration(long duration) {
			this.duration = duration;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getTypeId() {
			return typeId;
		}

		public void setTypeId(String typeId) {
			this.typeId = typeId;
		}

		public String getSummary() {
			return summary;
		}

		public void setSummary(String summary) {
			this.summary = summary;
		}

		public String getDetails() {
			return details;
		}

		public void setDetails(String details) {
			this.details = details;
		}

		public boolean isBlocked() {
			return blocked;
		}

		public void setBlocked(boolean blocked) {
			this.blocked = blocked;
		}

		public boolean isCancelled() {
			return cancelled;
		}

		public void setCancelled(boolean cancelled) {
			this.cancelled = cancelled;
		}

		public String getLocationId() {
			return locationId;
		}

		public void setLocationId(String locationId) {
			this.locationId = locationId;
		}

		public List<EmrReminderCustomTokenRequest> getReminderTokens() {
			return reminderTokens;
		}

		public void setReminderTokens(List<EmrReminderCustomTokenRequest> reminderTokens) {
			this.reminderTokens = reminderTokens;
		}
	}

	private class AppointmentsSync1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<EmrAppointmentWithCustomReminderTokensRequest> appointments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<EmrAppointmentWithCustomReminderTokensRequest> getAppointments() {
			return appointments;
		}

		public void setAppointments(List<EmrAppointmentWithCustomReminderTokensRequest> appointments) {
			this.appointments = appointments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class AppointmentsSync1_1Response extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ReminderConfig /io/ReminderConfig

Save reminder configurations for a practice

Parameter	Type	Value	Description
reminderConfigs	List	add remove	List of reminder rules to sync. Maximum number of reminder rules is three. It is not allowed to have multiple reminders at the same time before appointment.

reminderMethod	String		The method a reminder will be delivered by. This is required.
minutesBeforeAppt	Int		The time before appointment in minutes that a reminder will be delivered at. Must be positive number. This is required.
templateId	Long		The id of the template which will be used to deliver a reminder. Must be positive number. This is required.

Try it! Toggle Notes/Code Samples

ReminderConfig

Save reminder configurations for a practice

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ReminderConfig {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ReminderConfig codeSample = new UpdoxCodeSample_ReminderConfig();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ReminderConfig";
			ReminderConfigRequest reminderConfigRequest = new ReminderConfigRequest();

			//set up credentials
			reminderConfigRequest.auth.applicationId = "applicationId";
			reminderConfigRequest.auth.applicationPassword = "applicationPassword";
			reminderConfigRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ReminderConfigRule> reminderConfigs = new List<ReminderConfigRule>();
			ReminderConfigRule reminderConfigRule = new ReminderConfigRule();
			reminderConfigRule.reminderMethod = "reminderMethod";
			reminderConfigRule.minutesBeforeAppt = 1;
			reminderConfigRule.templateId = 1L;
			reminderConfigs.Add(reminderConfigRule);
			reminderConfigRequest.reminderConfigs = reminderConfigs;

			//create the request
			string json = Utilities.buildRequestJson(reminderConfigRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ReminderConfig", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ReminderConfigResponse reminderConfigResponse = javascriptSerializer.Deserialize<ReminderConfigResponse>(jsonResponse);

			Console.WriteLine(reminderConfigResponse.responseCode);
			Console.WriteLine(reminderConfigResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ReminderConfigRule {
			public string reminderMethod { get; set;}
			public int minutesBeforeAppt { get; set;}
			public long templateId { get; set;}
		}

		public class ReminderConfigRequest : UpdoxRequest {
			public List<ReminderConfigRule> reminderConfigs { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class ReminderConfigResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ReminderConfig {

	public static void main(String[] args) {
		UpdoxCodeSample_ReminderConfig codeSample = new UpdoxCodeSample_ReminderConfig();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ReminderConfig";

		ReminderConfigRequest reminderConfigRequest = new ReminderConfigRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = reminderConfigRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ReminderConfigRule> reminderConfigs = new ArrayList<>();
		ReminderConfigRule reminderConfigRule = new ReminderConfigRule();
		reminderConfigRule.setReminderMethod("reminderMethod");
		reminderConfigRule.setMinutesBeforeAppt(1);
		reminderConfigRule.setTemplateId(1L);
		reminderConfigs.add(reminderConfigRule);
		reminderConfigRequest.setReminderConfigs(reminderConfigs);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(reminderConfigRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ReminderConfig', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ReminderConfigResponse reminderConfigResponse = mapper.readValue(jsonResponse, ReminderConfigResponse.class);

		System.out.println(reminderConfigResponse.getResponseCode());
		System.out.println(reminderConfigResponse.getResponseMessage());
	}

	private static class ReminderConfigRule {
		private String reminderMethod;
		private int minutesBeforeAppt;
		private long templateId;


		public String getReminderMethod() {
			return reminderMethod;
		}

		public void setReminderMethod(String reminderMethod) {
			this.reminderMethod = reminderMethod;
		}

		public int getMinutesBeforeAppt() {
			return minutesBeforeAppt;
		}

		public void setMinutesBeforeAppt(int minutesBeforeAppt) {
			this.minutesBeforeAppt = minutesBeforeAppt;
		}

		public long getTemplateId() {
			return templateId;
		}

		public void setTemplateId(long templateId) {
			this.templateId = templateId;
		}
	}

	private class ReminderConfigRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ReminderConfigRule> reminderConfigs;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ReminderConfigRule> getReminderConfigs() {
			return reminderConfigs;
		}

		public void setReminderConfigs(List<ReminderConfigRule> reminderConfigs) {
			this.reminderConfigs = reminderConfigs;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ReminderConfigResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

RetrieveReminderHistoryStatus /io/RetrieveReminderHistoryStatus

Retrieve the reminder history status lines for an account, that were created between fromDatetime and toDatetime. The time period will be evaluated against the reminder history status createdAt DTTM available in the response. The time period must be between 1 minute and 24 hours and must conform to the ISO-8601 "yyyy-MM-DDTHH:mm:ssZ" (ex: "2022-05-20T17:30:00Z"). All times in the request and response JSON are UTC / ZULU. The response object's fields are detailed in the "Notes/Code Samples" below.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
fromDatetime	String		From date/time being requested, format is ISO-8601. This is required.
toDatetime	String		To date/time being requested, format is ISO-8601. This is required.

Try it! Toggle Notes/Code Samples

RetrieveReminderHistoryStatus

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Response object includes a list of lines with each line composed of:

appointmentId - non-nullable string - The application's appointmentId the reminder is for from IntegrationActions -> AppointmentsSync -> id
patientId - non-nullable string - The application's patientId the reminder is for from IntegrationActions -> PatientsSync -> id
updoxReminderId - non-nullable uint64 - The Updox created reminderId which uniquely references a reminder record (N of these records per appointmentId)
updoxReminderHistoryId - non-nullable uint64 - The Updox created reminderHistoryId which uniquely references a reminder history record (N of these records per updoxReminderId)
type - non-nullable string - The reminder type being sent, one of Email, Telephone-Home, Telephone-Cell, Text Message, and No Reminder
createdAt - non-nullable instant - The time the record happened at, format ISO-8601
sentAt - nullable instant - The time at which the reminder was sent to the patient, format ISO-8601
repliedAt - nullable instant - The time at which the reminder was replied to by the patient, format ISO-8601
reminderStatus - nullable string - The status description for the reminder (ex: "sent", "confirmed", etc.)
reminderStatusReason - nullable string - The status reason description for the reminder (ex: "Text reminder successfully delivered to destination", "Patient replied to confirm this appointment", etc.)

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_RetrieveReminderHistoryStatus {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_RetrieveReminderHistoryStatus codeSample = new UpdoxCodeSample_RetrieveReminderHistoryStatus();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "RetrieveReminderHistoryStatus";
			RetrieveReminderHistoryStatusRequest retrieveReminderHistoryStatusRequest = new RetrieveReminderHistoryStatusRequest();

			//set up credentials
			retrieveReminderHistoryStatusRequest.auth.applicationId = "applicationId";
			retrieveReminderHistoryStatusRequest.auth.applicationPassword = "applicationPassword";
			retrieveReminderHistoryStatusRequest.auth.accountId = "accountId";

			//set up request specific parameters
			retrieveReminderHistoryStatusRequest.fromDatetime = "fromDatetime";
			retrieveReminderHistoryStatusRequest.toDatetime = "toDatetime";

			//create the request
			string json = Utilities.buildRequestJson(retrieveReminderHistoryStatusRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "RetrieveReminderHistoryStatus", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			RetrieveReminderHistoryStatusResponse retrieveReminderHistoryStatusResponse = javascriptSerializer.Deserialize<RetrieveReminderHistoryStatusResponse>(jsonResponse);

			Console.WriteLine(retrieveReminderHistoryStatusResponse.responseCode);
			Console.WriteLine(retrieveReminderHistoryStatusResponse.responseMessage);

			Environment.Exit (0);
		}


		public class RetrieveReminderHistoryStatusRequest : UpdoxRequest {
			public string fromDatetime { get; set;}
			public string toDatetime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveReminderHistoryStatusLine {
			public string appointmentExternalId { get; set;}
			public string patientExternalId { get; set;}
			public long updoxReminderId { get; set;}
			public long updoxReminderHistoryId { get; set;}
			public string reminderType { get; set;}
			public Instant createdAt { get; set;}
			public Instant sentAt { get; set;}
			public Instant repliedAt { get; set;}
			public string reminderStatus { get; set;}
			public string reminderStatusReason { get; set;}
		}

		public class RetrieveReminderHistoryStatusResponse : UpdoxResponse {
			public List<RetrieveReminderHistoryStatusLine> lines { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_RetrieveReminderHistoryStatus {

	public static void main(String[] args) {
		UpdoxCodeSample_RetrieveReminderHistoryStatus codeSample = new UpdoxCodeSample_RetrieveReminderHistoryStatus();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "RetrieveReminderHistoryStatus";

		RetrieveReminderHistoryStatusRequest retrieveReminderHistoryStatusRequest = new RetrieveReminderHistoryStatusRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = retrieveReminderHistoryStatusRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		retrieveReminderHistoryStatusRequest.setFromDatetime("fromDatetime");
		retrieveReminderHistoryStatusRequest.setToDatetime("toDatetime");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(retrieveReminderHistoryStatusRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'RetrieveReminderHistoryStatus', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		RetrieveReminderHistoryStatusResponse retrieveReminderHistoryStatusResponse = mapper.readValue(jsonResponse, RetrieveReminderHistoryStatusResponse.class);

		System.out.println(retrieveReminderHistoryStatusResponse.getResponseCode());
		System.out.println(retrieveReminderHistoryStatusResponse.getResponseMessage());
	}

	private class RetrieveReminderHistoryStatusRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDatetime;
    	private String toDatetime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDatetime() {
			return fromDatetime;
		}

		public void setFromDatetime(String fromDatetime) {
			this.fromDatetime = fromDatetime;
		}

		public String getToDatetime() {
			return toDatetime;
		}

		public void setToDatetime(String toDatetime) {
			this.toDatetime = toDatetime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveReminderHistoryStatusLine {
		private String appointmentExternalId;
		private String patientExternalId;
		private long updoxReminderId;
		private long updoxReminderHistoryId;
		private String reminderType;
		private Instant createdAt;
		private Instant sentAt;
		private Instant repliedAt;
		private String reminderStatus;
		private String reminderStatusReason;


		public String getAppointmentExternalId() {
			return appointmentExternalId;
		}

		public void setAppointmentExternalId(String appointmentExternalId) {
			this.appointmentExternalId = appointmentExternalId;
		}

		public String getPatientExternalId() {
			return patientExternalId;
		}

		public void setPatientExternalId(String patientExternalId) {
			this.patientExternalId = patientExternalId;
		}

		public long getUpdoxReminderId() {
			return updoxReminderId;
		}

		public void setUpdoxReminderId(long updoxReminderId) {
			this.updoxReminderId = updoxReminderId;
		}

		public long getUpdoxReminderHistoryId() {
			return updoxReminderHistoryId;
		}

		public void setUpdoxReminderHistoryId(long updoxReminderHistoryId) {
			this.updoxReminderHistoryId = updoxReminderHistoryId;
		}

		public String getReminderType() {
			return reminderType;
		}

		public void setReminderType(String reminderType) {
			this.reminderType = reminderType;
		}

		public Instant getCreatedAt() {
			return createdAt;
		}

		public void setCreatedAt(Instant createdAt) {
			this.createdAt = createdAt;
		}

		public Instant getSentAt() {
			return sentAt;
		}

		public void setSentAt(Instant sentAt) {
			this.sentAt = sentAt;
		}

		public Instant getRepliedAt() {
			return repliedAt;
		}

		public void setRepliedAt(Instant repliedAt) {
			this.repliedAt = repliedAt;
		}

		public String getReminderStatus() {
			return reminderStatus;
		}

		public void setReminderStatus(String reminderStatus) {
			this.reminderStatus = reminderStatus;
		}

		public String getReminderStatusReason() {
			return reminderStatusReason;
		}

		public void setReminderStatusReason(String reminderStatusReason) {
			this.reminderStatusReason = reminderStatusReason;
		}
	}

	private static class RetrieveReminderHistoryStatusResponse extends UpdoxResponse {
		private List<RetrieveReminderHistoryStatusLine> lines;


		public List<RetrieveReminderHistoryStatusLine> getLines() {
			return lines;
		}

		public void setLines(List<RetrieveReminderHistoryStatusLine> lines) {
			this.lines = lines;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6215`	`record currently locked`

RetrieveReminderHistoryStatus/1.1 /io/RetrieveReminderHistoryStatus/1.1

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Changes from v1.0 to v1.1:

filteringAppointmentId - Response field added which, if this appointment is filtered/bundled, stores the applications' appointmentId of the appointment that filtered this appointment (value from IntegrationActions -> AppointmentsSync -> id)
filteringAppointmentStatus - Response field added which, if this appointment is filtered/bundled, stores the appointment status of the appointment that filtered this appointment
filteredAppointmentIds - Response field added which, if this appointment is filtering appointments, stores the list of application's appointmentIds of the appointments that were filtered (value from IntegrationActions -> AppointmentsSync -> id)

Parameter	Type	Value	Description
fromDatetime	String		From date/time being requested, format is ISO-8601. This is required.
toDatetime	String		To date/time being requested, format is ISO-8601. This is required.

Try it! Toggle Notes/Code Samples

RetrieveReminderHistoryStatus/1.1

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Changes from v1.0 to v1.1:

filteringAppointmentId - Response field added which, if this appointment is filtered/bundled, stores the applications' appointmentId of the appointment that filtered this appointment (value from IntegrationActions -> AppointmentsSync -> id)
filteringAppointmentStatus - Response field added which, if this appointment is filtered/bundled, stores the appointment status of the appointment that filtered this appointment
filteredAppointmentIds - Response field added which, if this appointment is filtering appointments, stores the list of application's appointmentIds of the appointments that were filtered (value from IntegrationActions -> AppointmentsSync -> id)

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Response object includes a list of lines with each line composed of:

appointmentId - non-nullable string - The application's appointmentId the reminder is for from IntegrationActions -> AppointmentsSync -> id
patientId - non-nullable string - The application's patientId the reminder is for from IntegrationActions -> PatientsSync -> id
updoxReminderId - non-nullable uint64 - The Updox created reminderId which uniquely references a reminder record (N of these records per appointmentId)
updoxReminderHistoryId - non-nullable uint64 - The Updox created reminderHistoryId which uniquely references a reminder history record (N of these records per updoxReminderId)
type - non-nullable string - The reminder type being sent, one of Email, Telephone-Home, Telephone-Cell, Text Message, and No Reminder
createdAt - non-nullable instant - The time the record happened at, format ISO-8601
sentAt - nullable instant - The time at which the reminder was sent to the patient, format ISO-8601
repliedAt - nullable instant - The time at which the reminder was replied to by the patient, format ISO-8601
reminderStatus - nullable string - The status description for the reminder (ex: "sent", "confirmed", etc.)
reminderStatusReason - nullable string - The status reason description for the reminder (ex: "Text reminder successfully delivered to destination", "Patient replied to confirm this appointment", etc.)
filteringAppointmentId - nullable string - If filtered/bundled, the applications' appointmentId of the appointment that filtered this appointment from IntegrationActions -> AppointmentsSync -> id
filteringAppointmentStatus - nullable string - If filtered/bundled or filtering/bundling others, the appointment status of the appointment that filtered this appointment
filteredAppointmentIds - nullable List of non-nullable strings - If filtering appointments, the list of application's appointmentIds of the appointments that were filtered from IntegrationActions -> AppointmentsSync -> id

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_RetrieveReminderHistoryStatus1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_RetrieveReminderHistoryStatus1_1 codeSample = new UpdoxCodeSample_RetrieveReminderHistoryStatus1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "RetrieveReminderHistoryStatus1_1";
			RetrieveReminderHistoryStatus1_1Request retrieveReminderHistoryStatus1_1Request = new RetrieveReminderHistoryStatus1_1Request();

			//set up credentials
			retrieveReminderHistoryStatus1_1Request.auth.applicationId = "applicationId";
			retrieveReminderHistoryStatus1_1Request.auth.applicationPassword = "applicationPassword";
			retrieveReminderHistoryStatus1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			retrieveReminderHistoryStatus1_1Request.fromDatetime = "fromDatetime";
			retrieveReminderHistoryStatus1_1Request.toDatetime = "toDatetime";

			//create the request
			string json = Utilities.buildRequestJson(retrieveReminderHistoryStatus1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "RetrieveReminderHistoryStatus/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			RetrieveReminderHistoryStatus1_1Response retrieveReminderHistoryStatus1_1Response = javascriptSerializer.Deserialize<RetrieveReminderHistoryStatus1_1Response>(jsonResponse);

			Console.WriteLine(retrieveReminderHistoryStatus1_1Response.responseCode);
			Console.WriteLine(retrieveReminderHistoryStatus1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class RetrieveReminderHistoryStatus1_1Request : UpdoxRequest {
			public string fromDatetime { get; set;}
			public string toDatetime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveReminderHistoryStatusLine1_1 {
			public string appointmentExternalId { get; set;}
			public string patientExternalId { get; set;}
			public long updoxReminderId { get; set;}
			public long updoxReminderHistoryId { get; set;}
			public string reminderType { get; set;}
			public Instant createdAt { get; set;}
			public Instant sentAt { get; set;}
			public Instant repliedAt { get; set;}
			public string reminderStatus { get; set;}
			public string reminderStatusReason { get; set;}
			public string filteringAppointmentId { get; set;}
			public string filteringAppointmentStatus { get; set;}
			public Set filteredAppointmentIds { get; set;}
		}

		public class RetrieveReminderHistoryStatus1_1Response : UpdoxResponse {
			public List<RetrieveReminderHistoryStatusLine1_1> lines { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_RetrieveReminderHistoryStatus1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_RetrieveReminderHistoryStatus1_1 codeSample = new UpdoxCodeSample_RetrieveReminderHistoryStatus1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "RetrieveReminderHistoryStatus1_1";

		RetrieveReminderHistoryStatus1_1Request retrieveReminderHistoryStatus1_1Request = new RetrieveReminderHistoryStatus1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = retrieveReminderHistoryStatus1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		retrieveReminderHistoryStatus1_1Request.setFromDatetime("fromDatetime");
		retrieveReminderHistoryStatus1_1Request.setToDatetime("toDatetime");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(retrieveReminderHistoryStatus1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'RetrieveReminderHistoryStatus/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		RetrieveReminderHistoryStatus1_1Response retrieveReminderHistoryStatus1_1Response = mapper.readValue(jsonResponse, RetrieveReminderHistoryStatus1_1Response.class);

		System.out.println(retrieveReminderHistoryStatus1_1Response.getResponseCode());
		System.out.println(retrieveReminderHistoryStatus1_1Response.getResponseMessage());
	}

	private class RetrieveReminderHistoryStatus1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDatetime;
    	private String toDatetime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDatetime() {
			return fromDatetime;
		}

		public void setFromDatetime(String fromDatetime) {
			this.fromDatetime = fromDatetime;
		}

		public String getToDatetime() {
			return toDatetime;
		}

		public void setToDatetime(String toDatetime) {
			this.toDatetime = toDatetime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveReminderHistoryStatusLine1_1 {
		private String appointmentExternalId;
		private String patientExternalId;
		private long updoxReminderId;
		private long updoxReminderHistoryId;
		private String reminderType;
		private Instant createdAt;
		private Instant sentAt;
		private Instant repliedAt;
		private String reminderStatus;
		private String reminderStatusReason;
		private String filteringAppointmentId;
		private String filteringAppointmentStatus;
		private Set filteredAppointmentIds;


		public String getAppointmentExternalId() {
			return appointmentExternalId;
		}

		public void setAppointmentExternalId(String appointmentExternalId) {
			this.appointmentExternalId = appointmentExternalId;
		}

		public String getPatientExternalId() {
			return patientExternalId;
		}

		public void setPatientExternalId(String patientExternalId) {
			this.patientExternalId = patientExternalId;
		}

		public long getUpdoxReminderId() {
			return updoxReminderId;
		}

		public void setUpdoxReminderId(long updoxReminderId) {
			this.updoxReminderId = updoxReminderId;
		}

		public long getUpdoxReminderHistoryId() {
			return updoxReminderHistoryId;
		}

		public void setUpdoxReminderHistoryId(long updoxReminderHistoryId) {
			this.updoxReminderHistoryId = updoxReminderHistoryId;
		}

		public String getReminderType() {
			return reminderType;
		}

		public void setReminderType(String reminderType) {
			this.reminderType = reminderType;
		}

		public Instant getCreatedAt() {
			return createdAt;
		}

		public void setCreatedAt(Instant createdAt) {
			this.createdAt = createdAt;
		}

		public Instant getSentAt() {
			return sentAt;
		}

		public void setSentAt(Instant sentAt) {
			this.sentAt = sentAt;
		}

		public Instant getRepliedAt() {
			return repliedAt;
		}

		public void setRepliedAt(Instant repliedAt) {
			this.repliedAt = repliedAt;
		}

		public String getReminderStatus() {
			return reminderStatus;
		}

		public void setReminderStatus(String reminderStatus) {
			this.reminderStatus = reminderStatus;
		}

		public String getReminderStatusReason() {
			return reminderStatusReason;
		}

		public void setReminderStatusReason(String reminderStatusReason) {
			this.reminderStatusReason = reminderStatusReason;
		}

		public String getFilteringAppointmentId() {
			return filteringAppointmentId;
		}

		public void setFilteringAppointmentId(String filteringAppointmentId) {
			this.filteringAppointmentId = filteringAppointmentId;
		}

		public String getFilteringAppointmentStatus() {
			return filteringAppointmentStatus;
		}

		public void setFilteringAppointmentStatus(String filteringAppointmentStatus) {
			this.filteringAppointmentStatus = filteringAppointmentStatus;
		}

		public Set getFilteredAppointmentIds() {
			return filteredAppointmentIds;
		}

		public void setFilteredAppointmentIds(Set filteredAppointmentIds) {
			this.filteredAppointmentIds = filteredAppointmentIds;
		}
	}

	private static class RetrieveReminderHistoryStatus1_1Response extends UpdoxResponse {
		private List<RetrieveReminderHistoryStatusLine1_1> lines;


		public List<RetrieveReminderHistoryStatusLine1_1> getLines() {
			return lines;
		}

		public void setLines(List<RetrieveReminderHistoryStatusLine1_1> lines) {
			this.lines = lines;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6215`	`record currently locked`

DirectActions

DirectAddressValidate /io/DirectAddressValidate

Validates a direct address supplied either as a raw address, or as an Updox 'recipient'

Parameter	Type	Value	Description
recipient	String		String value for the direct address or Internal ID of recipient. Must be either in the form of an e-mail address, or in the format of [type]:[id]. Min length 2 characters. Max length 255 characters. This is required.
includeLoA	Boolean		Optional boolean flag indicating whether the recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

DirectAddressValidate

Validates a direct address supplied either as a raw address, or as an Updox 'recipient'

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Direct Domain Certificate Types

When a call is made to /DirectAddressValidate, a search is performed for a current, non-revoked certificate for the target Direct address. There are two types of certificate searches:

Address-Level Certificates
The first certificate search looks for a certificate issued for the full recipient address: DrTom@DrTomsPractice.MyEHRDirect.com. If all of the following are true, then /DirectAddressValidate will return "validDirectAddress": true:

- a certificate is found (either via DNS or LDAP)
- the found certificate has not been revoked
- the found certificate is trusted itself or is signed by a trusted TrustAnchor
- the found certificate is either:
- - not signed by DirectTrust or
- - signed by DirectTrust and the inquiring user's practice has been "vetted"

Domain-Level Certificates
If no valid certificate can be found for the address, the next certificate search will be performed on the domain of the intended recipient: DrBobsPractice.OtherEHRDirect.com. A Domain-level certificate is used for all users in a given domain. The same certificate will be used to sign messages from DrBob@DrBobsPractice.OtherEHRDirect.com and messages from NurseRatchett@DrBobsPractice.OtherEHRDirect.com. Since there are not any user-specific (aka Address-specific) certificates available to be searched, the most precise anyone can be about determining if the recipient Direct address exists is to confirm the existence of a trusted, non-revoked certificate for the domain. The requirements for a Domain-Level certificate to be valid also apply to an Address-Level certificate:

- a certificate is found (either via DNS or LDAP)
- the found certificate has not been revoked
- the found certificate is trusted itself or is signed by a trusted TrustAnchor
- the found certificate is either:
- - not signed by DirectTrust or
- - signed by DirectTrust and the inquiring user's practice has been "vetted"

IMPORTANT NOTE: A response from /DirectAddressValidate of "validDirectAddress": true does not mean that the address itself is guaranteed to exist or that messages sent to it will be picked up by the intended recipient -- only that a valid, non-revoked, trusted certificate can be found for the requested address or domain. For information about delivery confirmation, read about MDN processing.

Special Case
If all of the following are true:

- a valid address-level or domain-level certificate is found
- the certificate is signed by DirectTrust
- the inquiring user's practice has not been "vetted"

then the following values will be included in the /DirectAddressValidate response:

.... "validDirectAddress": false, "vettingRequired": true, ...

This means that in order for the inquiring user to be able to send messages to the specified address, their practice must go through the Direct Trust Activation process. Once that process is completed and the practice is "vetted", the same call to /DirectAddressValidate will return the expected:

.... "validDirectAddress": true, ...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectAddressValidate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectAddressValidate codeSample = new UpdoxCodeSample_DirectAddressValidate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectAddressValidate";
			DirectAddressValidateRequest directAddressValidateRequest = new DirectAddressValidateRequest();

			//set up credentials
			directAddressValidateRequest.auth.applicationId = "applicationId";
			directAddressValidateRequest.auth.applicationPassword = "applicationPassword";
			directAddressValidateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			directAddressValidateRequest.recipient = "recipient";
			directAddressValidateRequest.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(directAddressValidateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectAddressValidate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectAddressValidateResponse directAddressValidateResponse = javascriptSerializer.Deserialize<DirectAddressValidateResponse>(jsonResponse);

			Console.WriteLine(directAddressValidateResponse.responseCode);
			Console.WriteLine(directAddressValidateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DirectAddressValidateRequest : UpdoxRequest {
			public string recipient { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DirectAddressValidateResponse : UpdoxResponse {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public bool validDirectAddress { get; set;}
			public bool vettingRequired { get; set;}
			public string reason { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DirectAddressValidate {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectAddressValidate codeSample = new UpdoxCodeSample_DirectAddressValidate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectAddressValidate";

		DirectAddressValidateRequest directAddressValidateRequest = new DirectAddressValidateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directAddressValidateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		directAddressValidateRequest.setRecipient("recipient");
		directAddressValidateRequest.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directAddressValidateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectAddressValidate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectAddressValidateResponse directAddressValidateResponse = mapper.readValue(jsonResponse, DirectAddressValidateResponse.class);

		System.out.println(directAddressValidateResponse.getResponseCode());
		System.out.println(directAddressValidateResponse.getResponseMessage());
	}

	private class DirectAddressValidateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DirectAddressValidateResponse extends UpdoxResponse {
		private String recipient;
		private String name;
		private String directAddress;
		private boolean validDirectAddress;
		private boolean vettingRequired;
		private String reason;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public boolean isValidDirectAddress() {
			return validDirectAddress;
		}

		public void setValidDirectAddress(boolean validDirectAddress) {
			this.validDirectAddress = validDirectAddress;
		}

		public boolean isVettingRequired() {
			return vettingRequired;
		}

		public void setVettingRequired(boolean vettingRequired) {
			this.vettingRequired = vettingRequired;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

DirectMessageAcknowledge /io/DirectMessageAcknowledge

Acknowledge a single Direct message based on the supplied messageId

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
status	String	Whether the message was successfully delivered to the end recipient. Must be one of the following values: dispatched, failed. This is required.
failureReason	String	Details on why the delivery failed. Max length 255 characters.

Try it! Toggle Notes/Code Samples

DirectMessageAcknowledge

Acknowledge a single Direct message based on the supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectMessageAcknowledge {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectMessageAcknowledge codeSample = new UpdoxCodeSample_DirectMessageAcknowledge();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectMessageAcknowledge";
			DirectMessageAcknowledgeRequest directMessageAcknowledgeRequest = new DirectMessageAcknowledgeRequest();

			//set up credentials
			directMessageAcknowledgeRequest.auth.applicationId = "applicationId";
			directMessageAcknowledgeRequest.auth.applicationPassword = "applicationPassword";
			directMessageAcknowledgeRequest.auth.accountId = "accountId";
			directMessageAcknowledgeRequest.auth.userId = "userId";

			//set up request specific parameters
			directMessageAcknowledgeRequest.messageId = 1L;
			directMessageAcknowledgeRequest.status = "status";
			directMessageAcknowledgeRequest.failureReason = "failureReason";

			//create the request
			string json = Utilities.buildRequestJson(directMessageAcknowledgeRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectMessageAcknowledge", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectMessageAcknowledgeResponse directMessageAcknowledgeResponse = javascriptSerializer.Deserialize<DirectMessageAcknowledgeResponse>(jsonResponse);

			Console.WriteLine(directMessageAcknowledgeResponse.responseCode);
			Console.WriteLine(directMessageAcknowledgeResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DirectMessageAcknowledgeRequest : UpdoxRequest {
			public long messageId { get; set;}
			public string status { get; set;}
			public string failureReason { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class DirectMessageAcknowledgeResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DirectMessageAcknowledge {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectMessageAcknowledge codeSample = new UpdoxCodeSample_DirectMessageAcknowledge();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectMessageAcknowledge";

		DirectMessageAcknowledgeRequest directMessageAcknowledgeRequest = new DirectMessageAcknowledgeRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directMessageAcknowledgeRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		directMessageAcknowledgeRequest.setMessageId(1L);
		directMessageAcknowledgeRequest.setStatus("status");
		directMessageAcknowledgeRequest.setFailureReason("failureReason");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directMessageAcknowledgeRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectMessageAcknowledge', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectMessageAcknowledgeResponse directMessageAcknowledgeResponse = mapper.readValue(jsonResponse, DirectMessageAcknowledgeResponse.class);

		System.out.println(directMessageAcknowledgeResponse.getResponseCode());
		System.out.println(directMessageAcknowledgeResponse.getResponseMessage());
	}

	private class DirectMessageAcknowledgeRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long messageId;
    	private String status;
    	private String failureReason;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getMessageId() {
			return messageId;
		}

		public void setMessageId(Long messageId) {
			this.messageId = messageId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getFailureReason() {
			return failureReason;
		}

		public void setFailureReason(String failureReason) {
			this.failureReason = failureReason;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class DirectMessageAcknowledgeResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`
`4000`	`Bad Request`
`4653`	`direct error: inbound message already acknowledged or timed out`

DirectMessageSend /io/DirectMessageSend

Sends a direct message (with optional attachments) from the authenticated user to one or more recipients

Parameter	Type	Value	Description
to	Array	add remove	Array of the contacts to send to. Must be a valid recipient format. Each must be either a valid e-mail or in the format of [type]:[id]. Max number of `to` addresses is 100.

	String
subject	String		The subject line of the message. Max length 255 characters.
textMessage	String		A plain text representation of the message.
htmlMessage	String		A HTML representation of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

DirectMessageSend

Sends a direct message (with optional attachments) from the authenticated user to one or more recipients

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectMessageSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectMessageSend codeSample = new UpdoxCodeSample_DirectMessageSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectMessageSend";
			DirectMessageSendRequest directMessageSendRequest = new DirectMessageSendRequest();

			//set up credentials
			directMessageSendRequest.auth.applicationId = "applicationId";
			directMessageSendRequest.auth.applicationPassword = "applicationPassword";
			directMessageSendRequest.auth.accountId = "accountId";
			directMessageSendRequest.auth.userId = "userId";

			//set up request specific parameters
			string toString = "to";
			String[] to = new String[]{toString};
			directMessageSendRequest.to = to;
			directMessageSendRequest.subject = "subject";
			directMessageSendRequest.textMessage = "textMessage";
			directMessageSendRequest.htmlMessage = "htmlMessage";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			directMessageSendRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(directMessageSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectMessageSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectMessageSendResponse directMessageSendResponse = javascriptSerializer.Deserialize<DirectMessageSendResponse>(jsonResponse);

			Console.WriteLine(directMessageSendResponse.responseCode);
			Console.WriteLine(directMessageSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class DirectMessageSendRequest : UpdoxRequest {
			public String[] to { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageResult {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public long messageId { get; set;}
			public bool success { get; set;}
			public string reason { get; set;}
		}

		public class InvalidAddressResult {
			public string recipient { get; set;}
			public string directAddress { get; set;}
			public string reason { get; set;}
		}

		public class DirectMessageSendResponse : UpdoxResponse {
			public MessageResult[] messages { get; set;}
			public InvalidAddressResult[] invalidAddresses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_DirectMessageSend {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectMessageSend codeSample = new UpdoxCodeSample_DirectMessageSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectMessageSend";

		DirectMessageSendRequest directMessageSendRequest = new DirectMessageSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directMessageSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		String toString = "to";
		String[] to = new String[]{toString};
		directMessageSendRequest.setTo(to);
		directMessageSendRequest.setSubject("subject");
		directMessageSendRequest.setTextMessage("textMessage");
		directMessageSendRequest.setHtmlMessage("htmlMessage");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		directMessageSendRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directMessageSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectMessageSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectMessageSendResponse directMessageSendResponse = mapper.readValue(jsonResponse, DirectMessageSendResponse.class);

		System.out.println(directMessageSendResponse.getResponseCode());
		System.out.println(directMessageSendResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class DirectMessageSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String[] to;
    	private String subject;
    	private String textMessage;
    	private String htmlMessage;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String[] getTo() {
			return to;
		}

		public void setTo(String[] to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageResult {
		private String recipient;
		private String name;
		private String directAddress;
		private long messageId;
		private boolean success;
		private String reason;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}
	}

	private static class InvalidAddressResult {
		private String recipient;
		private String directAddress;
		private String reason;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}
	}

	private static class DirectMessageSendResponse extends UpdoxResponse {
		private MessageResult[] messages;
		private InvalidAddressResult[] invalidAddresses;


		public MessageResult[] getMessages() {
			return messages;
		}

		public void setMessages(MessageResult[] messages) {
			this.messages = messages;
		}

		public InvalidAddressResult[] getInvalidAddresses() {
			return invalidAddresses;
		}

		public void setInvalidAddresses(InvalidAddressResult[] invalidAddresses) {
			this.invalidAddresses = invalidAddresses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4641`	`direct address error: sending user does not have a direct address configured`
`4642`	`direct address error: identity verification required to send to this address`
`4640`	`direct address error: invalid direct address`
`4650`	`direct error: send failed`
`4651`	`direct error: send failed and/or invalid direct address`

DirectSimpleSend /io/DirectSimpleSend

Sends a direct message (with optional attachments) from the authenticated user to a single recipient (represents a simpler interface than the DirectMessageSend API)

Parameter	Type	Value	Description
to	String		String value for the direct address or Internal ID of recipient. Must be either in the form of an e-mail address, or in the format of [type]:[id]. Max length 255 characters. This is required.
subject	String		The subject line of the message. Max length 255 characters.
textMessage	String		A plain text representation of the message.
htmlMessage	String		A HTML representation of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

DirectSimpleSend

Sends a direct message (with optional attachments) from the authenticated user to a single recipient (represents a simpler interface than the DirectMessageSend API)

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectSimpleSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectSimpleSend codeSample = new UpdoxCodeSample_DirectSimpleSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectSimpleSend";
			DirectSimpleSendRequest directSimpleSendRequest = new DirectSimpleSendRequest();

			//set up credentials
			directSimpleSendRequest.auth.applicationId = "applicationId";
			directSimpleSendRequest.auth.applicationPassword = "applicationPassword";
			directSimpleSendRequest.auth.accountId = "accountId";
			directSimpleSendRequest.auth.userId = "userId";

			//set up request specific parameters
			directSimpleSendRequest.to = "to";
			directSimpleSendRequest.subject = "subject";
			directSimpleSendRequest.textMessage = "textMessage";
			directSimpleSendRequest.htmlMessage = "htmlMessage";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			directSimpleSendRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(directSimpleSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectSimpleSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectSimpleSendResponse directSimpleSendResponse = javascriptSerializer.Deserialize<DirectSimpleSendResponse>(jsonResponse);

			Console.WriteLine(directSimpleSendResponse.responseCode);
			Console.WriteLine(directSimpleSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class DirectSimpleSendRequest : UpdoxRequest {
			public string to { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DirectSimpleSendResponse : UpdoxResponse {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string reason { get; set;}
			public long messageId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_DirectSimpleSend {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectSimpleSend codeSample = new UpdoxCodeSample_DirectSimpleSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectSimpleSend";

		DirectSimpleSendRequest directSimpleSendRequest = new DirectSimpleSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directSimpleSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		directSimpleSendRequest.setTo("to");
		directSimpleSendRequest.setSubject("subject");
		directSimpleSendRequest.setTextMessage("textMessage");
		directSimpleSendRequest.setHtmlMessage("htmlMessage");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		directSimpleSendRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directSimpleSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectSimpleSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectSimpleSendResponse directSimpleSendResponse = mapper.readValue(jsonResponse, DirectSimpleSendResponse.class);

		System.out.println(directSimpleSendResponse.getResponseCode());
		System.out.println(directSimpleSendResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class DirectSimpleSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String to;
    	private String subject;
    	private String textMessage;
    	private String htmlMessage;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class DirectSimpleSendResponse extends UpdoxResponse {
		private String recipient;
		private String name;
		private String directAddress;
		private String reason;
		private long messageId;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4641`	`direct address error: sending user does not have a direct address configured`
`4642`	`direct address error: identity verification required to send to this address`
`4000`	`Bad Request`
`4650`	`direct error: send failed`
`4640`	`direct address error: invalid direct address`

DirectVettedUserGet /io/DirectVettedUserGet

Gets the vetted user information for a practice

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

DirectVettedUserGet

Gets the vetted user information for a practice

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectVettedUserGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectVettedUserGet codeSample = new UpdoxCodeSample_DirectVettedUserGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectVettedUserGet";
			DirectVettedUserGetRequest directVettedUserGetRequest = new DirectVettedUserGetRequest();

			//set up credentials
			directVettedUserGetRequest.auth.applicationId = "applicationId";
			directVettedUserGetRequest.auth.applicationPassword = "applicationPassword";
			directVettedUserGetRequest.auth.accountId = "accountId";
			directVettedUserGetRequest.auth.userId = "userId";

			//set up request specific parameters
			directVettedUserGetRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(directVettedUserGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectVettedUserGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectVettedUserGetResponse directVettedUserGetResponse = javascriptSerializer.Deserialize<DirectVettedUserGetResponse>(jsonResponse);

			Console.WriteLine(directVettedUserGetResponse.responseCode);
			Console.WriteLine(directVettedUserGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DirectVettedUserGetRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DirectVettedUserGetResponse : UpdoxResponse {
			public string userId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DirectVettedUserGet {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectVettedUserGet codeSample = new UpdoxCodeSample_DirectVettedUserGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectVettedUserGet";

		DirectVettedUserGetRequest directVettedUserGetRequest = new DirectVettedUserGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directVettedUserGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		directVettedUserGetRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directVettedUserGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectVettedUserGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectVettedUserGetResponse directVettedUserGetResponse = mapper.readValue(jsonResponse, DirectVettedUserGetResponse.class);

		System.out.println(directVettedUserGetResponse.getResponseCode());
		System.out.println(directVettedUserGetResponse.getResponseMessage());
	}

	private class DirectVettedUserGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class DirectVettedUserGetResponse extends UpdoxResponse {
		private String userId;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`

MdnStatusGet /io/MdnStatusGet

Gets the last MDN sent for for submitted message id.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
messageId	Long		The message ID for which to retrieve status messages. This is required.

Try it! Toggle Notes/Code Samples

MdnStatusGet

Gets the last MDN sent for for submitted message id.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MdnStatusGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MdnStatusGet codeSample = new UpdoxCodeSample_MdnStatusGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MdnStatusGet";
			MdnStatusGetRequest mdnStatusGetRequest = new MdnStatusGetRequest();

			//set up credentials
			mdnStatusGetRequest.auth.applicationId = "applicationId";
			mdnStatusGetRequest.auth.applicationPassword = "applicationPassword";
			mdnStatusGetRequest.auth.accountId = "accountId";
			mdnStatusGetRequest.auth.userId = "userId";

			//set up request specific parameters
			mdnStatusGetRequest.messageId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(mdnStatusGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MdnStatusGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MdnStatusGetResponse mdnStatusGetResponse = javascriptSerializer.Deserialize<MdnStatusGetResponse>(jsonResponse);

			Console.WriteLine(mdnStatusGetResponse.responseCode);
			Console.WriteLine(mdnStatusGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MdnStatusGetRequest : UpdoxRequest {
			public long messageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MdnStatusGetResponse : UpdoxResponse {
			public string mdnStatus { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MdnStatusGet {

	public static void main(String[] args) {
		UpdoxCodeSample_MdnStatusGet codeSample = new UpdoxCodeSample_MdnStatusGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MdnStatusGet";

		MdnStatusGetRequest mdnStatusGetRequest = new MdnStatusGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = mdnStatusGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		mdnStatusGetRequest.setMessageId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(mdnStatusGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MdnStatusGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MdnStatusGetResponse mdnStatusGetResponse = mapper.readValue(jsonResponse, MdnStatusGetResponse.class);

		System.out.println(mdnStatusGetResponse.getResponseCode());
		System.out.println(mdnStatusGetResponse.getResponseMessage());
	}

	private class MdnStatusGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MdnStatusGetResponse extends UpdoxResponse {
		private String mdnStatus;


		public String getMdnStatus() {
			return mdnStatus;
		}

		public void setMdnStatus(String mdnStatus) {
			this.mdnStatus = mdnStatus;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4430`	`message type does not have any MDNs`
`4410`	`message not found`

MdnStatusGet/1.1 /io/MdnStatusGet/1.1

Gets the last MDN sent for for submitted message id. Any failure message from the MDN will be included in the statusMessage.

Parameter	Type	Value	Description
messageId	Long		The message ID for which to retrieve status messages. This is required.

Try it! Toggle Notes/Code Samples

MdnStatusGet/1.1

Gets the last MDN sent for for submitted message id. Any failure message from the MDN will be included in the statusMessage.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MdnStatusGet1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MdnStatusGet1_1 codeSample = new UpdoxCodeSample_MdnStatusGet1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MdnStatusGet1_1";
			MdnStatusGet1_1Request mdnStatusGet1_1Request = new MdnStatusGet1_1Request();

			//set up credentials
			mdnStatusGet1_1Request.auth.applicationId = "applicationId";
			mdnStatusGet1_1Request.auth.applicationPassword = "applicationPassword";
			mdnStatusGet1_1Request.auth.accountId = "accountId";
			mdnStatusGet1_1Request.auth.userId = "userId";

			//set up request specific parameters
			mdnStatusGet1_1Request.messageId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(mdnStatusGet1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MdnStatusGet/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MdnStatusGet1_1Response mdnStatusGet1_1Response = javascriptSerializer.Deserialize<MdnStatusGet1_1Response>(jsonResponse);

			Console.WriteLine(mdnStatusGet1_1Response.responseCode);
			Console.WriteLine(mdnStatusGet1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class MdnStatusGet1_1Request : UpdoxRequest {
			public long messageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MdnStatusGet1_1Response : UpdoxResponse {
			public string mdnStatus { get; set;}
			public string statusMessage { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MdnStatusGet1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_MdnStatusGet1_1 codeSample = new UpdoxCodeSample_MdnStatusGet1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MdnStatusGet1_1";

		MdnStatusGet1_1Request mdnStatusGet1_1Request = new MdnStatusGet1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = mdnStatusGet1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		mdnStatusGet1_1Request.setMessageId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(mdnStatusGet1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MdnStatusGet/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MdnStatusGet1_1Response mdnStatusGet1_1Response = mapper.readValue(jsonResponse, MdnStatusGet1_1Response.class);

		System.out.println(mdnStatusGet1_1Response.getResponseCode());
		System.out.println(mdnStatusGet1_1Response.getResponseMessage());
	}

	private class MdnStatusGet1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MdnStatusGet1_1Response extends UpdoxResponse {
		private String mdnStatus;
		private String statusMessage;


		public String getMdnStatus() {
			return mdnStatus;
		}

		public void setMdnStatus(String mdnStatus) {
			this.mdnStatus = mdnStatus;
		}

		public String getStatusMessage() {
			return statusMessage;
		}

		public void setStatusMessage(String statusMessage) {
			this.statusMessage = statusMessage;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4430`	`message type does not have any MDNs`
`4410`	`message not found`

MdnStatusList /io/MdnStatusList

Gets a list of the MDNs sent for submitted message id.

Parameter	Type	Value	Description
messageId	Long		The message ID for which to retrieve status messages. This is required.

Try it! Toggle Notes/Code Samples

MdnStatusList

Gets a list of the MDNs sent for submitted message id.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MdnStatusList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MdnStatusList codeSample = new UpdoxCodeSample_MdnStatusList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MdnStatusList";
			MdnStatusListRequest mdnStatusListRequest = new MdnStatusListRequest();

			//set up credentials
			mdnStatusListRequest.auth.applicationId = "applicationId";
			mdnStatusListRequest.auth.applicationPassword = "applicationPassword";
			mdnStatusListRequest.auth.accountId = "accountId";
			mdnStatusListRequest.auth.userId = "userId";

			//set up request specific parameters
			mdnStatusListRequest.messageId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(mdnStatusListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MdnStatusList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MdnStatusListResponse mdnStatusListResponse = javascriptSerializer.Deserialize<MdnStatusListResponse>(jsonResponse);

			Console.WriteLine(mdnStatusListResponse.responseCode);
			Console.WriteLine(mdnStatusListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MdnStatusListRequest : UpdoxRequest {
			public long messageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MdnStatus {
			public string mdnStatus { get; set;}
			public long mdnDttm { get; set;}
		}

		public class MdnStatusListResponse : UpdoxResponse {
			public List<MdnStatus> statuses { get; set;}
			public long originalDttm { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_MdnStatusList {

	public static void main(String[] args) {
		UpdoxCodeSample_MdnStatusList codeSample = new UpdoxCodeSample_MdnStatusList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MdnStatusList";

		MdnStatusListRequest mdnStatusListRequest = new MdnStatusListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = mdnStatusListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		mdnStatusListRequest.setMessageId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(mdnStatusListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MdnStatusList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MdnStatusListResponse mdnStatusListResponse = mapper.readValue(jsonResponse, MdnStatusListResponse.class);

		System.out.println(mdnStatusListResponse.getResponseCode());
		System.out.println(mdnStatusListResponse.getResponseMessage());
	}

	private class MdnStatusListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MdnStatus {
		private String mdnStatus;
		private long mdnDttm;


		public String getMdnStatus() {
			return mdnStatus;
		}

		public void setMdnStatus(String mdnStatus) {
			this.mdnStatus = mdnStatus;
		}

		public long getMdnDttm() {
			return mdnDttm;
		}

		public void setMdnDttm(long mdnDttm) {
			this.mdnDttm = mdnDttm;
		}
	}

	private static class MdnStatusListResponse extends UpdoxResponse {
		private List<MdnStatus> statuses;
		private Long originalDttm;


		public List<MdnStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<MdnStatus> statuses) {
			this.statuses = statuses;
		}

		public Long getOriginalDttm() {
			return originalDttm;
		}

		public void setOriginalDttm(Long originalDttm) {
			this.originalDttm = originalDttm;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4430`	`message type does not have any MDNs`
`4410`	`message not found`

PatientDirectMessageSend /io/PatientDirectMessageSend

Sends a message from the supplied patient to the supplied direct address(es). If a FROM value is specified, it must be properly formatted or it will not succeed ( patient: )

Parameter	Type	Value	Description
to	String		String value for the direct address or Internal ID of recipient. Must be either in the form of an e-mail address, or in the format of [type]:[id]. Max length 255 characters. This is required.
subject	String		The subject line of the message. Max length 255 characters.
textMessage	String		A plain text representation of the message.
htmlMessage	String		A HTML representation of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.
from	String		The ID of the patient sending the message. Required if patientDemographics is not set. `from` will take precedence over `patientDemographics`, and so it should not be included if `patientDemographics` is. Min length 2 characters. Max length 100 characters.
patientDemographics			The demographics of the patient sending the message. Required if `from` is not set.
patientId	String		The patient's unique identifier in the calling application (commonly Chart #, Patient ID, Account #, etc). Min length 1 characters. Max length 40 characters. This is required.
firstName	String		First name. Min length 1 characters. Max length 50 characters. This is required.
middleName	String		Middle name or initial. Not Strictly required, but recommended if available. Max length 50 characters.
lastName	String		Last name. Min length 1 characters. Max length 50 characters. This is required.
dateOfBirth	String		Format yyyy-MM-dd. This is required.
gender	String		f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
emailAddress	String		Not Strictly required in most contexts, but recommended if available. Max length 255 characters.

Try it! Toggle Notes/Code Samples

PatientDirectMessageSend

Sends a message from the supplied patient to the supplied direct address(es). If a FROM value is specified, it must be properly formatted or it will not succeed ( patient: )

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientDirectMessageSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientDirectMessageSend codeSample = new UpdoxCodeSample_PatientDirectMessageSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientDirectMessageSend";
			PatientDirectMessageSendRequest patientDirectMessageSendRequest = new PatientDirectMessageSendRequest();

			//set up credentials
			patientDirectMessageSendRequest.auth.applicationId = "applicationId";
			patientDirectMessageSendRequest.auth.applicationPassword = "applicationPassword";
			patientDirectMessageSendRequest.auth.accountId = "accountId";

			//set up request specific parameters
			patientDirectMessageSendRequest.to = "to";
			patientDirectMessageSendRequest.subject = "subject";
			patientDirectMessageSendRequest.textMessage = "textMessage";
			patientDirectMessageSendRequest.htmlMessage = "htmlMessage";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			patientDirectMessageSendRequest.attachments = attachments;
			patientDirectMessageSendRequest.from = "from";
			MinimalDemographics patientDemographics = new MinimalDemographics();
			patientDemographics.patientId = "patientId";
			patientDemographics.firstName = "firstName";
			patientDemographics.middleName = "middleName";
			patientDemographics.lastName = "lastName";
			patientDemographics.dateOfBirth = "dateOfBirth";
			patientDemographics.gender = "gender";
			patientDemographics.emailAddress = "test@test.com";
			patientDirectMessageSendRequest.patientDemographics = patientDemographics;

			//create the request
			string json = Utilities.buildRequestJson(patientDirectMessageSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientDirectMessageSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientDirectMessageSendResponse patientDirectMessageSendResponse = javascriptSerializer.Deserialize<PatientDirectMessageSendResponse>(jsonResponse);

			Console.WriteLine(patientDirectMessageSendResponse.responseCode);
			Console.WriteLine(patientDirectMessageSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MinimalDemographics {
			public string patientId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string dateOfBirth { get; set;}
			public string gender { get; set;}
			public string emailAddress { get; set;}
		}

		public class PatientDirectMessageSendRequest : UpdoxRequest {
			public string to { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public FileAttachment[] attachments { get; set;}
			public string from { get; set;}
			public MinimalDemographics patientDemographics { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PatientDirectMessageSendResponse : UpdoxResponse {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string reason { get; set;}
			public long messageId { get; set;}
			public string patientDirectAddress { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_PatientDirectMessageSend {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientDirectMessageSend codeSample = new UpdoxCodeSample_PatientDirectMessageSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientDirectMessageSend";

		PatientDirectMessageSendRequest patientDirectMessageSendRequest = new PatientDirectMessageSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientDirectMessageSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		patientDirectMessageSendRequest.setTo("to");
		patientDirectMessageSendRequest.setSubject("subject");
		patientDirectMessageSendRequest.setTextMessage("textMessage");
		patientDirectMessageSendRequest.setHtmlMessage("htmlMessage");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		patientDirectMessageSendRequest.setAttachments(attachments);
		patientDirectMessageSendRequest.setFrom("from");
		MinimalDemographics patientDemographics = new MinimalDemographics();
		patientDemographics.setPatientId("patientId");
		patientDemographics.setFirstName("firstName");
		patientDemographics.setMiddleName("middleName");
		patientDemographics.setLastName("lastName");
		patientDemographics.setDateOfBirth("dateOfBirth");
		patientDemographics.setGender("gender");
		patientDemographics.setEmailAddress("test@test.com");
		patientDirectMessageSendRequest.setPatientDemographics(patientDemographics);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientDirectMessageSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientDirectMessageSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientDirectMessageSendResponse patientDirectMessageSendResponse = mapper.readValue(jsonResponse, PatientDirectMessageSendResponse.class);

		System.out.println(patientDirectMessageSendResponse.getResponseCode());
		System.out.println(patientDirectMessageSendResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class MinimalDemographics {
		private String patientId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String dateOfBirth;
		private String gender;
		private String emailAddress;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getDateOfBirth() {
			return dateOfBirth;
		}

		public void setDateOfBirth(String dateOfBirth) {
			this.dateOfBirth = dateOfBirth;
		}

		public String getGender() {
			return gender;
		}

		public void setGender(String gender) {
			this.gender = gender;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}
	}

	private class PatientDirectMessageSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String to;
    	private String subject;
    	private String textMessage;
    	private String htmlMessage;
    	private FileAttachment[] attachments;
    	private String from;
    	private MinimalDemographics patientDemographics;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public MinimalDemographics getPatientDemographics() {
			return patientDemographics;
		}

		public void setPatientDemographics(MinimalDemographics patientDemographics) {
			this.patientDemographics = patientDemographics;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PatientDirectMessageSendResponse extends UpdoxResponse {
		private String recipient;
		private String name;
		private String directAddress;
		private String reason;
		private long messageId;
		private String patientDirectAddress;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getPatientDirectAddress() {
			return patientDirectAddress;
		}

		public void setPatientDirectAddress(String patientDirectAddress) {
			this.patientDirectAddress = patientDirectAddress;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4652`	`direct error: either from or patientDemographics is required`
`4071`	`Recipient not found`
`4070`	`Invalid recipient`
`4642`	`direct address error: identity verification required to send to this address`
`4650`	`direct error: send failed`

ProviderDirectorySearch /io/ProviderDirectorySearch

Search for providers. Requires that the calling user have a Direct address assigned.

Parameter	Type	Description
searchTerms	String	Terms to search for within provider data. Max length 255 characters. This is required.
startIndex	String	Search result at which to start returning results.
resultQuantity	Integer	Quantity of search results desired (defaults to 50). The value must be between 1 and 50.

Try it! Toggle Notes/Code Samples

ProviderDirectorySearch

Search for providers. Requires that the calling user have a Direct address assigned.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Search Terms
Listed below are the fields available for searching. You must specify the fully qualified field name.

loa member.direct_address member.first_name member.last_name member.npi member.specialty practice.address_line_1 practice.address_line_2 practice.city practice.fax practice.name practice.npi practice.phone practice.state practice.zipcode

For example, "searchTerms" : "member.last_name:Miller" would give you providers with the last name of Miller, whereas simply providing "searchTerms" : "Miller" would give you any providers who has Miller as one of the fields (first name of Miller, last name of Miller, city of Miller, practice name containing Miller, etc.).

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ProviderDirectorySearch {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ProviderDirectorySearch codeSample = new UpdoxCodeSample_ProviderDirectorySearch();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ProviderDirectorySearch";
			ProviderDirectorySearchRequest providerDirectorySearchRequest = new ProviderDirectorySearchRequest();

			//set up credentials
			providerDirectorySearchRequest.auth.applicationId = "applicationId";
			providerDirectorySearchRequest.auth.applicationPassword = "applicationPassword";
			providerDirectorySearchRequest.auth.accountId = "accountId";
			providerDirectorySearchRequest.auth.userId = "userId";

			//set up request specific parameters
			providerDirectorySearchRequest.searchTerms = "searchTerms";
			providerDirectorySearchRequest.startIndex = "startIndex";
			providerDirectorySearchRequest.resultQuantity = "resultquantity";

			//create the request
			string json = Utilities.buildRequestJson(providerDirectorySearchRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ProviderDirectorySearch", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ProviderDirectorySearchResponse providerDirectorySearchResponse = javascriptSerializer.Deserialize<ProviderDirectorySearchResponse>(jsonResponse);

			Console.WriteLine(providerDirectorySearchResponse.responseCode);
			Console.WriteLine(providerDirectorySearchResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ProviderDirectorySearchRequest : UpdoxRequest {
			public string searchTerms { get; set;}
			public string startIndex { get; set;}
			public int resultQuantity { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderDirectorySearchResponse : UpdoxResponse {
			public long searchHitCount { get; set;}
			public Dictionary<String, Object> searchHits { get; set;}
			public string tOTAL_COUNT_FIELD_NAME { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Map;

public class UpdoxCodeSample_ProviderDirectorySearch {

	public static void main(String[] args) {
		UpdoxCodeSample_ProviderDirectorySearch codeSample = new UpdoxCodeSample_ProviderDirectorySearch();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ProviderDirectorySearch";

		ProviderDirectorySearchRequest providerDirectorySearchRequest = new ProviderDirectorySearchRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = providerDirectorySearchRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		providerDirectorySearchRequest.setSearchTerms("searchTerms");
		providerDirectorySearchRequest.setStartIndex("startIndex");
		providerDirectorySearchRequest.setResultQuantity("resultquantity");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(providerDirectorySearchRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ProviderDirectorySearch', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ProviderDirectorySearchResponse providerDirectorySearchResponse = mapper.readValue(jsonResponse, ProviderDirectorySearchResponse.class);

		System.out.println(providerDirectorySearchResponse.getResponseCode());
		System.out.println(providerDirectorySearchResponse.getResponseMessage());
	}

	private class ProviderDirectorySearchRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String searchTerms;
    	private String startIndex;
    	private Integer resultQuantity;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getSearchTerms() {
			return searchTerms;
		}

		public void setSearchTerms(String searchTerms) {
			this.searchTerms = searchTerms;
		}

		public String getStartIndex() {
			return startIndex;
		}

		public void setStartIndex(String startIndex) {
			this.startIndex = startIndex;
		}

		public Integer getResultQuantity() {
			return resultQuantity;
		}

		public void setResultQuantity(Integer resultQuantity) {
			this.resultQuantity = resultQuantity;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class ProviderDirectorySearchResponse extends UpdoxResponse {
		private long searchHitCount;
		private Map searchHits;
		private String tOTAL_COUNT_FIELD_NAME;


		public long getSearchHitCount() {
			return searchHitCount;
		}

		public void setSearchHitCount(long searchHitCount) {
			this.searchHitCount = searchHitCount;
		}

		public Map getSearchHits() {
			return searchHits;
		}

		public void setSearchHits(Map searchHits) {
			this.searchHits = searchHits;
		}

		public String getTOTAL_COUNT_FIELD_NAME() {
			return tOTAL_COUNT_FIELD_NAME;
		}

		public void setTOTAL_COUNT_FIELD_NAME(String tOTAL_COUNT_FIELD_NAME) {
			this.tOTAL_COUNT_FIELD_NAME = tOTAL_COUNT_FIELD_NAME;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4630`	`direct address error: account does not have a direct domain configured`
`4641`	`direct address error: sending user does not have a direct address configured`

StatusList /io/StatusList

Retrieves a status list (AKA audit log/action log) for the supplied messageId

Parameter	Type	Value	Description
messageId	Long		The message ID for which to retrieve status messages. This is required.

Try it! Toggle Notes/Code Samples

StatusList

Retrieves a status list (AKA audit log/action log) for the supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_StatusList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_StatusList codeSample = new UpdoxCodeSample_StatusList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "StatusList";
			StatusListRequest statusListRequest = new StatusListRequest();

			//set up credentials
			statusListRequest.auth.applicationId = "applicationId";
			statusListRequest.auth.applicationPassword = "applicationPassword";
			statusListRequest.auth.accountId = "accountId";
			statusListRequest.auth.userId = "userId";

			//set up request specific parameters
			statusListRequest.messageId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(statusListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "StatusList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			StatusListResponse statusListResponse = javascriptSerializer.Deserialize<StatusListResponse>(jsonResponse);

			Console.WriteLine(statusListResponse.responseCode);
			Console.WriteLine(statusListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class StatusListRequest : UpdoxRequest {
			public long messageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class StatusObject {
			public long timestamp { get; set;}
			public string actorRecipient { get; set;}
			public string actorName { get; set;}
			public string statusText { get; set;}
		}

		public class StatusListResponse : UpdoxResponse {
			public List<StatusObject> statusMessages { get; set;}
			public string actionText { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_StatusList {

	public static void main(String[] args) {
		UpdoxCodeSample_StatusList codeSample = new UpdoxCodeSample_StatusList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "StatusList";

		StatusListRequest statusListRequest = new StatusListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = statusListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		statusListRequest.setMessageId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(statusListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'StatusList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		StatusListResponse statusListResponse = mapper.readValue(jsonResponse, StatusListResponse.class);

		System.out.println(statusListResponse.getResponseCode());
		System.out.println(statusListResponse.getResponseMessage());
	}

	private class StatusListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class StatusObject {
		private long timestamp;
		private String actorRecipient;
		private String actorName;
		private String statusText;


		public long getTimestamp() {
			return timestamp;
		}

		public void setTimestamp(long timestamp) {
			this.timestamp = timestamp;
		}

		public String getActorRecipient() {
			return actorRecipient;
		}

		public void setActorRecipient(String actorRecipient) {
			this.actorRecipient = actorRecipient;
		}

		public String getActorName() {
			return actorName;
		}

		public void setActorName(String actorName) {
			this.actorName = actorName;
		}

		public String getStatusText() {
			return statusText;
		}

		public void setStatusText(String statusText) {
			this.statusText = statusText;
		}
	}

	private static class StatusListResponse extends UpdoxResponse {
		private List<StatusObject> statusMessages;
		private String actionText;


		public List<StatusObject> getStatusMessages() {
			return statusMessages;
		}

		public void setStatusMessages(List<StatusObject> statusMessages) {
			this.statusMessages = statusMessages;
		}

		public String getActionText() {
			return actionText;
		}

		public void setActionText(String actionText) {
			this.actionText = actionText;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

DocumentAnalysisActions

RetrieveIntelligentAnalysis /io/document-analysis/RetrieveIntelligentAnalysis

Retrieves or enqueues a new Intelligent Document Analysis based on the given request parameters

Outdated: In Active Development

Parameter	Type	Description
objectType	String	Must be one of the following values: FAX, MESSAGE. This is required.
objectId	String	The id value associated with the `objectType`. This is required.
analysisVersion	String	The analysis pipeline version identifier to run the object through. Supported version(s) so far: `AV1` - Recommended . This is required.
objectTooLargePageCount	Integer	A request specific page count after which the object is considered too large to analyze. If specified, will override the global default. A value of -1 is unlimited. .
partnerMetadata	String	Optional metadata you would like associated with this analysis request. Not used by Updox, but will be passed back to you in the result to help you track the request in your own way. There can be at most, 64 value(s).

Try it! Toggle Notes/Code Samples

RetrieveIntelligentAnalysis

Retrieves or enqueues a new Intelligent Document Analysis based on the given request parameters

Outdated: In Active Development

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis codeSample = new UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Document-analysisRetrieveIntelligentAnalysis";
			Document-analysisRetrieveIntelligentAnalysisRequest document-analysisRetrieveIntelligentAnalysisRequest = new Document-analysisRetrieveIntelligentAnalysisRequest();

			//set up credentials
			document-analysisRetrieveIntelligentAnalysisRequest.auth.applicationId = "applicationId";
			document-analysisRetrieveIntelligentAnalysisRequest.auth.applicationPassword = "applicationPassword";
			document-analysisRetrieveIntelligentAnalysisRequest.auth.accountId = "accountId";
			document-analysisRetrieveIntelligentAnalysisRequest.auth.userId = "userId";

			//set up request specific parameters
			document-analysisRetrieveIntelligentAnalysisRequest.objectType = "objectType";
			document-analysisRetrieveIntelligentAnalysisRequest.objectId = "objectId";
			document-analysisRetrieveIntelligentAnalysisRequest.analysisVersion = "analysisVersion";
			document-analysisRetrieveIntelligentAnalysisRequest.objectTooLargePageCount = "objecttoolargepagecount";
			document-analysisRetrieveIntelligentAnalysisRequest.partnerMetadata = "partnerMetadata";

			//create the request
			string json = Utilities.buildRequestJson(document-analysisRetrieveIntelligentAnalysisRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "document-analysis/RetrieveIntelligentAnalysis", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Document-analysisRetrieveIntelligentAnalysisResponse document-analysisRetrieveIntelligentAnalysisResponse = javascriptSerializer.Deserialize<Document-analysisRetrieveIntelligentAnalysisResponse>(jsonResponse);

			Console.WriteLine(document-analysisRetrieveIntelligentAnalysisResponse.responseCode);
			Console.WriteLine(document-analysisRetrieveIntelligentAnalysisResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Document-analysisRetrieveIntelligentAnalysisRequest : UpdoxRequest {
			public string objectType { get; set;}
			public string objectId { get; set;}
			public string analysisVersion { get; set;}
			public int objectTooLargePageCount { get; set;}
			public string partnerMetadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class Document-analysisRetrieveIntelligentAnalysisResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis {

	public static void main(String[] args) {
		UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis codeSample = new UpdoxCodeSample_Document-analysisRetrieveIntelligentAnalysis();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Document-analysisRetrieveIntelligentAnalysis";

		Document-analysisRetrieveIntelligentAnalysisRequest document-analysisRetrieveIntelligentAnalysisRequest = new Document-analysisRetrieveIntelligentAnalysisRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = document-analysisRetrieveIntelligentAnalysisRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		document-analysisRetrieveIntelligentAnalysisRequest.setObjectType("objectType");
		document-analysisRetrieveIntelligentAnalysisRequest.setObjectId("objectId");
		document-analysisRetrieveIntelligentAnalysisRequest.setAnalysisVersion("analysisVersion");
		document-analysisRetrieveIntelligentAnalysisRequest.setObjectTooLargePageCount("objecttoolargepagecount");
		document-analysisRetrieveIntelligentAnalysisRequest.setPartnerMetadata("partnerMetadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(document-analysisRetrieveIntelligentAnalysisRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'document-analysis/RetrieveIntelligentAnalysis', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Document-analysisRetrieveIntelligentAnalysisResponse document-analysisRetrieveIntelligentAnalysisResponse = mapper.readValue(jsonResponse, Document-analysisRetrieveIntelligentAnalysisResponse.class);

		System.out.println(document-analysisRetrieveIntelligentAnalysisResponse.getResponseCode());
		System.out.println(document-analysisRetrieveIntelligentAnalysisResponse.getResponseMessage());
	}

	private class Document-analysisRetrieveIntelligentAnalysisRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String objectType;
    	private String objectId;
    	private String analysisVersion;
    	private Integer objectTooLargePageCount;
    	private String partnerMetadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getObjectType() {
			return objectType;
		}

		public void setObjectType(String objectType) {
			this.objectType = objectType;
		}

		public String getObjectId() {
			return objectId;
		}

		public void setObjectId(String objectId) {
			this.objectId = objectId;
		}

		public String getAnalysisVersion() {
			return analysisVersion;
		}

		public void setAnalysisVersion(String analysisVersion) {
			this.analysisVersion = analysisVersion;
		}

		public Integer getObjectTooLargePageCount() {
			return objectTooLargePageCount;
		}

		public void setObjectTooLargePageCount(Integer objectTooLargePageCount) {
			this.objectTooLargePageCount = objectTooLargePageCount;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class Document-analysisRetrieveIntelligentAnalysisResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4094`	`record does not exist`
`4015`	`Unauthorized - API not enabled for the request's access rights`

DocumentQueueActions

DocumentQueueCreate /io/DocumentQueueCreate

Creates a document queue with the userId passed into auth.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated queue for Application Authorization. This is considered as this queue's ID. Max length 255 characters. This is required.
queueName	String	Max length 50 characters. This is required.
active	Boolean	True if active. If false, this queue will fail authorization. This is required.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

DocumentQueueCreate

Creates a document queue with the userId passed into auth.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueCreate codeSample = new UpdoxCodeSample_DocumentQueueCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueCreate";
			DocumentQueueCreateRequest documentQueueCreateRequest = new DocumentQueueCreateRequest();

			//set up credentials
			documentQueueCreateRequest.auth.applicationId = "applicationId";
			documentQueueCreateRequest.auth.applicationPassword = "applicationPassword";
			documentQueueCreateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			documentQueueCreateRequest.userId = "userId";
			documentQueueCreateRequest.queueName = "queueName";
			documentQueueCreateRequest.active = true;
			documentQueueCreateRequest.timeZone = "timeZone";
			documentQueueCreateRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(documentQueueCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueCreateResponse documentQueueCreateResponse = javascriptSerializer.Deserialize<DocumentQueueCreateResponse>(jsonResponse);

			Console.WriteLine(documentQueueCreateResponse.responseCode);
			Console.WriteLine(documentQueueCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueCreateRequest : UpdoxRequest {
			public string userId { get; set;}
			public string queueName { get; set;}
			public bool active { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DocumentQueueCreateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DocumentQueueCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueCreate codeSample = new UpdoxCodeSample_DocumentQueueCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueCreate";

		DocumentQueueCreateRequest documentQueueCreateRequest = new DocumentQueueCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		documentQueueCreateRequest.setUserId("userId");
		documentQueueCreateRequest.setQueueName("queueName");
		documentQueueCreateRequest.setActive(true);
		documentQueueCreateRequest.setTimeZone("timeZone");
		documentQueueCreateRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueCreateResponse documentQueueCreateResponse = mapper.readValue(jsonResponse, DocumentQueueCreateResponse.class);

		System.out.println(documentQueueCreateResponse.getResponseCode());
		System.out.println(documentQueueCreateResponse.getResponseMessage());
	}

	private class DocumentQueueCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String queueName;
    	private boolean active;
    	private String timeZone;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getQueueName() {
			return queueName;
		}

		public void setQueueName(String queueName) {
			this.queueName = queueName;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DocumentQueueCreateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4232`	`user password is required`
`4230`	`user already exists`
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`

DocumentQueueIDList /io/DocumentQueueIDList

List all document queue IDs and names.

Try it! Toggle Notes/Code Samples

DocumentQueueIDList

List all document queue IDs and names.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueIDList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueIDList codeSample = new UpdoxCodeSample_DocumentQueueIDList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueIDList";
			DocumentQueueIDListRequest documentQueueIDListRequest = new DocumentQueueIDListRequest();

			//set up credentials
			documentQueueIDListRequest.auth.applicationId = "applicationId";
			documentQueueIDListRequest.auth.applicationPassword = "applicationPassword";
			documentQueueIDListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(documentQueueIDListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueIDList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueIDListResponse documentQueueIDListResponse = javascriptSerializer.Deserialize<DocumentQueueIDListResponse>(jsonResponse);

			Console.WriteLine(documentQueueIDListResponse.responseCode);
			Console.WriteLine(documentQueueIDListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueIDListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DocumentQueue {
			public string id { get; set;}
			public string name { get; set;}
		}

		public class DocumentQueueIDListResponse : UpdoxResponse {
			public List<DocumentQueue> documentQueueList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_DocumentQueueIDList {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueIDList codeSample = new UpdoxCodeSample_DocumentQueueIDList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueIDList";

		DocumentQueueIDListRequest documentQueueIDListRequest = new DocumentQueueIDListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueIDListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueIDListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueIDList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueIDListResponse documentQueueIDListResponse = mapper.readValue(jsonResponse, DocumentQueueIDListResponse.class);

		System.out.println(documentQueueIDListResponse.getResponseCode());
		System.out.println(documentQueueIDListResponse.getResponseMessage());
	}

	private class DocumentQueueIDListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DocumentQueue {
		private String id;
		private String name;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}
	}

	private static class DocumentQueueIDListResponse extends UpdoxResponse {
		private List<DocumentQueue> documentQueueList;


		public List<DocumentQueue> getDocumentQueueList() {
			return documentQueueList;
		}

		public void setDocumentQueueList(List<DocumentQueue> documentQueueList) {
			this.documentQueueList = documentQueueList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

DocumentQueueSave /io/DocumentQueueSave

Creates or updates the document queue with the userId passed into auth. If a queue with that ID does not exist, a queue is created, else that queue is updated.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated queue for Application Authorization. This is considered as this queue's ID. Max length 255 characters. This is required.
queueName	String	Max length 50 characters. This is required.
active	Boolean	True if active. If false, this queue will fail authorization. This is required.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

DocumentQueueSave

Creates or updates the document queue with the userId passed into auth. If a queue with that ID does not exist, a queue is created, else that queue is updated.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueSave codeSample = new UpdoxCodeSample_DocumentQueueSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueSave";
			DocumentQueueSaveRequest documentQueueSaveRequest = new DocumentQueueSaveRequest();

			//set up credentials
			documentQueueSaveRequest.auth.applicationId = "applicationId";
			documentQueueSaveRequest.auth.applicationPassword = "applicationPassword";
			documentQueueSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			documentQueueSaveRequest.userId = "userId";
			documentQueueSaveRequest.queueName = "queueName";
			documentQueueSaveRequest.active = true;
			documentQueueSaveRequest.timeZone = "timeZone";
			documentQueueSaveRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(documentQueueSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueSaveResponse documentQueueSaveResponse = javascriptSerializer.Deserialize<DocumentQueueSaveResponse>(jsonResponse);

			Console.WriteLine(documentQueueSaveResponse.responseCode);
			Console.WriteLine(documentQueueSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueSaveRequest : UpdoxRequest {
			public string userId { get; set;}
			public string queueName { get; set;}
			public bool active { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DocumentQueueSaveResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DocumentQueueSave {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueSave codeSample = new UpdoxCodeSample_DocumentQueueSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueSave";

		DocumentQueueSaveRequest documentQueueSaveRequest = new DocumentQueueSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		documentQueueSaveRequest.setUserId("userId");
		documentQueueSaveRequest.setQueueName("queueName");
		documentQueueSaveRequest.setActive(true);
		documentQueueSaveRequest.setTimeZone("timeZone");
		documentQueueSaveRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueSaveResponse documentQueueSaveResponse = mapper.readValue(jsonResponse, DocumentQueueSaveResponse.class);

		System.out.println(documentQueueSaveResponse.getResponseCode());
		System.out.println(documentQueueSaveResponse.getResponseMessage());
	}

	private class DocumentQueueSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String queueName;
    	private boolean active;
    	private String timeZone;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getQueueName() {
			return queueName;
		}

		public void setQueueName(String queueName) {
			this.queueName = queueName;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DocumentQueueSaveResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4232`	`user password is required`
`4230`	`user already exists`
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`

DocumentQueueUpdate /io/DocumentQueueUpdate

Updates the document queue with the userId passed into auth.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated queue for Application Authorization. This is considered as this queue's ID. Max length 255 characters. This is required.
queueName	String	Max length 50 characters. This is required.
active	Boolean	True if active. If false, this queue will fail authorization. This is required.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

DocumentQueueUpdate

Updates the document queue with the userId passed into auth.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueUpdate codeSample = new UpdoxCodeSample_DocumentQueueUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueUpdate";
			DocumentQueueUpdateRequest documentQueueUpdateRequest = new DocumentQueueUpdateRequest();

			//set up credentials
			documentQueueUpdateRequest.auth.applicationId = "applicationId";
			documentQueueUpdateRequest.auth.applicationPassword = "applicationPassword";
			documentQueueUpdateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			documentQueueUpdateRequest.userId = "userId";
			documentQueueUpdateRequest.queueName = "queueName";
			documentQueueUpdateRequest.active = true;
			documentQueueUpdateRequest.timeZone = "timeZone";
			documentQueueUpdateRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(documentQueueUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueUpdateResponse documentQueueUpdateResponse = javascriptSerializer.Deserialize<DocumentQueueUpdateResponse>(jsonResponse);

			Console.WriteLine(documentQueueUpdateResponse.responseCode);
			Console.WriteLine(documentQueueUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueUpdateRequest : UpdoxRequest {
			public string userId { get; set;}
			public string queueName { get; set;}
			public bool active { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DocumentQueueUpdateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DocumentQueueUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueUpdate codeSample = new UpdoxCodeSample_DocumentQueueUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueUpdate";

		DocumentQueueUpdateRequest documentQueueUpdateRequest = new DocumentQueueUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		documentQueueUpdateRequest.setUserId("userId");
		documentQueueUpdateRequest.setQueueName("queueName");
		documentQueueUpdateRequest.setActive(true);
		documentQueueUpdateRequest.setTimeZone("timeZone");
		documentQueueUpdateRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueUpdateResponse documentQueueUpdateResponse = mapper.readValue(jsonResponse, DocumentQueueUpdateResponse.class);

		System.out.println(documentQueueUpdateResponse.getResponseCode());
		System.out.println(documentQueueUpdateResponse.getResponseMessage());
	}

	private class DocumentQueueUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String queueName;
    	private boolean active;
    	private String timeZone;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getQueueName() {
			return queueName;
		}

		public void setQueueName(String queueName) {
			this.queueName = queueName;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DocumentQueueUpdateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4232`	`user password is required`
`4230`	`user already exists`
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`

DocumentQueueUserList /io/DocumentQueueUserList

List all users associated with the specified queue.

Parameter	Type	Value	Description
queueId	String		The queue id to find associated users. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

DocumentQueueUserList

List all users associated with the specified queue.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueUserList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueUserList codeSample = new UpdoxCodeSample_DocumentQueueUserList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueUserList";
			DocumentQueueUserListRequest documentQueueUserListRequest = new DocumentQueueUserListRequest();

			//set up credentials
			documentQueueUserListRequest.auth.applicationId = "applicationId";
			documentQueueUserListRequest.auth.applicationPassword = "applicationPassword";
			documentQueueUserListRequest.auth.accountId = "accountId";

			//set up request specific parameters
			documentQueueUserListRequest.queueId = "queueId";

			//create the request
			string json = Utilities.buildRequestJson(documentQueueUserListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueUserList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueUserListResponse documentQueueUserListResponse = javascriptSerializer.Deserialize<DocumentQueueUserListResponse>(jsonResponse);

			Console.WriteLine(documentQueueUserListResponse.responseCode);
			Console.WriteLine(documentQueueUserListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueUserListRequest : UpdoxRequest {
			public string queueId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Map {
		}

		public class DocumentQueueUserListResponse : UpdoxResponse {
			public List<Map> userList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_DocumentQueueUserList {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueUserList codeSample = new UpdoxCodeSample_DocumentQueueUserList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueUserList";

		DocumentQueueUserListRequest documentQueueUserListRequest = new DocumentQueueUserListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueUserListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		documentQueueUserListRequest.setQueueId("queueId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueUserListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueUserList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueUserListResponse documentQueueUserListResponse = mapper.readValue(jsonResponse, DocumentQueueUserListResponse.class);

		System.out.println(documentQueueUserListResponse.getResponseCode());
		System.out.println(documentQueueUserListResponse.getResponseMessage());
	}

	private class DocumentQueueUserListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String queueId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getQueueId() {
			return queueId;
		}

		public void setQueueId(String queueId) {
			this.queueId = queueId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Map {

	}

	private static class DocumentQueueUserListResponse extends UpdoxResponse {
		private List<Map> userList;


		public List<Map> getUserList() {
			return userList;
		}

		public void setUserList(List<Map> userList) {
			this.userList = userList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

DocumentQueueUserSave /io/DocumentQueueUserSave

Associates a user with a queue.

Parameter	Type	Description
userId	String	The id of the user to be associated with this queue. Max length 255 characters. This is required.
queueId	String	The queue id to be associated. Max length 255 characters. This is required.
active	Boolean	The flag for adding or deleting the user from the queue. Default is true.

Try it! Toggle Notes/Code Samples

DocumentQueueUserSave

Associates a user with a queue.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DocumentQueueUserSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DocumentQueueUserSave codeSample = new UpdoxCodeSample_DocumentQueueUserSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DocumentQueueUserSave";
			DocumentQueueUserSaveRequest documentQueueUserSaveRequest = new DocumentQueueUserSaveRequest();

			//set up credentials
			documentQueueUserSaveRequest.auth.applicationId = "applicationId";
			documentQueueUserSaveRequest.auth.applicationPassword = "applicationPassword";
			documentQueueUserSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			documentQueueUserSaveRequest.userId = "userId";
			documentQueueUserSaveRequest.queueId = "queueId";
			documentQueueUserSaveRequest.active = true;

			//create the request
			string json = Utilities.buildRequestJson(documentQueueUserSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DocumentQueueUserSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DocumentQueueUserSaveResponse documentQueueUserSaveResponse = javascriptSerializer.Deserialize<DocumentQueueUserSaveResponse>(jsonResponse);

			Console.WriteLine(documentQueueUserSaveResponse.responseCode);
			Console.WriteLine(documentQueueUserSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DocumentQueueUserSaveRequest : UpdoxRequest {
			public string userId { get; set;}
			public string queueId { get; set;}
			public bool active { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DocumentQueueUserSaveResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DocumentQueueUserSave {

	public static void main(String[] args) {
		UpdoxCodeSample_DocumentQueueUserSave codeSample = new UpdoxCodeSample_DocumentQueueUserSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DocumentQueueUserSave";

		DocumentQueueUserSaveRequest documentQueueUserSaveRequest = new DocumentQueueUserSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = documentQueueUserSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		documentQueueUserSaveRequest.setUserId("userId");
		documentQueueUserSaveRequest.setQueueId("queueId");
		documentQueueUserSaveRequest.setActive(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(documentQueueUserSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DocumentQueueUserSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DocumentQueueUserSaveResponse documentQueueUserSaveResponse = mapper.readValue(jsonResponse, DocumentQueueUserSaveResponse.class);

		System.out.println(documentQueueUserSaveResponse.getResponseCode());
		System.out.println(documentQueueUserSaveResponse.getResponseMessage());
	}

	private class DocumentQueueUserSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String queueId;
    	private boolean active;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getQueueId() {
			return queueId;
		}

		public void setQueueId(String queueId) {
			this.queueId = queueId;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DocumentQueueUserSaveResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4231`	`user does not exist`

EventNotificationActions

EventNotificationBulkCreate /io/EventNotificationBulkCreate

Creates multiple notifications. Special considerations for notification when using keyprompts:

Email must have the following dataKeyValues provided as these are used in the confirmation response provided when the patient confirms the appointment:
- date
- time
Voice must have the following dataKeyValues provided as these are used when option 3 is presented to the the patient in case they want to call the practice:
- practicephone

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
notifications	List	add remove	Create a list of notifications to be delivered. There must be at least 1 value(s). There can be at most, 100 value(s).

payload	String		The information to be delivered in the notification. If the method is SMS, there is a max character limit of 1600. Tokens unavailable for use when payload is provided. Max length 4096 characters.
internalId	String		An id created by the requester which will be linked to the notification. Max length 40 characters.
scriptLanguage	String		The language to be used for the provided script. An empty language will default to english. Max length 32 characters. Must be one of the following values: english, english_m, spanish, .
scriptId	String		The id for the script associated with the particular method for creating the notification. If the script contains tokens, the token values must be specified with `dataKeyValues` below. Max length 11 characters.
deliveryDateTime	String		The date and time in which to deliver the notification. Format, yyyy-MM-dd HH:mm:ss . An empty delivery date/time will deliver the notification immediately.
deliveryDestination	String		The destination in which to deliver the notification. Example, phone number or email address. Max length 255 characters.
deliveryMethod	String		The name of the method by which the notification will be delivered. Max length 50 characters. Must be one of the following values: SMS, EMAIL, VOICE, TEXT2VOICE. This is required.
dataKeyValues	List	add remove	The list of token keys and their corresponding values to be substituted into the provided script.

dataValue	String		The value to be substituted into the script where the token key is located.
dataKey	String		A token key from the specified script ID.
excludedKeyPrompts	List	add remove	The list of key prompts to be excluded from the notification. If empty, all prompts will be included. Key prompts are not available for SMS notifications.

excludedKeyPrompt	String		A key press prompt to exclude from the generated notification. Must be one of the following values: confirm, cancel, transfer, repeat.

Try it! Toggle Notes/Code Samples

EventNotificationBulkCreate

Creates multiple notifications. Special considerations for notification when using keyprompts:

Email must have the following dataKeyValues provided as these are used in the confirmation response provided when the patient confirms the appointment:
- date
- time
Voice must have the following dataKeyValues provided as these are used when option 3 is presented to the the patient in case they want to call the practice:
- practicephone

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationBulkCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationBulkCreate codeSample = new UpdoxCodeSample_EventNotificationBulkCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationBulkCreate";
			EventNotificationBulkCreateRequest eventNotificationBulkCreateRequest = new EventNotificationBulkCreateRequest();

			//set up credentials
			eventNotificationBulkCreateRequest.auth.applicationId = "applicationId";
			eventNotificationBulkCreateRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationBulkCreateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<EventNotificationCreateRequestKVData> dataKeyValues = new List<EventNotificationCreateRequestKVData>();
			EventNotificationCreateRequestKVData eventNotificationCreateRequestKVData = new EventNotificationCreateRequestKVData();
			eventNotificationCreateRequestKVData.dataValue = "dataValue";
			eventNotificationCreateRequestKVData.dataKey = "dataKey";
			dataKeyValues.Add(eventNotificationCreateRequestKVData);
			List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts = new List<EventNotificationCreateRequestExcludedPromptData>();
			EventNotificationCreateRequestExcludedPromptData eventNotificationCreateRequestExcludedPromptData = new EventNotificationCreateRequestExcludedPromptData();
			eventNotificationCreateRequestExcludedPromptData.excludedKeyPrompt = "excludedKeyPrompt";
			excludedKeyPrompts.Add(eventNotificationCreateRequestExcludedPromptData);
			List<EventNotificationCreateRequestData> notifications = new List<EventNotificationCreateRequestData>();
			EventNotificationCreateRequestData eventNotificationCreateRequestData = new EventNotificationCreateRequestData();
			eventNotificationCreateRequestData.payload = "payload";
			eventNotificationCreateRequestData.internalId = "internalId";
			eventNotificationCreateRequestData.scriptLanguage = "scriptLanguage";
			eventNotificationCreateRequestData.scriptId = "scriptId";
			eventNotificationCreateRequestData.deliveryDateTime = "deliveryDateTime";
			eventNotificationCreateRequestData.deliveryDestination = "deliveryDestination";
			eventNotificationCreateRequestData.deliveryMethod = "deliveryMethod";
			eventNotificationCreateRequestData.dataKeyValues = dataKeyValues;
			eventNotificationCreateRequestData.excludedKeyPrompts = excludedKeyPrompts;
			notifications.Add(eventNotificationCreateRequestData);
			eventNotificationBulkCreateRequest.notifications = notifications;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationBulkCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationBulkCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationBulkCreateResponse eventNotificationBulkCreateResponse = javascriptSerializer.Deserialize<EventNotificationBulkCreateResponse>(jsonResponse);

			Console.WriteLine(eventNotificationBulkCreateResponse.responseCode);
			Console.WriteLine(eventNotificationBulkCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationCreateRequestKVData {
			public string dataValue { get; set;}
			public string dataKey { get; set;}
		}

		public class EventNotificationCreateRequestExcludedPromptData {
			public string excludedKeyPrompt { get; set;}
		}

		public class EventNotificationCreateRequestData {
			public string payload { get; set;}
			public string internalId { get; set;}
			public string scriptLanguage { get; set;}
			public string scriptId { get; set;}
			public string deliveryDateTime { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryMethod { get; set;}
			public List<EventNotificationCreateRequestKVData> dataKeyValues { get; set;}
			public List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts { get; set;}
		}

		public class EventNotificationBulkCreateRequest : UpdoxRequest {
			public List<EventNotificationCreateRequestData> notifications { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class EventNotificationBulkCreateResponse : UpdoxResponse {
			public long bulkNotificationId { get; set;}
			public long validNotificationTotal { get; set;}
			public long invalidNotificationTotal { get; set;}
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationBulkCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationBulkCreate codeSample = new UpdoxCodeSample_EventNotificationBulkCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationBulkCreate";

		EventNotificationBulkCreateRequest eventNotificationBulkCreateRequest = new EventNotificationBulkCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationBulkCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<EventNotificationCreateRequestKVData> dataKeyValues = new ArrayList<>();
		EventNotificationCreateRequestKVData eventNotificationCreateRequestKVData = new EventNotificationCreateRequestKVData();
		eventNotificationCreateRequestKVData.setDataValue("dataValue");
		eventNotificationCreateRequestKVData.setDataKey("dataKey");
		dataKeyValues.add(eventNotificationCreateRequestKVData);
	List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts = new ArrayList<>();
		EventNotificationCreateRequestExcludedPromptData eventNotificationCreateRequestExcludedPromptData = new EventNotificationCreateRequestExcludedPromptData();
		eventNotificationCreateRequestExcludedPromptData.setExcludedKeyPrompt("excludedKeyPrompt");
		excludedKeyPrompts.add(eventNotificationCreateRequestExcludedPromptData);
	List<EventNotificationCreateRequestData> notifications = new ArrayList<>();
		EventNotificationCreateRequestData eventNotificationCreateRequestData = new EventNotificationCreateRequestData();
		eventNotificationCreateRequestData.setPayload("payload");
		eventNotificationCreateRequestData.setInternalId("internalId");
		eventNotificationCreateRequestData.setScriptLanguage("scriptLanguage");
		eventNotificationCreateRequestData.setScriptId("scriptId");
		eventNotificationCreateRequestData.setDeliveryDateTime("deliveryDateTime");
		eventNotificationCreateRequestData.setDeliveryDestination("deliveryDestination");
		eventNotificationCreateRequestData.setDeliveryMethod("deliveryMethod");
		eventNotificationCreateRequestData.setDataKeyValues(dataKeyValues);
		eventNotificationCreateRequestData.setExcludedKeyPrompts(excludedKeyPrompts);
		notifications.add(eventNotificationCreateRequestData);
		eventNotificationBulkCreateRequest.setNotifications(notifications);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationBulkCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationBulkCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationBulkCreateResponse eventNotificationBulkCreateResponse = mapper.readValue(jsonResponse, EventNotificationBulkCreateResponse.class);

		System.out.println(eventNotificationBulkCreateResponse.getResponseCode());
		System.out.println(eventNotificationBulkCreateResponse.getResponseMessage());
	}

	private static class EventNotificationCreateRequestKVData {
		private String dataValue;
		private String dataKey;


		public String getDataValue() {
			return dataValue;
		}

		public void setDataValue(String dataValue) {
			this.dataValue = dataValue;
		}

		public String getDataKey() {
			return dataKey;
		}

		public void setDataKey(String dataKey) {
			this.dataKey = dataKey;
		}
	}

	private static class EventNotificationCreateRequestExcludedPromptData {
		private String excludedKeyPrompt;


		public String getExcludedKeyPrompt() {
			return excludedKeyPrompt;
		}

		public void setExcludedKeyPrompt(String excludedKeyPrompt) {
			this.excludedKeyPrompt = excludedKeyPrompt;
		}
	}

	private static class EventNotificationCreateRequestData {
		private String payload;
		private String internalId;
		private String scriptLanguage;
		private String scriptId;
		private String deliveryDateTime;
		private String deliveryDestination;
		private String deliveryMethod;
		private List<EventNotificationCreateRequestKVData> dataKeyValues;
		private List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts;


		public String getPayload() {
			return payload;
		}

		public void setPayload(String payload) {
			this.payload = payload;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getScriptId() {
			return scriptId;
		}

		public void setScriptId(String scriptId) {
			this.scriptId = scriptId;
		}

		public String getDeliveryDateTime() {
			return deliveryDateTime;
		}

		public void setDeliveryDateTime(String deliveryDateTime) {
			this.deliveryDateTime = deliveryDateTime;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public List<EventNotificationCreateRequestKVData> getDataKeyValues() {
			return dataKeyValues;
		}

		public void setDataKeyValues(List<EventNotificationCreateRequestKVData> dataKeyValues) {
			this.dataKeyValues = dataKeyValues;
		}

		public List<EventNotificationCreateRequestExcludedPromptData> getExcludedKeyPrompts() {
			return excludedKeyPrompts;
		}

		public void setExcludedKeyPrompts(List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts) {
			this.excludedKeyPrompts = excludedKeyPrompts;
		}
	}

	private class EventNotificationBulkCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<EventNotificationCreateRequestData> notifications;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<EventNotificationCreateRequestData> getNotifications() {
			return notifications;
		}

		public void setNotifications(List<EventNotificationCreateRequestData> notifications) {
			this.notifications = notifications;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class EventNotificationBulkCreateResponse extends UpdoxResponse {
		private long bulkNotificationId;
		private long validNotificationTotal;
		private long invalidNotificationTotal;
		private List<IdAndStatus> statuses;


		public long getBulkNotificationId() {
			return bulkNotificationId;
		}

		public void setBulkNotificationId(long bulkNotificationId) {
			this.bulkNotificationId = bulkNotificationId;
		}

		public long getValidNotificationTotal() {
			return validNotificationTotal;
		}

		public void setValidNotificationTotal(long validNotificationTotal) {
			this.validNotificationTotal = validNotificationTotal;
		}

		public long getInvalidNotificationTotal() {
			return invalidNotificationTotal;
		}

		public void setInvalidNotificationTotal(long invalidNotificationTotal) {
			this.invalidNotificationTotal = invalidNotificationTotal;
		}

		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6210`	`at least one value must be provided`

EventNotificationBulkCreate/1.1 /io/EventNotificationBulkCreate/1.1

Version 1.1 - Creates multiple notifications. Notifications being sent via text will automatically include STOP language. Special considerations for notification when using keyprompts:

Email must have the following dataKeyValues provided as these are used in the confirmation response provided when the patient confirms the appointment:
- date
- time
Voice must have the following dataKeyValues provided as these are used when option 3 is presented to the the patient in case they want to call the practice:
- practicephone

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
notifications	List	add remove	Create a list of notifications to be delivered. There must be at least 1 value(s). There can be at most, 100 value(s).

payload	String		The information to be delivered in the notification. If the method is SMS, there is a max character limit of 1600. Tokens unavailable for use when payload is provided. Max length 4096 characters.
internalId	String		An id created by the requester which will be linked to the notification. Max length 40 characters.
scriptLanguage	String		The language to be used for the provided script. An empty language will default to english. Max length 32 characters. Must be one of the following values: english, english_m, spanish, .
scriptId	String		The id for the script associated with the particular method for creating the notification. If the script contains tokens, the token values must be specified with `dataKeyValues` below. Max length 11 characters.
deliveryDateTime	String		The date and time in which to deliver the notification. Format, yyyy-MM-dd HH:mm:ss . An empty delivery date/time will deliver the notification immediately.
deliveryDestination	String		The destination in which to deliver the notification. Example, phone number or email address. Max length 255 characters.
deliveryMethod	String		The name of the method by which the notification will be delivered. Max length 50 characters. Must be one of the following values: SMS, EMAIL, VOICE, TEXT2VOICE. This is required.
dataKeyValues	List	add remove	The list of token keys and their corresponding values to be substituted into the provided script.

dataValue	String		The value to be substituted into the script where the token key is located.
dataKey	String		A token key from the specified script ID.
excludedKeyPrompts	List	add remove	The list of key prompts to be excluded from the notification. If empty, all prompts will be included. Key prompts are not available for SMS notifications.

excludedKeyPrompt	String		A key press prompt to exclude from the generated notification. Must be one of the following values: confirm, cancel, transfer, repeat.

Try it! Toggle Notes/Code Samples

EventNotificationBulkCreate/1.1

Version 1.1 - Creates multiple notifications. Notifications being sent via text will automatically include STOP language. Special considerations for notification when using keyprompts:

Email must have the following dataKeyValues provided as these are used in the confirmation response provided when the patient confirms the appointment:
- date
- time
Voice must have the following dataKeyValues provided as these are used when option 3 is presented to the the patient in case they want to call the practice:
- practicephone

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationBulkCreate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationBulkCreate1_1 codeSample = new UpdoxCodeSample_EventNotificationBulkCreate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationBulkCreate1_1";
			EventNotificationBulkCreate1_1Request eventNotificationBulkCreate1_1Request = new EventNotificationBulkCreate1_1Request();

			//set up credentials
			eventNotificationBulkCreate1_1Request.auth.applicationId = "applicationId";
			eventNotificationBulkCreate1_1Request.auth.applicationPassword = "applicationPassword";
			eventNotificationBulkCreate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			List<EventNotificationCreateRequestKVData> dataKeyValues = new List<EventNotificationCreateRequestKVData>();
			EventNotificationCreateRequestKVData eventNotificationCreateRequestKVData = new EventNotificationCreateRequestKVData();
			eventNotificationCreateRequestKVData.dataValue = "dataValue";
			eventNotificationCreateRequestKVData.dataKey = "dataKey";
			dataKeyValues.Add(eventNotificationCreateRequestKVData);
			List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts = new List<EventNotificationCreateRequestExcludedPromptData>();
			EventNotificationCreateRequestExcludedPromptData eventNotificationCreateRequestExcludedPromptData = new EventNotificationCreateRequestExcludedPromptData();
			eventNotificationCreateRequestExcludedPromptData.excludedKeyPrompt = "excludedKeyPrompt";
			excludedKeyPrompts.Add(eventNotificationCreateRequestExcludedPromptData);
			List<EventNotificationCreateRequestData> notifications = new List<EventNotificationCreateRequestData>();
			EventNotificationCreateRequestData eventNotificationCreateRequestData = new EventNotificationCreateRequestData();
			eventNotificationCreateRequestData.payload = "payload";
			eventNotificationCreateRequestData.internalId = "internalId";
			eventNotificationCreateRequestData.scriptLanguage = "scriptLanguage";
			eventNotificationCreateRequestData.scriptId = "scriptId";
			eventNotificationCreateRequestData.deliveryDateTime = "deliveryDateTime";
			eventNotificationCreateRequestData.deliveryDestination = "deliveryDestination";
			eventNotificationCreateRequestData.deliveryMethod = "deliveryMethod";
			eventNotificationCreateRequestData.dataKeyValues = dataKeyValues;
			eventNotificationCreateRequestData.excludedKeyPrompts = excludedKeyPrompts;
			notifications.Add(eventNotificationCreateRequestData);
			eventNotificationBulkCreate1_1Request.notifications = notifications;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationBulkCreate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationBulkCreate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationBulkCreate1_1Response eventNotificationBulkCreate1_1Response = javascriptSerializer.Deserialize<EventNotificationBulkCreate1_1Response>(jsonResponse);

			Console.WriteLine(eventNotificationBulkCreate1_1Response.responseCode);
			Console.WriteLine(eventNotificationBulkCreate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationCreateRequestKVData {
			public string dataValue { get; set;}
			public string dataKey { get; set;}
		}

		public class EventNotificationCreateRequestExcludedPromptData {
			public string excludedKeyPrompt { get; set;}
		}

		public class EventNotificationCreateRequestData {
			public string payload { get; set;}
			public string internalId { get; set;}
			public string scriptLanguage { get; set;}
			public string scriptId { get; set;}
			public string deliveryDateTime { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryMethod { get; set;}
			public List<EventNotificationCreateRequestKVData> dataKeyValues { get; set;}
			public List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts { get; set;}
		}

		public class EventNotificationBulkCreate1_1Request : UpdoxRequest {
			public List<EventNotificationCreateRequestData> notifications { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class _FailedRequestParameter {
			public string requestParameter { get; set;}
			public string failReason { get; set;}
		}

		public class _Notification {
			public long notificationId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public long scriptId { get; set;}
			public string scriptLanguage { get; set;}
			public string deliveryMethod { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryDttm { get; set;}
			public string internalId { get; set;}
			public string createDttm { get; set;}
			public string reply { get; set;}
		}

		public class _BulkNotification {
			public long bulkId { get; set;}
			public string bulkStatus { get; set;}
			public string bulkStatusDttm { get; set;}
			public long bulkRequestSize { get; set;}
			public long bulkValidNotifications { get; set;}
			public long bulkInvalidNotifications { get; set;}
			public string bulkCreateDttm { get; set;}
			public List<_Notification> bulkNotifications { get; set;}
		}

		public class EventNotificationBulkCreate1_1Response : UpdoxResponse {
			public List<_FailedRequestParameter> failedRequestParameters { get; set;}
			public List<_BulkNotification> bulkInfos { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationBulkCreate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationBulkCreate1_1 codeSample = new UpdoxCodeSample_EventNotificationBulkCreate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationBulkCreate1_1";

		EventNotificationBulkCreate1_1Request eventNotificationBulkCreate1_1Request = new EventNotificationBulkCreate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationBulkCreate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<EventNotificationCreateRequestKVData> dataKeyValues = new ArrayList<>();
		EventNotificationCreateRequestKVData eventNotificationCreateRequestKVData = new EventNotificationCreateRequestKVData();
		eventNotificationCreateRequestKVData.setDataValue("dataValue");
		eventNotificationCreateRequestKVData.setDataKey("dataKey");
		dataKeyValues.add(eventNotificationCreateRequestKVData);
	List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts = new ArrayList<>();
		EventNotificationCreateRequestExcludedPromptData eventNotificationCreateRequestExcludedPromptData = new EventNotificationCreateRequestExcludedPromptData();
		eventNotificationCreateRequestExcludedPromptData.setExcludedKeyPrompt("excludedKeyPrompt");
		excludedKeyPrompts.add(eventNotificationCreateRequestExcludedPromptData);
	List<EventNotificationCreateRequestData> notifications = new ArrayList<>();
		EventNotificationCreateRequestData eventNotificationCreateRequestData = new EventNotificationCreateRequestData();
		eventNotificationCreateRequestData.setPayload("payload");
		eventNotificationCreateRequestData.setInternalId("internalId");
		eventNotificationCreateRequestData.setScriptLanguage("scriptLanguage");
		eventNotificationCreateRequestData.setScriptId("scriptId");
		eventNotificationCreateRequestData.setDeliveryDateTime("deliveryDateTime");
		eventNotificationCreateRequestData.setDeliveryDestination("deliveryDestination");
		eventNotificationCreateRequestData.setDeliveryMethod("deliveryMethod");
		eventNotificationCreateRequestData.setDataKeyValues(dataKeyValues);
		eventNotificationCreateRequestData.setExcludedKeyPrompts(excludedKeyPrompts);
		notifications.add(eventNotificationCreateRequestData);
		eventNotificationBulkCreate1_1Request.setNotifications(notifications);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationBulkCreate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationBulkCreate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationBulkCreate1_1Response eventNotificationBulkCreate1_1Response = mapper.readValue(jsonResponse, EventNotificationBulkCreate1_1Response.class);

		System.out.println(eventNotificationBulkCreate1_1Response.getResponseCode());
		System.out.println(eventNotificationBulkCreate1_1Response.getResponseMessage());
	}

	private static class EventNotificationCreateRequestKVData {
		private String dataValue;
		private String dataKey;


		public String getDataValue() {
			return dataValue;
		}

		public void setDataValue(String dataValue) {
			this.dataValue = dataValue;
		}

		public String getDataKey() {
			return dataKey;
		}

		public void setDataKey(String dataKey) {
			this.dataKey = dataKey;
		}
	}

	private static class EventNotificationCreateRequestExcludedPromptData {
		private String excludedKeyPrompt;


		public String getExcludedKeyPrompt() {
			return excludedKeyPrompt;
		}

		public void setExcludedKeyPrompt(String excludedKeyPrompt) {
			this.excludedKeyPrompt = excludedKeyPrompt;
		}
	}

	private static class EventNotificationCreateRequestData {
		private String payload;
		private String internalId;
		private String scriptLanguage;
		private String scriptId;
		private String deliveryDateTime;
		private String deliveryDestination;
		private String deliveryMethod;
		private List<EventNotificationCreateRequestKVData> dataKeyValues;
		private List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts;


		public String getPayload() {
			return payload;
		}

		public void setPayload(String payload) {
			this.payload = payload;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getScriptId() {
			return scriptId;
		}

		public void setScriptId(String scriptId) {
			this.scriptId = scriptId;
		}

		public String getDeliveryDateTime() {
			return deliveryDateTime;
		}

		public void setDeliveryDateTime(String deliveryDateTime) {
			this.deliveryDateTime = deliveryDateTime;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public List<EventNotificationCreateRequestKVData> getDataKeyValues() {
			return dataKeyValues;
		}

		public void setDataKeyValues(List<EventNotificationCreateRequestKVData> dataKeyValues) {
			this.dataKeyValues = dataKeyValues;
		}

		public List<EventNotificationCreateRequestExcludedPromptData> getExcludedKeyPrompts() {
			return excludedKeyPrompts;
		}

		public void setExcludedKeyPrompts(List<EventNotificationCreateRequestExcludedPromptData> excludedKeyPrompts) {
			this.excludedKeyPrompts = excludedKeyPrompts;
		}
	}

	private class EventNotificationBulkCreate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<EventNotificationCreateRequestData> notifications;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<EventNotificationCreateRequestData> getNotifications() {
			return notifications;
		}

		public void setNotifications(List<EventNotificationCreateRequestData> notifications) {
			this.notifications = notifications;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class _FailedRequestParameter {
		private String requestParameter;
		private String failReason;


		public String getRequestParameter() {
			return requestParameter;
		}

		public void setRequestParameter(String requestParameter) {
			this.requestParameter = requestParameter;
		}

		public String getFailReason() {
			return failReason;
		}

		public void setFailReason(String failReason) {
			this.failReason = failReason;
		}
	}

	private static class _Notification {
		private Long notificationId;
		private String status;
		private String statusDttm;
		private Long scriptId;
		private String scriptLanguage;
		private String deliveryMethod;
		private String deliveryDestination;
		private String deliveryDttm;
		private String internalId;
		private String createDttm;
		private String reply;


		public Long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(Long notificationId) {
			this.notificationId = notificationId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public Long getScriptId() {
			return scriptId;
		}

		public void setScriptId(Long scriptId) {
			this.scriptId = scriptId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryDttm() {
			return deliveryDttm;
		}

		public void setDeliveryDttm(String deliveryDttm) {
			this.deliveryDttm = deliveryDttm;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getCreateDttm() {
			return createDttm;
		}

		public void setCreateDttm(String createDttm) {
			this.createDttm = createDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class _BulkNotification {
		private Long bulkId;
		private String bulkStatus;
		private String bulkStatusDttm;
		private Long bulkRequestSize;
		private Long bulkValidNotifications;
		private Long bulkInvalidNotifications;
		private String bulkCreateDttm;
		private List<_Notification> bulkNotifications;


		public Long getBulkId() {
			return bulkId;
		}

		public void setBulkId(Long bulkId) {
			this.bulkId = bulkId;
		}

		public String getBulkStatus() {
			return bulkStatus;
		}

		public void setBulkStatus(String bulkStatus) {
			this.bulkStatus = bulkStatus;
		}

		public String getBulkStatusDttm() {
			return bulkStatusDttm;
		}

		public void setBulkStatusDttm(String bulkStatusDttm) {
			this.bulkStatusDttm = bulkStatusDttm;
		}

		public Long getBulkRequestSize() {
			return bulkRequestSize;
		}

		public void setBulkRequestSize(Long bulkRequestSize) {
			this.bulkRequestSize = bulkRequestSize;
		}

		public Long getBulkValidNotifications() {
			return bulkValidNotifications;
		}

		public void setBulkValidNotifications(Long bulkValidNotifications) {
			this.bulkValidNotifications = bulkValidNotifications;
		}

		public Long getBulkInvalidNotifications() {
			return bulkInvalidNotifications;
		}

		public void setBulkInvalidNotifications(Long bulkInvalidNotifications) {
			this.bulkInvalidNotifications = bulkInvalidNotifications;
		}

		public String getBulkCreateDttm() {
			return bulkCreateDttm;
		}

		public void setBulkCreateDttm(String bulkCreateDttm) {
			this.bulkCreateDttm = bulkCreateDttm;
		}

		public List<_Notification> getBulkNotifications() {
			return bulkNotifications;
		}

		public void setBulkNotifications(List<_Notification> bulkNotifications) {
			this.bulkNotifications = bulkNotifications;
		}
	}

	private static class EventNotificationBulkCreate1_1Response extends UpdoxResponse {
		private List<_FailedRequestParameter> failedRequestParameters;
		private List<_BulkNotification> bulkInfos;


		public List<_FailedRequestParameter> getFailedRequestParameters() {
			return failedRequestParameters;
		}

		public void setFailedRequestParameters(List<_FailedRequestParameter> failedRequestParameters) {
			this.failedRequestParameters = failedRequestParameters;
		}

		public List<_BulkNotification> getBulkInfos() {
			return bulkInfos;
		}

		public void setBulkInfos(List<_BulkNotification> bulkInfos) {
			this.bulkInfos = bulkInfos;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6210`	`at least one value must be provided`

EventNotificationDisable /io/EventNotificationDisable

Disable Event Notifications which are awaiting being sent by either their notificationId or internalId

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
notificationId	String		The Updox public id of the individual notification created by `EventNotificationActions`.
internalId	String		An id created by the requester which will be linked to the notification. Max length 40 characters.

Try it! Toggle Notes/Code Samples

EventNotificationDisable

Disable Event Notifications which are awaiting being sent by either their notificationId or internalId

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

As of May 2024, Event Notifications which are awaiting being sent refers to those in CREATED status and being sent more than one minute from the current time.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationDisable {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationDisable codeSample = new UpdoxCodeSample_EventNotificationDisable();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationDisable";
			EventNotificationDisableRequest eventNotificationDisableRequest = new EventNotificationDisableRequest();

			//set up credentials
			eventNotificationDisableRequest.auth.applicationId = "applicationId";
			eventNotificationDisableRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationDisableRequest.auth.accountId = "accountId";

			//set up request specific parameters
			eventNotificationDisableRequest.notificationId = "notificationId";
			eventNotificationDisableRequest.internalId = "internalId";

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationDisableRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationDisable", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationDisableResponse eventNotificationDisableResponse = javascriptSerializer.Deserialize<EventNotificationDisableResponse>(jsonResponse);

			Console.WriteLine(eventNotificationDisableResponse.responseCode);
			Console.WriteLine(eventNotificationDisableResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationDisableRequest : UpdoxRequest {
			public string notificationId { get; set;}
			public string internalId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class EventNotificationDisableResponse : UpdoxResponse {
			public string notificationId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_EventNotificationDisable {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationDisable codeSample = new UpdoxCodeSample_EventNotificationDisable();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationDisable";

		EventNotificationDisableRequest eventNotificationDisableRequest = new EventNotificationDisableRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationDisableRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		eventNotificationDisableRequest.setNotificationId("notificationId");
		eventNotificationDisableRequest.setInternalId("internalId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationDisableRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationDisable', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationDisableResponse eventNotificationDisableResponse = mapper.readValue(jsonResponse, EventNotificationDisableResponse.class);

		System.out.println(eventNotificationDisableResponse.getResponseCode());
		System.out.println(eventNotificationDisableResponse.getResponseMessage());
	}

	private class EventNotificationDisableRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String notificationId;
    	private String internalId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(String notificationId) {
			this.notificationId = notificationId;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class EventNotificationDisableResponse extends UpdoxResponse {
		private String notificationId;


		public String getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(String notificationId) {
			this.notificationId = notificationId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`4094`	`record does not exist`
`4095`	`record invalid for action`
`4096`	`record not acceptable`

EventNotificationStatusesGetByBulkIds /io/EventNotificationStatusesGetByBulkIds

Get statuses from a list of bulk notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
bulkNotificationIds	List	add remove	The notification IDs to get statuses from based on the bulk id. The value(s) must be numeric values.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByBulkIds

Get statuses from a list of bulk notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByBulkIds {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByBulkIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByBulkIds();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByBulkIds";
			EventNotificationStatusesGetByBulkIdsRequest eventNotificationStatusesGetByBulkIdsRequest = new EventNotificationStatusesGetByBulkIdsRequest();

			//set up credentials
			eventNotificationStatusesGetByBulkIdsRequest.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByBulkIdsRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByBulkIdsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> bulkNotificationIds = new List<string>();
			string bulkNotificationIdsString = "bulkNotificationIds";
			bulkNotificationIds.Add(bulkNotificationIdsString);
			eventNotificationStatusesGetByBulkIdsRequest.bulkNotificationIds = bulkNotificationIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByBulkIdsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByBulkIds", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByBulkIdsResponse eventNotificationStatusesGetByBulkIdsResponse = javascriptSerializer.Deserialize<EventNotificationStatusesGetByBulkIdsResponse>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByBulkIdsResponse.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByBulkIdsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByBulkIdsRequest : UpdoxRequest {
			public List<string> bulkNotificationIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class EventNotificationStatus {
			public long notificationId { get; set;}
			public string internalId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public string reply { get; set;}
		}

		public class EventNotificationStatusesGetByBulkIdsResponse : UpdoxResponse {
			public List<EventNotificationStatus> eventNotificationStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByBulkIds {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByBulkIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByBulkIds();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByBulkIds";

		EventNotificationStatusesGetByBulkIdsRequest eventNotificationStatusesGetByBulkIdsRequest = new EventNotificationStatusesGetByBulkIdsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByBulkIdsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> bulkNotificationIds = new ArrayList<>();
		String bulkNotificationIdsString = "bulkNotificationIds";
		bulkNotificationIds.add(bulkNotificationIdsString);
		eventNotificationStatusesGetByBulkIdsRequest.setBulkNotificationIds(bulkNotificationIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByBulkIdsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByBulkIds', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByBulkIdsResponse eventNotificationStatusesGetByBulkIdsResponse = mapper.readValue(jsonResponse, EventNotificationStatusesGetByBulkIdsResponse.class);

		System.out.println(eventNotificationStatusesGetByBulkIdsResponse.getResponseCode());
		System.out.println(eventNotificationStatusesGetByBulkIdsResponse.getResponseMessage());
	}

	private class EventNotificationStatusesGetByBulkIdsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> bulkNotificationIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getBulkNotificationIds() {
			return bulkNotificationIds;
		}

		public void setBulkNotificationIds(List<String> bulkNotificationIds) {
			this.bulkNotificationIds = bulkNotificationIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class EventNotificationStatus {
		private long notificationId;
		private String internalId;
		private String status;
		private String statusDttm;
		private String reply;


		public long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(long notificationId) {
			this.notificationId = notificationId;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class EventNotificationStatusesGetByBulkIdsResponse extends UpdoxResponse {
		private List<EventNotificationStatus> eventNotificationStatuses;


		public List<EventNotificationStatus> getEventNotificationStatuses() {
			return eventNotificationStatuses;
		}

		public void setEventNotificationStatuses(List<EventNotificationStatus> eventNotificationStatuses) {
			this.eventNotificationStatuses = eventNotificationStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

EventNotificationStatusesGetByBulkIds/1.1 /io/EventNotificationStatusesGetByBulkIds/1.1

Version 1.1 - Get statuses from a list of bulk notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
bulkNotificationIds	List	add remove	The notification IDs to get statuses from based on the bulk id. The value(s) must be numeric values.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByBulkIds/1.1

Version 1.1 - Get statuses from a list of bulk notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByBulkIds1_1";
			EventNotificationStatusesGetByBulkIds1_1Request eventNotificationStatusesGetByBulkIds1_1Request = new EventNotificationStatusesGetByBulkIds1_1Request();

			//set up credentials
			eventNotificationStatusesGetByBulkIds1_1Request.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByBulkIds1_1Request.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByBulkIds1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> bulkNotificationIds = new List<string>();
			string bulkNotificationIdsString = "bulkNotificationIds";
			bulkNotificationIds.Add(bulkNotificationIdsString);
			eventNotificationStatusesGetByBulkIds1_1Request.bulkNotificationIds = bulkNotificationIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByBulkIds1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByBulkIds/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByBulkIds1_1Response eventNotificationStatusesGetByBulkIds1_1Response = javascriptSerializer.Deserialize<EventNotificationStatusesGetByBulkIds1_1Response>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByBulkIds1_1Response.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByBulkIds1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByBulkIds1_1Request : UpdoxRequest {
			public List<string> bulkNotificationIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class _FailedRequestParameter {
			public string requestParameter { get; set;}
			public string failReason { get; set;}
		}

		public class _Notification {
			public long notificationId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public long scriptId { get; set;}
			public string scriptLanguage { get; set;}
			public string deliveryMethod { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryDttm { get; set;}
			public string internalId { get; set;}
			public string createDttm { get; set;}
			public string reply { get; set;}
		}

		public class _BulkNotification {
			public long bulkId { get; set;}
			public string bulkStatus { get; set;}
			public string bulkStatusDttm { get; set;}
			public long bulkRequestSize { get; set;}
			public long bulkValidNotifications { get; set;}
			public long bulkInvalidNotifications { get; set;}
			public string bulkCreateDttm { get; set;}
			public List<_Notification> bulkNotifications { get; set;}
		}

		public class EventNotificationStatusesGetByBulkIds1_1Response : UpdoxResponse {
			public List<_FailedRequestParameter> failedRequestParameters { get; set;}
			public List<_BulkNotification> bulkInfos { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByBulkIds1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByBulkIds1_1";

		EventNotificationStatusesGetByBulkIds1_1Request eventNotificationStatusesGetByBulkIds1_1Request = new EventNotificationStatusesGetByBulkIds1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByBulkIds1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> bulkNotificationIds = new ArrayList<>();
		String bulkNotificationIdsString = "bulkNotificationIds";
		bulkNotificationIds.add(bulkNotificationIdsString);
		eventNotificationStatusesGetByBulkIds1_1Request.setBulkNotificationIds(bulkNotificationIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByBulkIds1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByBulkIds/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByBulkIds1_1Response eventNotificationStatusesGetByBulkIds1_1Response = mapper.readValue(jsonResponse, EventNotificationStatusesGetByBulkIds1_1Response.class);

		System.out.println(eventNotificationStatusesGetByBulkIds1_1Response.getResponseCode());
		System.out.println(eventNotificationStatusesGetByBulkIds1_1Response.getResponseMessage());
	}

	private class EventNotificationStatusesGetByBulkIds1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> bulkNotificationIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getBulkNotificationIds() {
			return bulkNotificationIds;
		}

		public void setBulkNotificationIds(List<String> bulkNotificationIds) {
			this.bulkNotificationIds = bulkNotificationIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class _FailedRequestParameter {
		private String requestParameter;
		private String failReason;


		public String getRequestParameter() {
			return requestParameter;
		}

		public void setRequestParameter(String requestParameter) {
			this.requestParameter = requestParameter;
		}

		public String getFailReason() {
			return failReason;
		}

		public void setFailReason(String failReason) {
			this.failReason = failReason;
		}
	}

	private static class _Notification {
		private Long notificationId;
		private String status;
		private String statusDttm;
		private Long scriptId;
		private String scriptLanguage;
		private String deliveryMethod;
		private String deliveryDestination;
		private String deliveryDttm;
		private String internalId;
		private String createDttm;
		private String reply;


		public Long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(Long notificationId) {
			this.notificationId = notificationId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public Long getScriptId() {
			return scriptId;
		}

		public void setScriptId(Long scriptId) {
			this.scriptId = scriptId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryDttm() {
			return deliveryDttm;
		}

		public void setDeliveryDttm(String deliveryDttm) {
			this.deliveryDttm = deliveryDttm;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getCreateDttm() {
			return createDttm;
		}

		public void setCreateDttm(String createDttm) {
			this.createDttm = createDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class _BulkNotification {
		private Long bulkId;
		private String bulkStatus;
		private String bulkStatusDttm;
		private Long bulkRequestSize;
		private Long bulkValidNotifications;
		private Long bulkInvalidNotifications;
		private String bulkCreateDttm;
		private List<_Notification> bulkNotifications;


		public Long getBulkId() {
			return bulkId;
		}

		public void setBulkId(Long bulkId) {
			this.bulkId = bulkId;
		}

		public String getBulkStatus() {
			return bulkStatus;
		}

		public void setBulkStatus(String bulkStatus) {
			this.bulkStatus = bulkStatus;
		}

		public String getBulkStatusDttm() {
			return bulkStatusDttm;
		}

		public void setBulkStatusDttm(String bulkStatusDttm) {
			this.bulkStatusDttm = bulkStatusDttm;
		}

		public Long getBulkRequestSize() {
			return bulkRequestSize;
		}

		public void setBulkRequestSize(Long bulkRequestSize) {
			this.bulkRequestSize = bulkRequestSize;
		}

		public Long getBulkValidNotifications() {
			return bulkValidNotifications;
		}

		public void setBulkValidNotifications(Long bulkValidNotifications) {
			this.bulkValidNotifications = bulkValidNotifications;
		}

		public Long getBulkInvalidNotifications() {
			return bulkInvalidNotifications;
		}

		public void setBulkInvalidNotifications(Long bulkInvalidNotifications) {
			this.bulkInvalidNotifications = bulkInvalidNotifications;
		}

		public String getBulkCreateDttm() {
			return bulkCreateDttm;
		}

		public void setBulkCreateDttm(String bulkCreateDttm) {
			this.bulkCreateDttm = bulkCreateDttm;
		}

		public List<_Notification> getBulkNotifications() {
			return bulkNotifications;
		}

		public void setBulkNotifications(List<_Notification> bulkNotifications) {
			this.bulkNotifications = bulkNotifications;
		}
	}

	private static class EventNotificationStatusesGetByBulkIds1_1Response extends UpdoxResponse {
		private List<_FailedRequestParameter> failedRequestParameters;
		private List<_BulkNotification> bulkInfos;


		public List<_FailedRequestParameter> getFailedRequestParameters() {
			return failedRequestParameters;
		}

		public void setFailedRequestParameters(List<_FailedRequestParameter> failedRequestParameters) {
			this.failedRequestParameters = failedRequestParameters;
		}

		public List<_BulkNotification> getBulkInfos() {
			return bulkInfos;
		}

		public void setBulkInfos(List<_BulkNotification> bulkInfos) {
			this.bulkInfos = bulkInfos;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

EventNotificationStatusesGetByDate /io/EventNotificationStatusesGetByDate

Get statuses from a date or a date range. Specifying only a from date will indicate to only get statuses for that date.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
dateFrom	String		The notification start date to get statuses from. This is required.
dateTo	String		The notification end date to get statuses up to.

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByDate

Get statuses from a date or a date range. Specifying only a from date will indicate to only get statuses for that date.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByDate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByDate codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByDate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByDate";
			EventNotificationStatusesGetByDateRequest eventNotificationStatusesGetByDateRequest = new EventNotificationStatusesGetByDateRequest();

			//set up credentials
			eventNotificationStatusesGetByDateRequest.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByDateRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByDateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			eventNotificationStatusesGetByDateRequest.dateFrom = "dateFrom";
			eventNotificationStatusesGetByDateRequest.dateTo = "dateTo";

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByDateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByDate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByDateResponse eventNotificationStatusesGetByDateResponse = javascriptSerializer.Deserialize<EventNotificationStatusesGetByDateResponse>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByDateResponse.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByDateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByDateRequest : UpdoxRequest {
			public string dateFrom { get; set;}
			public string dateTo { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class EventNotificationStatus {
			public long notificationId { get; set;}
			public string internalId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public string reply { get; set;}
		}

		public class EventNotificationStatusesGetByDateResponse : UpdoxResponse {
			public List<EventNotificationStatus> eventNotificationStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByDate {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByDate codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByDate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByDate";

		EventNotificationStatusesGetByDateRequest eventNotificationStatusesGetByDateRequest = new EventNotificationStatusesGetByDateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByDateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		eventNotificationStatusesGetByDateRequest.setDateFrom("dateFrom");
		eventNotificationStatusesGetByDateRequest.setDateTo("dateTo");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByDateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByDate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByDateResponse eventNotificationStatusesGetByDateResponse = mapper.readValue(jsonResponse, EventNotificationStatusesGetByDateResponse.class);

		System.out.println(eventNotificationStatusesGetByDateResponse.getResponseCode());
		System.out.println(eventNotificationStatusesGetByDateResponse.getResponseMessage());
	}

	private class EventNotificationStatusesGetByDateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String dateFrom;
    	private String dateTo;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getDateFrom() {
			return dateFrom;
		}

		public void setDateFrom(String dateFrom) {
			this.dateFrom = dateFrom;
		}

		public String getDateTo() {
			return dateTo;
		}

		public void setDateTo(String dateTo) {
			this.dateTo = dateTo;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class EventNotificationStatus {
		private long notificationId;
		private String internalId;
		private String status;
		private String statusDttm;
		private String reply;


		public long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(long notificationId) {
			this.notificationId = notificationId;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class EventNotificationStatusesGetByDateResponse extends UpdoxResponse {
		private List<EventNotificationStatus> eventNotificationStatuses;


		public List<EventNotificationStatus> getEventNotificationStatuses() {
			return eventNotificationStatuses;
		}

		public void setEventNotificationStatuses(List<EventNotificationStatus> eventNotificationStatuses) {
			this.eventNotificationStatuses = eventNotificationStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`9010`	`the date format must be in the format is yyyy-MM-dd`

EventNotificationStatusesGetByDate/1.1 /io/EventNotificationStatusesGetByDate/1.1

Version 1.1 - Get statuses from a date or a date range. Specifying only a from date will indicate to only get statuses for that date.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
dateFrom	String		The notification start date to get statuses from. This is required.
dateTo	String		The notification end date to get statuses up to.

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByDate/1.1

Version 1.1 - Get statuses from a date or a date range. Specifying only a from date will indicate to only get statuses for that date.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByDate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByDate1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByDate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByDate1_1";
			EventNotificationStatusesGetByDate1_1Request eventNotificationStatusesGetByDate1_1Request = new EventNotificationStatusesGetByDate1_1Request();

			//set up credentials
			eventNotificationStatusesGetByDate1_1Request.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByDate1_1Request.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByDate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			eventNotificationStatusesGetByDate1_1Request.dateFrom = "dateFrom";
			eventNotificationStatusesGetByDate1_1Request.dateTo = "dateTo";

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByDate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByDate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByDate1_1Response eventNotificationStatusesGetByDate1_1Response = javascriptSerializer.Deserialize<EventNotificationStatusesGetByDate1_1Response>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByDate1_1Response.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByDate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByDate1_1Request : UpdoxRequest {
			public string dateFrom { get; set;}
			public string dateTo { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class _FailedRequestParameter {
			public string requestParameter { get; set;}
			public string failReason { get; set;}
		}

		public class _Notification {
			public long notificationId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public long scriptId { get; set;}
			public string scriptLanguage { get; set;}
			public string deliveryMethod { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryDttm { get; set;}
			public string internalId { get; set;}
			public string createDttm { get; set;}
			public string reply { get; set;}
		}

		public class _BulkNotification {
			public long bulkId { get; set;}
			public string bulkStatus { get; set;}
			public string bulkStatusDttm { get; set;}
			public long bulkRequestSize { get; set;}
			public long bulkValidNotifications { get; set;}
			public long bulkInvalidNotifications { get; set;}
			public string bulkCreateDttm { get; set;}
			public List<_Notification> bulkNotifications { get; set;}
		}

		public class EventNotificationStatusesGetByDate1_1Response : UpdoxResponse {
			public List<_FailedRequestParameter> failedRequestParameters { get; set;}
			public List<_BulkNotification> bulkInfos { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByDate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByDate1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByDate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByDate1_1";

		EventNotificationStatusesGetByDate1_1Request eventNotificationStatusesGetByDate1_1Request = new EventNotificationStatusesGetByDate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByDate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		eventNotificationStatusesGetByDate1_1Request.setDateFrom("dateFrom");
		eventNotificationStatusesGetByDate1_1Request.setDateTo("dateTo");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByDate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByDate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByDate1_1Response eventNotificationStatusesGetByDate1_1Response = mapper.readValue(jsonResponse, EventNotificationStatusesGetByDate1_1Response.class);

		System.out.println(eventNotificationStatusesGetByDate1_1Response.getResponseCode());
		System.out.println(eventNotificationStatusesGetByDate1_1Response.getResponseMessage());
	}

	private class EventNotificationStatusesGetByDate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String dateFrom;
    	private String dateTo;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getDateFrom() {
			return dateFrom;
		}

		public void setDateFrom(String dateFrom) {
			this.dateFrom = dateFrom;
		}

		public String getDateTo() {
			return dateTo;
		}

		public void setDateTo(String dateTo) {
			this.dateTo = dateTo;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class _FailedRequestParameter {
		private String requestParameter;
		private String failReason;


		public String getRequestParameter() {
			return requestParameter;
		}

		public void setRequestParameter(String requestParameter) {
			this.requestParameter = requestParameter;
		}

		public String getFailReason() {
			return failReason;
		}

		public void setFailReason(String failReason) {
			this.failReason = failReason;
		}
	}

	private static class _Notification {
		private Long notificationId;
		private String status;
		private String statusDttm;
		private Long scriptId;
		private String scriptLanguage;
		private String deliveryMethod;
		private String deliveryDestination;
		private String deliveryDttm;
		private String internalId;
		private String createDttm;
		private String reply;


		public Long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(Long notificationId) {
			this.notificationId = notificationId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public Long getScriptId() {
			return scriptId;
		}

		public void setScriptId(Long scriptId) {
			this.scriptId = scriptId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryDttm() {
			return deliveryDttm;
		}

		public void setDeliveryDttm(String deliveryDttm) {
			this.deliveryDttm = deliveryDttm;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getCreateDttm() {
			return createDttm;
		}

		public void setCreateDttm(String createDttm) {
			this.createDttm = createDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class _BulkNotification {
		private Long bulkId;
		private String bulkStatus;
		private String bulkStatusDttm;
		private Long bulkRequestSize;
		private Long bulkValidNotifications;
		private Long bulkInvalidNotifications;
		private String bulkCreateDttm;
		private List<_Notification> bulkNotifications;


		public Long getBulkId() {
			return bulkId;
		}

		public void setBulkId(Long bulkId) {
			this.bulkId = bulkId;
		}

		public String getBulkStatus() {
			return bulkStatus;
		}

		public void setBulkStatus(String bulkStatus) {
			this.bulkStatus = bulkStatus;
		}

		public String getBulkStatusDttm() {
			return bulkStatusDttm;
		}

		public void setBulkStatusDttm(String bulkStatusDttm) {
			this.bulkStatusDttm = bulkStatusDttm;
		}

		public Long getBulkRequestSize() {
			return bulkRequestSize;
		}

		public void setBulkRequestSize(Long bulkRequestSize) {
			this.bulkRequestSize = bulkRequestSize;
		}

		public Long getBulkValidNotifications() {
			return bulkValidNotifications;
		}

		public void setBulkValidNotifications(Long bulkValidNotifications) {
			this.bulkValidNotifications = bulkValidNotifications;
		}

		public Long getBulkInvalidNotifications() {
			return bulkInvalidNotifications;
		}

		public void setBulkInvalidNotifications(Long bulkInvalidNotifications) {
			this.bulkInvalidNotifications = bulkInvalidNotifications;
		}

		public String getBulkCreateDttm() {
			return bulkCreateDttm;
		}

		public void setBulkCreateDttm(String bulkCreateDttm) {
			this.bulkCreateDttm = bulkCreateDttm;
		}

		public List<_Notification> getBulkNotifications() {
			return bulkNotifications;
		}

		public void setBulkNotifications(List<_Notification> bulkNotifications) {
			this.bulkNotifications = bulkNotifications;
		}
	}

	private static class EventNotificationStatusesGetByDate1_1Response extends UpdoxResponse {
		private List<_FailedRequestParameter> failedRequestParameters;
		private List<_BulkNotification> bulkInfos;


		public List<_FailedRequestParameter> getFailedRequestParameters() {
			return failedRequestParameters;
		}

		public void setFailedRequestParameters(List<_FailedRequestParameter> failedRequestParameters) {
			this.failedRequestParameters = failedRequestParameters;
		}

		public List<_BulkNotification> getBulkInfos() {
			return bulkInfos;
		}

		public void setBulkInfos(List<_BulkNotification> bulkInfos) {
			this.bulkInfos = bulkInfos;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`9010`	`the date format must be in the format is yyyy-MM-dd`

EventNotificationStatusesGetByIds /io/EventNotificationStatusesGetByIds

Get statuses from a list of notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
eventNotificationIds	List	add remove	The notification IDs to get statuses from. The value(s) must be numeric values.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByIds

Get statuses from a list of notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByIds {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByIds();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByIds";
			EventNotificationStatusesGetByIdsRequest eventNotificationStatusesGetByIdsRequest = new EventNotificationStatusesGetByIdsRequest();

			//set up credentials
			eventNotificationStatusesGetByIdsRequest.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByIdsRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByIdsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> eventNotificationIds = new List<string>();
			string eventNotificationIdsString = "eventNotificationIds";
			eventNotificationIds.Add(eventNotificationIdsString);
			eventNotificationStatusesGetByIdsRequest.eventNotificationIds = eventNotificationIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByIdsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByIds", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByIdsResponse eventNotificationStatusesGetByIdsResponse = javascriptSerializer.Deserialize<EventNotificationStatusesGetByIdsResponse>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByIdsResponse.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByIdsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByIdsRequest : UpdoxRequest {
			public List<string> eventNotificationIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class EventNotificationStatus {
			public long notificationId { get; set;}
			public string internalId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public string reply { get; set;}
		}

		public class EventNotificationStatusesGetByIdsResponse : UpdoxResponse {
			public List<EventNotificationStatus> eventNotificationStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByIds {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByIds();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByIds";

		EventNotificationStatusesGetByIdsRequest eventNotificationStatusesGetByIdsRequest = new EventNotificationStatusesGetByIdsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByIdsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> eventNotificationIds = new ArrayList<>();
		String eventNotificationIdsString = "eventNotificationIds";
		eventNotificationIds.add(eventNotificationIdsString);
		eventNotificationStatusesGetByIdsRequest.setEventNotificationIds(eventNotificationIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByIdsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByIds', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByIdsResponse eventNotificationStatusesGetByIdsResponse = mapper.readValue(jsonResponse, EventNotificationStatusesGetByIdsResponse.class);

		System.out.println(eventNotificationStatusesGetByIdsResponse.getResponseCode());
		System.out.println(eventNotificationStatusesGetByIdsResponse.getResponseMessage());
	}

	private class EventNotificationStatusesGetByIdsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> eventNotificationIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getEventNotificationIds() {
			return eventNotificationIds;
		}

		public void setEventNotificationIds(List<String> eventNotificationIds) {
			this.eventNotificationIds = eventNotificationIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class EventNotificationStatus {
		private long notificationId;
		private String internalId;
		private String status;
		private String statusDttm;
		private String reply;


		public long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(long notificationId) {
			this.notificationId = notificationId;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class EventNotificationStatusesGetByIdsResponse extends UpdoxResponse {
		private List<EventNotificationStatus> eventNotificationStatuses;


		public List<EventNotificationStatus> getEventNotificationStatuses() {
			return eventNotificationStatuses;
		}

		public void setEventNotificationStatuses(List<EventNotificationStatus> eventNotificationStatuses) {
			this.eventNotificationStatuses = eventNotificationStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

EventNotificationStatusesGetByIds/1.1 /io/EventNotificationStatusesGetByIds/1.1

Version 1.1 - Get statuses from a list of notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
eventNotificationIds	List	add remove	The notification IDs to get statuses from. The value(s) must be numeric values.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByIds/1.1

Version 1.1 - Get statuses from a list of notification IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByIds1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByIds1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByIds1_1";
			EventNotificationStatusesGetByIds1_1Request eventNotificationStatusesGetByIds1_1Request = new EventNotificationStatusesGetByIds1_1Request();

			//set up credentials
			eventNotificationStatusesGetByIds1_1Request.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByIds1_1Request.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByIds1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> eventNotificationIds = new List<string>();
			string eventNotificationIdsString = "eventNotificationIds";
			eventNotificationIds.Add(eventNotificationIdsString);
			eventNotificationStatusesGetByIds1_1Request.eventNotificationIds = eventNotificationIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByIds1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByIds/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByIds1_1Response eventNotificationStatusesGetByIds1_1Response = javascriptSerializer.Deserialize<EventNotificationStatusesGetByIds1_1Response>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByIds1_1Response.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByIds1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByIds1_1Request : UpdoxRequest {
			public List<string> eventNotificationIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class _FailedRequestParameter {
			public string requestParameter { get; set;}
			public string failReason { get; set;}
		}

		public class _Notification {
			public long notificationId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public long scriptId { get; set;}
			public string scriptLanguage { get; set;}
			public string deliveryMethod { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryDttm { get; set;}
			public string internalId { get; set;}
			public string createDttm { get; set;}
			public string reply { get; set;}
		}

		public class _BulkNotification {
			public long bulkId { get; set;}
			public string bulkStatus { get; set;}
			public string bulkStatusDttm { get; set;}
			public long bulkRequestSize { get; set;}
			public long bulkValidNotifications { get; set;}
			public long bulkInvalidNotifications { get; set;}
			public string bulkCreateDttm { get; set;}
			public List<_Notification> bulkNotifications { get; set;}
		}

		public class EventNotificationStatusesGetByIds1_1Response : UpdoxResponse {
			public List<_FailedRequestParameter> failedRequestParameters { get; set;}
			public List<_BulkNotification> bulkInfos { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByIds1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByIds1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByIds1_1";

		EventNotificationStatusesGetByIds1_1Request eventNotificationStatusesGetByIds1_1Request = new EventNotificationStatusesGetByIds1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByIds1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> eventNotificationIds = new ArrayList<>();
		String eventNotificationIdsString = "eventNotificationIds";
		eventNotificationIds.add(eventNotificationIdsString);
		eventNotificationStatusesGetByIds1_1Request.setEventNotificationIds(eventNotificationIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByIds1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByIds/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByIds1_1Response eventNotificationStatusesGetByIds1_1Response = mapper.readValue(jsonResponse, EventNotificationStatusesGetByIds1_1Response.class);

		System.out.println(eventNotificationStatusesGetByIds1_1Response.getResponseCode());
		System.out.println(eventNotificationStatusesGetByIds1_1Response.getResponseMessage());
	}

	private class EventNotificationStatusesGetByIds1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> eventNotificationIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getEventNotificationIds() {
			return eventNotificationIds;
		}

		public void setEventNotificationIds(List<String> eventNotificationIds) {
			this.eventNotificationIds = eventNotificationIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class _FailedRequestParameter {
		private String requestParameter;
		private String failReason;


		public String getRequestParameter() {
			return requestParameter;
		}

		public void setRequestParameter(String requestParameter) {
			this.requestParameter = requestParameter;
		}

		public String getFailReason() {
			return failReason;
		}

		public void setFailReason(String failReason) {
			this.failReason = failReason;
		}
	}

	private static class _Notification {
		private Long notificationId;
		private String status;
		private String statusDttm;
		private Long scriptId;
		private String scriptLanguage;
		private String deliveryMethod;
		private String deliveryDestination;
		private String deliveryDttm;
		private String internalId;
		private String createDttm;
		private String reply;


		public Long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(Long notificationId) {
			this.notificationId = notificationId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public Long getScriptId() {
			return scriptId;
		}

		public void setScriptId(Long scriptId) {
			this.scriptId = scriptId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryDttm() {
			return deliveryDttm;
		}

		public void setDeliveryDttm(String deliveryDttm) {
			this.deliveryDttm = deliveryDttm;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getCreateDttm() {
			return createDttm;
		}

		public void setCreateDttm(String createDttm) {
			this.createDttm = createDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class _BulkNotification {
		private Long bulkId;
		private String bulkStatus;
		private String bulkStatusDttm;
		private Long bulkRequestSize;
		private Long bulkValidNotifications;
		private Long bulkInvalidNotifications;
		private String bulkCreateDttm;
		private List<_Notification> bulkNotifications;


		public Long getBulkId() {
			return bulkId;
		}

		public void setBulkId(Long bulkId) {
			this.bulkId = bulkId;
		}

		public String getBulkStatus() {
			return bulkStatus;
		}

		public void setBulkStatus(String bulkStatus) {
			this.bulkStatus = bulkStatus;
		}

		public String getBulkStatusDttm() {
			return bulkStatusDttm;
		}

		public void setBulkStatusDttm(String bulkStatusDttm) {
			this.bulkStatusDttm = bulkStatusDttm;
		}

		public Long getBulkRequestSize() {
			return bulkRequestSize;
		}

		public void setBulkRequestSize(Long bulkRequestSize) {
			this.bulkRequestSize = bulkRequestSize;
		}

		public Long getBulkValidNotifications() {
			return bulkValidNotifications;
		}

		public void setBulkValidNotifications(Long bulkValidNotifications) {
			this.bulkValidNotifications = bulkValidNotifications;
		}

		public Long getBulkInvalidNotifications() {
			return bulkInvalidNotifications;
		}

		public void setBulkInvalidNotifications(Long bulkInvalidNotifications) {
			this.bulkInvalidNotifications = bulkInvalidNotifications;
		}

		public String getBulkCreateDttm() {
			return bulkCreateDttm;
		}

		public void setBulkCreateDttm(String bulkCreateDttm) {
			this.bulkCreateDttm = bulkCreateDttm;
		}

		public List<_Notification> getBulkNotifications() {
			return bulkNotifications;
		}

		public void setBulkNotifications(List<_Notification> bulkNotifications) {
			this.bulkNotifications = bulkNotifications;
		}
	}

	private static class EventNotificationStatusesGetByIds1_1Response extends UpdoxResponse {
		private List<_FailedRequestParameter> failedRequestParameters;
		private List<_BulkNotification> bulkInfos;


		public List<_FailedRequestParameter> getFailedRequestParameters() {
			return failedRequestParameters;
		}

		public void setFailedRequestParameters(List<_FailedRequestParameter> failedRequestParameters) {
			this.failedRequestParameters = failedRequestParameters;
		}

		public List<_BulkNotification> getBulkInfos() {
			return bulkInfos;
		}

		public void setBulkInfos(List<_BulkNotification> bulkInfos) {
			this.bulkInfos = bulkInfos;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

EventNotificationStatusesGetByInternalIds /io/EventNotificationStatusesGetByInternalIds

Get statuses from a list of internal IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
internalIds	List	add remove	The notification internal IDs to get statuses from.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByInternalIds

Get statuses from a list of internal IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByInternalIds {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByInternalIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByInternalIds();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByInternalIds";
			EventNotificationStatusesGetByInternalIdsRequest eventNotificationStatusesGetByInternalIdsRequest = new EventNotificationStatusesGetByInternalIdsRequest();

			//set up credentials
			eventNotificationStatusesGetByInternalIdsRequest.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByInternalIdsRequest.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByInternalIdsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> internalIds = new List<string>();
			string internalIdsString = "internalIds";
			internalIds.Add(internalIdsString);
			eventNotificationStatusesGetByInternalIdsRequest.internalIds = internalIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByInternalIdsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByInternalIds", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByInternalIdsResponse eventNotificationStatusesGetByInternalIdsResponse = javascriptSerializer.Deserialize<EventNotificationStatusesGetByInternalIdsResponse>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByInternalIdsResponse.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByInternalIdsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByInternalIdsRequest : UpdoxRequest {
			public List<string> internalIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class EventNotificationStatus {
			public long notificationId { get; set;}
			public string internalId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public string reply { get; set;}
		}

		public class EventNotificationStatusesGetByInternalIdsResponse : UpdoxResponse {
			public List<EventNotificationStatus> eventNotificationStatuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByInternalIds {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByInternalIds codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByInternalIds();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByInternalIds";

		EventNotificationStatusesGetByInternalIdsRequest eventNotificationStatusesGetByInternalIdsRequest = new EventNotificationStatusesGetByInternalIdsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByInternalIdsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> internalIds = new ArrayList<>();
		String internalIdsString = "internalIds";
		internalIds.add(internalIdsString);
		eventNotificationStatusesGetByInternalIdsRequest.setInternalIds(internalIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByInternalIdsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByInternalIds', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByInternalIdsResponse eventNotificationStatusesGetByInternalIdsResponse = mapper.readValue(jsonResponse, EventNotificationStatusesGetByInternalIdsResponse.class);

		System.out.println(eventNotificationStatusesGetByInternalIdsResponse.getResponseCode());
		System.out.println(eventNotificationStatusesGetByInternalIdsResponse.getResponseMessage());
	}

	private class EventNotificationStatusesGetByInternalIdsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> internalIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getInternalIds() {
			return internalIds;
		}

		public void setInternalIds(List<String> internalIds) {
			this.internalIds = internalIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class EventNotificationStatus {
		private long notificationId;
		private String internalId;
		private String status;
		private String statusDttm;
		private String reply;


		public long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(long notificationId) {
			this.notificationId = notificationId;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class EventNotificationStatusesGetByInternalIdsResponse extends UpdoxResponse {
		private List<EventNotificationStatus> eventNotificationStatuses;


		public List<EventNotificationStatus> getEventNotificationStatuses() {
			return eventNotificationStatuses;
		}

		public void setEventNotificationStatuses(List<EventNotificationStatus> eventNotificationStatuses) {
			this.eventNotificationStatuses = eventNotificationStatuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

EventNotificationStatusesGetByInternalIds/1.1 /io/EventNotificationStatusesGetByInternalIds/1.1

Version 1.1 - Get statuses from a list of internal IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
internalIds	List	add remove	The notification internal IDs to get statuses from.

	String

Try it! Toggle Notes/Code Samples

EventNotificationStatusesGetByInternalIds/1.1

Version 1.1 - Get statuses from a list of internal IDs

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EventNotificationStatusesGetByInternalIds1_1";
			EventNotificationStatusesGetByInternalIds1_1Request eventNotificationStatusesGetByInternalIds1_1Request = new EventNotificationStatusesGetByInternalIds1_1Request();

			//set up credentials
			eventNotificationStatusesGetByInternalIds1_1Request.auth.applicationId = "applicationId";
			eventNotificationStatusesGetByInternalIds1_1Request.auth.applicationPassword = "applicationPassword";
			eventNotificationStatusesGetByInternalIds1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> internalIds = new List<string>();
			string internalIdsString = "internalIds";
			internalIds.Add(internalIdsString);
			eventNotificationStatusesGetByInternalIds1_1Request.internalIds = internalIds;

			//create the request
			string json = Utilities.buildRequestJson(eventNotificationStatusesGetByInternalIds1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EventNotificationStatusesGetByInternalIds/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EventNotificationStatusesGetByInternalIds1_1Response eventNotificationStatusesGetByInternalIds1_1Response = javascriptSerializer.Deserialize<EventNotificationStatusesGetByInternalIds1_1Response>(jsonResponse);

			Console.WriteLine(eventNotificationStatusesGetByInternalIds1_1Response.responseCode);
			Console.WriteLine(eventNotificationStatusesGetByInternalIds1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class EventNotificationStatusesGetByInternalIds1_1Request : UpdoxRequest {
			public List<string> internalIds { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class _FailedRequestParameter {
			public string requestParameter { get; set;}
			public string failReason { get; set;}
		}

		public class _Notification {
			public long notificationId { get; set;}
			public string status { get; set;}
			public string statusDttm { get; set;}
			public long scriptId { get; set;}
			public string scriptLanguage { get; set;}
			public string deliveryMethod { get; set;}
			public string deliveryDestination { get; set;}
			public string deliveryDttm { get; set;}
			public string internalId { get; set;}
			public string createDttm { get; set;}
			public string reply { get; set;}
		}

		public class _BulkNotification {
			public long bulkId { get; set;}
			public string bulkStatus { get; set;}
			public string bulkStatusDttm { get; set;}
			public long bulkRequestSize { get; set;}
			public long bulkValidNotifications { get; set;}
			public long bulkInvalidNotifications { get; set;}
			public string bulkCreateDttm { get; set;}
			public List<_Notification> bulkNotifications { get; set;}
		}

		public class EventNotificationStatusesGetByInternalIds1_1Response : UpdoxResponse {
			public List<_FailedRequestParameter> failedRequestParameters { get; set;}
			public List<_BulkNotification> bulkInfos { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1 codeSample = new UpdoxCodeSample_EventNotificationStatusesGetByInternalIds1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EventNotificationStatusesGetByInternalIds1_1";

		EventNotificationStatusesGetByInternalIds1_1Request eventNotificationStatusesGetByInternalIds1_1Request = new EventNotificationStatusesGetByInternalIds1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = eventNotificationStatusesGetByInternalIds1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> internalIds = new ArrayList<>();
		String internalIdsString = "internalIds";
		internalIds.add(internalIdsString);
		eventNotificationStatusesGetByInternalIds1_1Request.setInternalIds(internalIds);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(eventNotificationStatusesGetByInternalIds1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EventNotificationStatusesGetByInternalIds/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EventNotificationStatusesGetByInternalIds1_1Response eventNotificationStatusesGetByInternalIds1_1Response = mapper.readValue(jsonResponse, EventNotificationStatusesGetByInternalIds1_1Response.class);

		System.out.println(eventNotificationStatusesGetByInternalIds1_1Response.getResponseCode());
		System.out.println(eventNotificationStatusesGetByInternalIds1_1Response.getResponseMessage());
	}

	private class EventNotificationStatusesGetByInternalIds1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> internalIds;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getInternalIds() {
			return internalIds;
		}

		public void setInternalIds(List<String> internalIds) {
			this.internalIds = internalIds;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class _FailedRequestParameter {
		private String requestParameter;
		private String failReason;


		public String getRequestParameter() {
			return requestParameter;
		}

		public void setRequestParameter(String requestParameter) {
			this.requestParameter = requestParameter;
		}

		public String getFailReason() {
			return failReason;
		}

		public void setFailReason(String failReason) {
			this.failReason = failReason;
		}
	}

	private static class _Notification {
		private Long notificationId;
		private String status;
		private String statusDttm;
		private Long scriptId;
		private String scriptLanguage;
		private String deliveryMethod;
		private String deliveryDestination;
		private String deliveryDttm;
		private String internalId;
		private String createDttm;
		private String reply;


		public Long getNotificationId() {
			return notificationId;
		}

		public void setNotificationId(Long notificationId) {
			this.notificationId = notificationId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getStatusDttm() {
			return statusDttm;
		}

		public void setStatusDttm(String statusDttm) {
			this.statusDttm = statusDttm;
		}

		public Long getScriptId() {
			return scriptId;
		}

		public void setScriptId(Long scriptId) {
			this.scriptId = scriptId;
		}

		public String getScriptLanguage() {
			return scriptLanguage;
		}

		public void setScriptLanguage(String scriptLanguage) {
			this.scriptLanguage = scriptLanguage;
		}

		public String getDeliveryMethod() {
			return deliveryMethod;
		}

		public void setDeliveryMethod(String deliveryMethod) {
			this.deliveryMethod = deliveryMethod;
		}

		public String getDeliveryDestination() {
			return deliveryDestination;
		}

		public void setDeliveryDestination(String deliveryDestination) {
			this.deliveryDestination = deliveryDestination;
		}

		public String getDeliveryDttm() {
			return deliveryDttm;
		}

		public void setDeliveryDttm(String deliveryDttm) {
			this.deliveryDttm = deliveryDttm;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getCreateDttm() {
			return createDttm;
		}

		public void setCreateDttm(String createDttm) {
			this.createDttm = createDttm;
		}

		public String getReply() {
			return reply;
		}

		public void setReply(String reply) {
			this.reply = reply;
		}
	}

	private static class _BulkNotification {
		private Long bulkId;
		private String bulkStatus;
		private String bulkStatusDttm;
		private Long bulkRequestSize;
		private Long bulkValidNotifications;
		private Long bulkInvalidNotifications;
		private String bulkCreateDttm;
		private List<_Notification> bulkNotifications;


		public Long getBulkId() {
			return bulkId;
		}

		public void setBulkId(Long bulkId) {
			this.bulkId = bulkId;
		}

		public String getBulkStatus() {
			return bulkStatus;
		}

		public void setBulkStatus(String bulkStatus) {
			this.bulkStatus = bulkStatus;
		}

		public String getBulkStatusDttm() {
			return bulkStatusDttm;
		}

		public void setBulkStatusDttm(String bulkStatusDttm) {
			this.bulkStatusDttm = bulkStatusDttm;
		}

		public Long getBulkRequestSize() {
			return bulkRequestSize;
		}

		public void setBulkRequestSize(Long bulkRequestSize) {
			this.bulkRequestSize = bulkRequestSize;
		}

		public Long getBulkValidNotifications() {
			return bulkValidNotifications;
		}

		public void setBulkValidNotifications(Long bulkValidNotifications) {
			this.bulkValidNotifications = bulkValidNotifications;
		}

		public Long getBulkInvalidNotifications() {
			return bulkInvalidNotifications;
		}

		public void setBulkInvalidNotifications(Long bulkInvalidNotifications) {
			this.bulkInvalidNotifications = bulkInvalidNotifications;
		}

		public String getBulkCreateDttm() {
			return bulkCreateDttm;
		}

		public void setBulkCreateDttm(String bulkCreateDttm) {
			this.bulkCreateDttm = bulkCreateDttm;
		}

		public List<_Notification> getBulkNotifications() {
			return bulkNotifications;
		}

		public void setBulkNotifications(List<_Notification> bulkNotifications) {
			this.bulkNotifications = bulkNotifications;
		}
	}

	private static class EventNotificationStatusesGetByInternalIds1_1Response extends UpdoxResponse {
		private List<_FailedRequestParameter> failedRequestParameters;
		private List<_BulkNotification> bulkInfos;


		public List<_FailedRequestParameter> getFailedRequestParameters() {
			return failedRequestParameters;
		}

		public void setFailedRequestParameters(List<_FailedRequestParameter> failedRequestParameters) {
			this.failedRequestParameters = failedRequestParameters;
		}

		public List<_BulkNotification> getBulkInfos() {
			return bulkInfos;
		}

		public void setBulkInfos(List<_BulkNotification> bulkInfos) {
			this.bulkInfos = bulkInfos;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`6212`	`at least one id must be specified for the request`

FaxActions

AvailableFaxNumbersList /io/AvailableFaxNumbersList

Lists up to 50 random available fax numbers for the supplied area code. Use the literal '8xx' for toll-free numbers.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
areaCode	String		The area code in which to list available fax numbers . The value must contain exactly 3 characters. This is required.

Try it! Toggle Notes/Code Samples

AvailableFaxNumbersList

Lists up to 50 random available fax numbers for the supplied area code. Use the literal '8xx' for toll-free numbers.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AvailableFaxNumbersList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AvailableFaxNumbersList codeSample = new UpdoxCodeSample_AvailableFaxNumbersList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AvailableFaxNumbersList";
			AvailableFaxNumbersListRequest availableFaxNumbersListRequest = new AvailableFaxNumbersListRequest();

			//set up credentials
			availableFaxNumbersListRequest.auth.applicationId = "applicationId";
			availableFaxNumbersListRequest.auth.applicationPassword = "applicationPassword";
			availableFaxNumbersListRequest.auth.accountId = "accountId";

			//set up request specific parameters
			availableFaxNumbersListRequest.areaCode = "areaCode";

			//create the request
			string json = Utilities.buildRequestJson(availableFaxNumbersListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AvailableFaxNumbersList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AvailableFaxNumbersListResponse availableFaxNumbersListResponse = javascriptSerializer.Deserialize<AvailableFaxNumbersListResponse>(jsonResponse);

			Console.WriteLine(availableFaxNumbersListResponse.responseCode);
			Console.WriteLine(availableFaxNumbersListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class AvailableFaxNumbersListRequest : UpdoxRequest {
			public string areaCode { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AvailableFaxNumbersListResponse : UpdoxResponse {
			public List<string> numbers { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AvailableFaxNumbersList {

	public static void main(String[] args) {
		UpdoxCodeSample_AvailableFaxNumbersList codeSample = new UpdoxCodeSample_AvailableFaxNumbersList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AvailableFaxNumbersList";

		AvailableFaxNumbersListRequest availableFaxNumbersListRequest = new AvailableFaxNumbersListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = availableFaxNumbersListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		availableFaxNumbersListRequest.setAreaCode("areaCode");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(availableFaxNumbersListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AvailableFaxNumbersList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AvailableFaxNumbersListResponse availableFaxNumbersListResponse = mapper.readValue(jsonResponse, AvailableFaxNumbersListResponse.class);

		System.out.println(availableFaxNumbersListResponse.getResponseCode());
		System.out.println(availableFaxNumbersListResponse.getResponseMessage());
	}

	private class AvailableFaxNumbersListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String areaCode;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAreaCode() {
			return areaCode;
		}

		public void setAreaCode(String areaCode) {
			this.areaCode = areaCode;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AvailableFaxNumbersListResponse extends UpdoxResponse {
		private List<String> numbers;


		public List<String> getNumbers() {
			return numbers;
		}

		public void setNumbers(List<String> numbers) {
			this.numbers = numbers;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

AvailableFaxNumbersList/1.1 /io/AvailableFaxNumbersList/1.1

Lists up to 50 random available fax numbers for the supplied area code. Use the literal '8xx' for toll-free numbers. Returns standardized response object.

Parameter	Type	Value	Description
areaCode	String		The area code in which to list available fax numbers . The value must contain exactly 3 characters. This is required.

Try it! Toggle Notes/Code Samples

AvailableFaxNumbersList/1.1

Lists up to 50 random available fax numbers for the supplied area code. Use the literal '8xx' for toll-free numbers. Returns standardized response object.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_AvailableFaxNumbersList1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_AvailableFaxNumbersList1_1 codeSample = new UpdoxCodeSample_AvailableFaxNumbersList1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "AvailableFaxNumbersList1_1";
			AvailableFaxNumbersList1_1Request availableFaxNumbersList1_1Request = new AvailableFaxNumbersList1_1Request();

			//set up credentials
			availableFaxNumbersList1_1Request.auth.applicationId = "applicationId";
			availableFaxNumbersList1_1Request.auth.applicationPassword = "applicationPassword";
			availableFaxNumbersList1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			availableFaxNumbersList1_1Request.areaCode = "areaCode";

			//create the request
			string json = Utilities.buildRequestJson(availableFaxNumbersList1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "AvailableFaxNumbersList/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			AvailableFaxNumbersList1_1Response availableFaxNumbersList1_1Response = javascriptSerializer.Deserialize<AvailableFaxNumbersList1_1Response>(jsonResponse);

			Console.WriteLine(availableFaxNumbersList1_1Response.responseCode);
			Console.WriteLine(availableFaxNumbersList1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class AvailableFaxNumbersList1_1Request : UpdoxRequest {
			public string areaCode { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AvailableFaxNumbersList1_1Response : UpdoxResponse {
			public List<string> numbers { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_AvailableFaxNumbersList1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_AvailableFaxNumbersList1_1 codeSample = new UpdoxCodeSample_AvailableFaxNumbersList1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "AvailableFaxNumbersList1_1";

		AvailableFaxNumbersList1_1Request availableFaxNumbersList1_1Request = new AvailableFaxNumbersList1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = availableFaxNumbersList1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		availableFaxNumbersList1_1Request.setAreaCode("areaCode");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(availableFaxNumbersList1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'AvailableFaxNumbersList/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		AvailableFaxNumbersList1_1Response availableFaxNumbersList1_1Response = mapper.readValue(jsonResponse, AvailableFaxNumbersList1_1Response.class);

		System.out.println(availableFaxNumbersList1_1Response.getResponseCode());
		System.out.println(availableFaxNumbersList1_1Response.getResponseMessage());
	}

	private class AvailableFaxNumbersList1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String areaCode;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAreaCode() {
			return areaCode;
		}

		public void setAreaCode(String areaCode) {
			this.areaCode = areaCode;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AvailableFaxNumbersList1_1Response extends UpdoxResponse {
		private List<String> numbers;


		public List<String> getNumbers() {
			return numbers;
		}

		public void setNumbers(List<String> numbers) {
			this.numbers = numbers;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

BlockedFaxSendersList /io/BlockedFaxSendersList

This API returns the list of blocked fax senders configured and managed in "The Blocklist" within the Updox Admin menu in the Inbox web application.

More information about updating the "Blocklist" in the UI can be found in this Updox Knowledge Base article: Removing Spam Faxes from your Inbox.

Try it! Toggle Notes/Code Samples

BlockedFaxSendersList

This API returns the list of blocked fax senders configured and managed in "The Blocklist" within the Updox Admin menu in the Inbox web application.

More information about updating the "Blocklist" in the UI can be found in this Updox Knowledge Base article: Removing Spam Faxes from your Inbox.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_BlockedFaxSendersList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_BlockedFaxSendersList codeSample = new UpdoxCodeSample_BlockedFaxSendersList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "BlockedFaxSendersList";
			BlockedFaxSendersListRequest blockedFaxSendersListRequest = new BlockedFaxSendersListRequest();

			//set up credentials
			blockedFaxSendersListRequest.auth.applicationId = "applicationId";
			blockedFaxSendersListRequest.auth.applicationPassword = "applicationPassword";
			blockedFaxSendersListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(blockedFaxSendersListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "BlockedFaxSendersList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			BlockedFaxSendersListResponse blockedFaxSendersListResponse = javascriptSerializer.Deserialize<BlockedFaxSendersListResponse>(jsonResponse);

			Console.WriteLine(blockedFaxSendersListResponse.responseCode);
			Console.WriteLine(blockedFaxSendersListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class BlockedFaxSendersListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class BlockedFaxSendersListResponse : UpdoxResponse {
			public List<string> numbers { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_BlockedFaxSendersList {

	public static void main(String[] args) {
		UpdoxCodeSample_BlockedFaxSendersList codeSample = new UpdoxCodeSample_BlockedFaxSendersList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "BlockedFaxSendersList";

		BlockedFaxSendersListRequest blockedFaxSendersListRequest = new BlockedFaxSendersListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = blockedFaxSendersListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(blockedFaxSendersListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'BlockedFaxSendersList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		BlockedFaxSendersListResponse blockedFaxSendersListResponse = mapper.readValue(jsonResponse, BlockedFaxSendersListResponse.class);

		System.out.println(blockedFaxSendersListResponse.getResponseCode());
		System.out.println(blockedFaxSendersListResponse.getResponseMessage());
	}

	private class BlockedFaxSendersListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class BlockedFaxSendersListResponse extends UpdoxResponse {
		private List<String> numbers;


		public List<String> getNumbers() {
			return numbers;
		}

		public void setNumbers(List<String> numbers) {
			this.numbers = numbers;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FaxBulkIdRetrieve /io/FaxBulkIdRetrieve

Returns a list of all sent faxes associated with the bulk fax id argument.

Parameter	Type	Value	Description
bulkFaxId	Long		The bulk fax ID of completed faxes that are being searched for. There must be at least 1 value(s). This is required.

Try it! Toggle Notes/Code Samples

FaxBulkIdRetrieve

Returns a list of all sent faxes associated with the bulk fax id argument.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxBulkIdRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxBulkIdRetrieve codeSample = new UpdoxCodeSample_FaxBulkIdRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxBulkIdRetrieve";
			FaxBulkIdRetrieveRequest faxBulkIdRetrieveRequest = new FaxBulkIdRetrieveRequest();

			//set up credentials
			faxBulkIdRetrieveRequest.auth.applicationId = "applicationId";
			faxBulkIdRetrieveRequest.auth.applicationPassword = "applicationPassword";
			faxBulkIdRetrieveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxBulkIdRetrieveRequest.bulkFaxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxBulkIdRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxBulkIdRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxBulkIdRetrieveResponse faxBulkIdRetrieveResponse = javascriptSerializer.Deserialize<FaxBulkIdRetrieveResponse>(jsonResponse);

			Console.WriteLine(faxBulkIdRetrieveResponse.responseCode);
			Console.WriteLine(faxBulkIdRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxBulkIdRetrieveRequest : UpdoxRequest {
			public long bulkFaxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class SentFaxInfo {
			public string faxNumber { get; set;}
			public long faxId { get; set;}
		}

		public class FaxBulkIdRetrieveResponse : UpdoxResponse {
			public List<SentFaxInfo> completedFaxes { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FaxBulkIdRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxBulkIdRetrieve codeSample = new UpdoxCodeSample_FaxBulkIdRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxBulkIdRetrieve";

		FaxBulkIdRetrieveRequest faxBulkIdRetrieveRequest = new FaxBulkIdRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxBulkIdRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxBulkIdRetrieveRequest.setBulkFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxBulkIdRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxBulkIdRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxBulkIdRetrieveResponse faxBulkIdRetrieveResponse = mapper.readValue(jsonResponse, FaxBulkIdRetrieveResponse.class);

		System.out.println(faxBulkIdRetrieveResponse.getResponseCode());
		System.out.println(faxBulkIdRetrieveResponse.getResponseMessage());
	}

	private class FaxBulkIdRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long bulkFaxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getBulkFaxId() {
			return bulkFaxId;
		}

		public void setBulkFaxId(long bulkFaxId) {
			this.bulkFaxId = bulkFaxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class SentFaxInfo {
		private String faxNumber;
		private long faxId;


		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public long getFaxId() {
			return faxId;
		}

		public void setFaxId(long faxId) {
			this.faxId = faxId;
		}
	}

	private static class FaxBulkIdRetrieveResponse extends UpdoxResponse {
		private List<SentFaxInfo> completedFaxes;


		public List<SentFaxInfo> getCompletedFaxes() {
			return completedFaxes;
		}

		public void setCompletedFaxes(List<SentFaxInfo> completedFaxes) {
			this.completedFaxes = completedFaxes;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4931`	`you sent zero bulk faxes with this bulkFaxId`

FaxBulkSend /io/FaxBulkSend

Sends a bulk fax of the same PDF document.

Parameter	Type	Value	Description
recipientFaxNumbers	List	add remove	The fax numbers to send the fax to.

	String
fromName	String		The name of the sender of the fax. Max length 255 characters. This is required.
fromFaxNumber	String		The number to send the fax from. Max length 255 characters. This is required.
faxContent	String		The Base64 encoded pdf-only file data. This is required.

Try it! Toggle Notes/Code Samples

FaxBulkSend

Sends a bulk fax of the same PDF document.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxBulkSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxBulkSend codeSample = new UpdoxCodeSample_FaxBulkSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxBulkSend";
			FaxBulkSendRequest faxBulkSendRequest = new FaxBulkSendRequest();

			//set up credentials
			faxBulkSendRequest.auth.applicationId = "applicationId";
			faxBulkSendRequest.auth.applicationPassword = "applicationPassword";
			faxBulkSendRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<string> recipientFaxNumbers = new List<string>();
			string recipientFaxNumbersString = "recipientFaxNumbers";
			recipientFaxNumbers.Add(recipientFaxNumbersString);
			faxBulkSendRequest.recipientFaxNumbers = recipientFaxNumbers;
			faxBulkSendRequest.fromName = "fromName";
			faxBulkSendRequest.fromFaxNumber = "fromFaxNumber";
			faxBulkSendRequest.faxContent = "faxContent";

			//create the request
			string json = Utilities.buildRequestJson(faxBulkSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxBulkSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxBulkSendResponse faxBulkSendResponse = javascriptSerializer.Deserialize<FaxBulkSendResponse>(jsonResponse);

			Console.WriteLine(faxBulkSendResponse.responseCode);
			Console.WriteLine(faxBulkSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxBulkSendRequest : UpdoxRequest {
			public List<string> recipientFaxNumbers { get; set;}
			public string fromName { get; set;}
			public string fromFaxNumber { get; set;}
			public string faxContent { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxBulkSendResponse : UpdoxResponse {
			public long bulkSendId { get; set;}
			public long validFaxCount { get; set;}
			public List<string> invalidFaxNumbers { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FaxBulkSend {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxBulkSend codeSample = new UpdoxCodeSample_FaxBulkSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxBulkSend";

		FaxBulkSendRequest faxBulkSendRequest = new FaxBulkSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxBulkSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<String> recipientFaxNumbers = new ArrayList<>();
		String recipientFaxNumbersString = "recipientFaxNumbers";
		recipientFaxNumbers.add(recipientFaxNumbersString);
		faxBulkSendRequest.setRecipientFaxNumbers(recipientFaxNumbers);
		faxBulkSendRequest.setFromName("fromName");
		faxBulkSendRequest.setFromFaxNumber("fromFaxNumber");
		faxBulkSendRequest.setFaxContent("faxContent");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxBulkSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxBulkSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxBulkSendResponse faxBulkSendResponse = mapper.readValue(jsonResponse, FaxBulkSendResponse.class);

		System.out.println(faxBulkSendResponse.getResponseCode());
		System.out.println(faxBulkSendResponse.getResponseMessage());
	}

	private class FaxBulkSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> recipientFaxNumbers;
    	private String fromName;
    	private String fromFaxNumber;
    	private String faxContent;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getRecipientFaxNumbers() {
			return recipientFaxNumbers;
		}

		public void setRecipientFaxNumbers(List<String> recipientFaxNumbers) {
			this.recipientFaxNumbers = recipientFaxNumbers;
		}

		public String getFromName() {
			return fromName;
		}

		public void setFromName(String fromName) {
			this.fromName = fromName;
		}

		public String getFromFaxNumber() {
			return fromFaxNumber;
		}

		public void setFromFaxNumber(String fromFaxNumber) {
			this.fromFaxNumber = fromFaxNumber;
		}

		public String getFaxContent() {
			return faxContent;
		}

		public void setFaxContent(String faxContent) {
			this.faxContent = faxContent;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxBulkSendResponse extends UpdoxResponse {
		private long bulkSendId;
		private long validFaxCount;
		private List<String> invalidFaxNumbers;


		public long getBulkSendId() {
			return bulkSendId;
		}

		public void setBulkSendId(long bulkSendId) {
			this.bulkSendId = bulkSendId;
		}

		public long getValidFaxCount() {
			return validFaxCount;
		}

		public void setValidFaxCount(long validFaxCount) {
			this.validFaxCount = validFaxCount;
		}

		public List<String> getInvalidFaxNumbers() {
			return invalidFaxNumbers;
		}

		public void setInvalidFaxNumbers(List<String> invalidFaxNumbers) {
			this.invalidFaxNumbers = invalidFaxNumbers;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FaxCountGet /io/FaxCountGet

Retrieve fax page count for practice within a given date range with a maximum of 92 days. If only one date is provided the range will be for that month, either from or to the date provided. If no date is provided the current month up until today will be retrieved.

Parameter	Type	Value	Description
fromDate	String		Get page count from date, format yyyy-mm-dd.
toDate	String		Get page count to date, format yyyy-mm-dd.

Try it! Toggle Notes/Code Samples

FaxCountGet

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxCountGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxCountGet codeSample = new UpdoxCodeSample_FaxCountGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxCountGet";
			FaxCountGetRequest faxCountGetRequest = new FaxCountGetRequest();

			//set up credentials
			faxCountGetRequest.auth.applicationId = "applicationId";
			faxCountGetRequest.auth.applicationPassword = "applicationPassword";
			faxCountGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxCountGetRequest.fromDate = "fromDate";
			faxCountGetRequest.toDate = "toDate";

			//create the request
			string json = Utilities.buildRequestJson(faxCountGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxCountGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxCountGetResponse faxCountGetResponse = javascriptSerializer.Deserialize<FaxCountGetResponse>(jsonResponse);

			Console.WriteLine(faxCountGetResponse.responseCode);
			Console.WriteLine(faxCountGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxCountGetRequest : UpdoxRequest {
			public string fromDate { get; set;}
			public string toDate { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Counts {
			public long faxes { get; set;}
			public long pages { get; set;}
		}

		public class FaxCountGetResult {
			public String fromDate { get; set;}
			public String toDate { get; set;}
			public Counts successful { get; set;}
			public Counts inbound { get; set;}
			public Counts pending { get; set;}
			public Counts failed { get; set;}
		}

		public class FaxCountGetResponse : UpdoxResponse {
			public FaxCountGetResult result { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import org.joda.time.LocalDate;

public class UpdoxCodeSample_FaxCountGet {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxCountGet codeSample = new UpdoxCodeSample_FaxCountGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxCountGet";

		FaxCountGetRequest faxCountGetRequest = new FaxCountGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxCountGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxCountGetRequest.setFromDate("fromDate");
		faxCountGetRequest.setToDate("toDate");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxCountGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxCountGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxCountGetResponse faxCountGetResponse = mapper.readValue(jsonResponse, FaxCountGetResponse.class);

		System.out.println(faxCountGetResponse.getResponseCode());
		System.out.println(faxCountGetResponse.getResponseMessage());
	}

	private class FaxCountGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDate;
    	private String toDate;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDate() {
			return fromDate;
		}

		public void setFromDate(String fromDate) {
			this.fromDate = fromDate;
		}

		public String getToDate() {
			return toDate;
		}

		public void setToDate(String toDate) {
			this.toDate = toDate;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Counts {
		private Long faxes;
		private Long pages;


		public Long getFaxes() {
			return faxes;
		}

		public void setFaxes(Long faxes) {
			this.faxes = faxes;
		}

		public Long getPages() {
			return pages;
		}

		public void setPages(Long pages) {
			this.pages = pages;
		}
	}

	private static class FaxCountGetResult {
		private LocalDate fromDate;
		private LocalDate toDate;
		private Counts successful;
		private Counts inbound;
		private Counts pending;
		private Counts failed;


		public LocalDate getFromDate() {
			return fromDate;
		}

		public void setFromDate(LocalDate fromDate) {
			this.fromDate = fromDate;
		}

		public LocalDate getToDate() {
			return toDate;
		}

		public void setToDate(LocalDate toDate) {
			this.toDate = toDate;
		}

		public Counts getSuccessful() {
			return successful;
		}

		public void setSuccessful(Counts successful) {
			this.successful = successful;
		}

		public Counts getInbound() {
			return inbound;
		}

		public void setInbound(Counts inbound) {
			this.inbound = inbound;
		}

		public Counts getPending() {
			return pending;
		}

		public void setPending(Counts pending) {
			this.pending = pending;
		}

		public Counts getFailed() {
			return failed;
		}

		public void setFailed(Counts failed) {
			this.failed = failed;
		}
	}

	private static class FaxCountGetResponse extends UpdoxResponse {
		private FaxCountGetResult result;


		public FaxCountGetResult getResult() {
			return result;
		}

		public void setResult(FaxCountGetResult result) {
			this.result = result;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4021`	`Invalid date format`

FaxItemGet /io/FaxItemGet

Retrieve a specific fax by id

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
faxId	Long		The Id of the fax to retrieve.

Try it! Toggle Notes/Code Samples

FaxItemGet

Retrieve a specific fax by id

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxItemGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxItemGet codeSample = new UpdoxCodeSample_FaxItemGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxItemGet";
			FaxItemGetRequest faxItemGetRequest = new FaxItemGetRequest();

			//set up credentials
			faxItemGetRequest.auth.applicationId = "applicationId";
			faxItemGetRequest.auth.applicationPassword = "applicationPassword";
			faxItemGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxItemGetRequest.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxItemGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxItemGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxItemGetResponse faxItemGetResponse = javascriptSerializer.Deserialize<FaxItemGetResponse>(jsonResponse);

			Console.WriteLine(faxItemGetResponse.responseCode);
			Console.WriteLine(faxItemGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxItemGetRequest : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxItemGetResponse : UpdoxResponse {
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxItemGet {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxItemGet codeSample = new UpdoxCodeSample_FaxItemGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxItemGet";

		FaxItemGetRequest faxItemGetRequest = new FaxItemGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxItemGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxItemGetRequest.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxItemGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxItemGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxItemGetResponse faxItemGetResponse = mapper.readValue(jsonResponse, FaxItemGetResponse.class);

		System.out.println(faxItemGetResponse.getResponseCode());
		System.out.println(faxItemGetResponse.getResponseMessage());
	}

	private class FaxItemGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getFaxId() {
			return faxId;
		}

		public void setFaxId(Long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxItemGetResponse extends UpdoxResponse {
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`

FaxItemGet/1.1 /io/FaxItemGet/1.1

Retrieve a specific fax by id with QR code data

Parameter	Type	Value	Description
faxId	Long		The Id of the fax to retrieve.

Try it! Toggle Notes/Code Samples

FaxItemGet/1.1

Retrieve a specific fax by id with QR code data

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxItemGet1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxItemGet1_1 codeSample = new UpdoxCodeSample_FaxItemGet1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxItemGet1_1";
			FaxItemGet1_1Request faxItemGet1_1Request = new FaxItemGet1_1Request();

			//set up credentials
			faxItemGet1_1Request.auth.applicationId = "applicationId";
			faxItemGet1_1Request.auth.applicationPassword = "applicationPassword";
			faxItemGet1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			faxItemGet1_1Request.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxItemGet1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxItemGet/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxItemGet1_1Response faxItemGet1_1Response = javascriptSerializer.Deserialize<FaxItemGet1_1Response>(jsonResponse);

			Console.WriteLine(faxItemGet1_1Response.responseCode);
			Console.WriteLine(faxItemGet1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class FaxItemGet1_1Request : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxItemGet1_1Response : UpdoxResponse {
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxItemGet1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxItemGet1_1 codeSample = new UpdoxCodeSample_FaxItemGet1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxItemGet1_1";

		FaxItemGet1_1Request faxItemGet1_1Request = new FaxItemGet1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxItemGet1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxItemGet1_1Request.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxItemGet1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxItemGet/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxItemGet1_1Response faxItemGet1_1Response = mapper.readValue(jsonResponse, FaxItemGet1_1Response.class);

		System.out.println(faxItemGet1_1Response.getResponseCode());
		System.out.println(faxItemGet1_1Response.getResponseMessage());
	}

	private class FaxItemGet1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getFaxId() {
			return faxId;
		}

		public void setFaxId(Long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxItemGet1_1Response extends UpdoxResponse {
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`

FaxItemGetPdf /io/FaxItemGetPdf

Retrieve a specific fax by id as pdf

Parameter	Type	Value	Description
faxId	Long		The Id of the fax to retrieve.

Try it! Toggle Notes/Code Samples

FaxItemGetPdf

Retrieve a specific fax by id as pdf

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxItemGetPdf {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxItemGetPdf codeSample = new UpdoxCodeSample_FaxItemGetPdf();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxItemGetPdf";
			FaxItemGetPdfRequest faxItemGetPdfRequest = new FaxItemGetPdfRequest();

			//set up credentials
			faxItemGetPdfRequest.auth.applicationId = "applicationId";
			faxItemGetPdfRequest.auth.applicationPassword = "applicationPassword";
			faxItemGetPdfRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxItemGetPdfRequest.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxItemGetPdfRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxItemGetPdf", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxItemGetPdfResponse faxItemGetPdfResponse = javascriptSerializer.Deserialize<FaxItemGetPdfResponse>(jsonResponse);

			Console.WriteLine(faxItemGetPdfResponse.responseCode);
			Console.WriteLine(faxItemGetPdfResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxItemGetPdfRequest : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxItemGetPdfResponse : UpdoxResponse {
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxItemGetPdf {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxItemGetPdf codeSample = new UpdoxCodeSample_FaxItemGetPdf();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxItemGetPdf";

		FaxItemGetPdfRequest faxItemGetPdfRequest = new FaxItemGetPdfRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxItemGetPdfRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxItemGetPdfRequest.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxItemGetPdfRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxItemGetPdf', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxItemGetPdfResponse faxItemGetPdfResponse = mapper.readValue(jsonResponse, FaxItemGetPdfResponse.class);

		System.out.println(faxItemGetPdfResponse.getResponseCode());
		System.out.println(faxItemGetPdfResponse.getResponseMessage());
	}

	private class FaxItemGetPdfRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getFaxId() {
			return faxId;
		}

		public void setFaxId(Long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxItemGetPdfResponse extends UpdoxResponse {
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`

FaxItemGetPdfOriginal /io/FaxItemGetPdfOriginal

Returns the original PDF for a specific fax if available. Original fax PDFs are only stored for 14 days.

Parameter	Type	Value	Description
faxId	Long		The Id of the fax to retrieve.

Try it! Toggle Notes/Code Samples

FaxItemGetPdfOriginal

Returns the original PDF for a specific fax if available. Original fax PDFs are only stored for 14 days.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxItemGetPdfOriginal {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxItemGetPdfOriginal codeSample = new UpdoxCodeSample_FaxItemGetPdfOriginal();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxItemGetPdfOriginal";
			FaxItemGetPdfOriginalRequest faxItemGetPdfOriginalRequest = new FaxItemGetPdfOriginalRequest();

			//set up credentials
			faxItemGetPdfOriginalRequest.auth.applicationId = "applicationId";
			faxItemGetPdfOriginalRequest.auth.applicationPassword = "applicationPassword";
			faxItemGetPdfOriginalRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxItemGetPdfOriginalRequest.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxItemGetPdfOriginalRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxItemGetPdfOriginal", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxItemGetPdfOriginalResponse faxItemGetPdfOriginalResponse = javascriptSerializer.Deserialize<FaxItemGetPdfOriginalResponse>(jsonResponse);

			Console.WriteLine(faxItemGetPdfOriginalResponse.responseCode);
			Console.WriteLine(faxItemGetPdfOriginalResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxItemGetPdfOriginalRequest : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxItemGetPdfOriginalResponse : UpdoxResponse {
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxItemGetPdfOriginal {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxItemGetPdfOriginal codeSample = new UpdoxCodeSample_FaxItemGetPdfOriginal();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxItemGetPdfOriginal";

		FaxItemGetPdfOriginalRequest faxItemGetPdfOriginalRequest = new FaxItemGetPdfOriginalRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxItemGetPdfOriginalRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxItemGetPdfOriginalRequest.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxItemGetPdfOriginalRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxItemGetPdfOriginal', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxItemGetPdfOriginalResponse faxItemGetPdfOriginalResponse = mapper.readValue(jsonResponse, FaxItemGetPdfOriginalResponse.class);

		System.out.println(faxItemGetPdfOriginalResponse.getResponseCode());
		System.out.println(faxItemGetPdfOriginalResponse.getResponseMessage());
	}

	private class FaxItemGetPdfOriginalRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getFaxId() {
			return faxId;
		}

		public void setFaxId(Long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxItemGetPdfOriginalResponse extends UpdoxResponse {
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`
`4095`	`record invalid for action`

FaxMessageIdGet /io/FaxMessageIdGet

Retrieves the message ID for the given fax ID. Allowing access to MessageActions APIs.

Parameter	Type	Value	Description
faxId	Long		Fax ID.

Try it! Toggle Notes/Code Samples

FaxMessageIdGet

Retrieves the message ID for the given fax ID. Allowing access to MessageActions APIs.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxMessageIdGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxMessageIdGet codeSample = new UpdoxCodeSample_FaxMessageIdGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxMessageIdGet";
			FaxMessageIdGetRequest faxMessageIdGetRequest = new FaxMessageIdGetRequest();

			//set up credentials
			faxMessageIdGetRequest.auth.applicationId = "applicationId";
			faxMessageIdGetRequest.auth.applicationPassword = "applicationPassword";
			faxMessageIdGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxMessageIdGetRequest.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxMessageIdGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxMessageIdGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxMessageIdGetResponse faxMessageIdGetResponse = javascriptSerializer.Deserialize<FaxMessageIdGetResponse>(jsonResponse);

			Console.WriteLine(faxMessageIdGetResponse.responseCode);
			Console.WriteLine(faxMessageIdGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxMessageIdGetRequest : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxMessageIdGetResponse : UpdoxResponse {
			public long faxId { get; set;}
			public long messageId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_FaxMessageIdGet {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxMessageIdGet codeSample = new UpdoxCodeSample_FaxMessageIdGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxMessageIdGet";

		FaxMessageIdGetRequest faxMessageIdGetRequest = new FaxMessageIdGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxMessageIdGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxMessageIdGetRequest.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxMessageIdGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxMessageIdGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxMessageIdGetResponse faxMessageIdGetResponse = mapper.readValue(jsonResponse, FaxMessageIdGetResponse.class);

		System.out.println(faxMessageIdGetResponse.getResponseCode());
		System.out.println(faxMessageIdGetResponse.getResponseMessage());
	}

	private class FaxMessageIdGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getFaxId() {
			return faxId;
		}

		public void setFaxId(long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxMessageIdGetResponse extends UpdoxResponse {
		private long faxId;
		private long messageId;


		public long getFaxId() {
			return faxId;
		}

		public void setFaxId(long faxId) {
			this.faxId = faxId;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`
`4410`	`message not found`

FaxNumberBlockSave /io/FaxNumberBlockSave

Add a fax number to or remove it from the Updox blocklist, which directs inbound faxes from blocked numbers to the Spam folder within the Updox web application.

Outdated: Hidden by default to avoid the confusion surround the 'blocked' functionality for some customers.

Parameter	Type	Value	Description
senderNumber	String		A fax number. The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only. This is required.
active	Boolean		Is the fax number blocked? True = yes. This is required.

Try it! Toggle Notes/Code Samples

FaxNumberBlockSave

Add a fax number to or remove it from the Updox blocklist, which directs inbound faxes from blocked numbers to the Spam folder within the Updox web application.

Outdated: Hidden by default to avoid the confusion surround the 'blocked' functionality for some customers.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxNumberBlockSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxNumberBlockSave codeSample = new UpdoxCodeSample_FaxNumberBlockSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxNumberBlockSave";
			FaxNumberBlockSaveRequest faxNumberBlockSaveRequest = new FaxNumberBlockSaveRequest();

			//set up credentials
			faxNumberBlockSaveRequest.auth.applicationId = "applicationId";
			faxNumberBlockSaveRequest.auth.applicationPassword = "applicationPassword";
			faxNumberBlockSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxNumberBlockSaveRequest.senderNumber = "senderNumber";
			faxNumberBlockSaveRequest.active = true;

			//create the request
			string json = Utilities.buildRequestJson(faxNumberBlockSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxNumberBlockSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxNumberBlockSaveResponse faxNumberBlockSaveResponse = javascriptSerializer.Deserialize<FaxNumberBlockSaveResponse>(jsonResponse);

			Console.WriteLine(faxNumberBlockSaveResponse.responseCode);
			Console.WriteLine(faxNumberBlockSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxNumberBlockSaveRequest : UpdoxRequest {
			public string senderNumber { get; set;}
			public bool active { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class FaxNumberBlockSaveResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_FaxNumberBlockSave {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxNumberBlockSave codeSample = new UpdoxCodeSample_FaxNumberBlockSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxNumberBlockSave";

		FaxNumberBlockSaveRequest faxNumberBlockSaveRequest = new FaxNumberBlockSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxNumberBlockSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxNumberBlockSaveRequest.setSenderNumber("senderNumber");
		faxNumberBlockSaveRequest.setActive(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxNumberBlockSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxNumberBlockSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxNumberBlockSaveResponse faxNumberBlockSaveResponse = mapper.readValue(jsonResponse, FaxNumberBlockSaveResponse.class);

		System.out.println(faxNumberBlockSaveResponse.getResponseCode());
		System.out.println(faxNumberBlockSaveResponse.getResponseMessage());
	}

	private class FaxNumberBlockSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String senderNumber;
    	private boolean active;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getSenderNumber() {
			return senderNumber;
		}

		public void setSenderNumber(String senderNumber) {
			this.senderNumber = senderNumber;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxNumberBlockSaveResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FaxNumberProvision /io/FaxNumberProvision

Attempts to provision the supplied fax number.

Parameter	Type	Value	Description
faxNumber	String		The fax number to provision and associate with the authenticated account.

Try it! Toggle Notes/Code Samples

FaxNumberProvision

Attempts to provision the supplied fax number.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxNumberProvision {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxNumberProvision codeSample = new UpdoxCodeSample_FaxNumberProvision();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxNumberProvision";
			FaxNumberProvisionRequest faxNumberProvisionRequest = new FaxNumberProvisionRequest();

			//set up credentials
			faxNumberProvisionRequest.auth.applicationId = "applicationId";
			faxNumberProvisionRequest.auth.applicationPassword = "applicationPassword";
			faxNumberProvisionRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxNumberProvisionRequest.faxNumber = "faxNumber";

			//create the request
			string json = Utilities.buildRequestJson(faxNumberProvisionRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxNumberProvision", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxNumberProvisionResponse faxNumberProvisionResponse = javascriptSerializer.Deserialize<FaxNumberProvisionResponse>(jsonResponse);

			Console.WriteLine(faxNumberProvisionResponse.responseCode);
			Console.WriteLine(faxNumberProvisionResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxNumberProvisionRequest : UpdoxRequest {
			public string faxNumber { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxNumberProvisionResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_FaxNumberProvision {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxNumberProvision codeSample = new UpdoxCodeSample_FaxNumberProvision();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxNumberProvision";

		FaxNumberProvisionRequest faxNumberProvisionRequest = new FaxNumberProvisionRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxNumberProvisionRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxNumberProvisionRequest.setFaxNumber("faxNumber");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxNumberProvisionRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxNumberProvision', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxNumberProvisionResponse faxNumberProvisionResponse = mapper.readValue(jsonResponse, FaxNumberProvisionResponse.class);

		System.out.println(faxNumberProvisionResponse.getResponseCode());
		System.out.println(faxNumberProvisionResponse.getResponseMessage());
	}

	private class FaxNumberProvisionRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String faxNumber;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxNumberProvisionResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4000`	`Bad Request`
`4932`	`fax number does not appear to be available`
`4933`	`invalid fax number`

FaxOemPop /io/FaxOemPop

Attempts to retrieve the next available OEM fax.

Parameter	Type	Value	Description
lastRetrievedFaxId	Long		The messageId of the last fax that was successfully popped. This message will be archived and not retrieved again.

Try it! Toggle Notes/Code Samples

FaxOemPop

Attempts to retrieve the next available OEM fax.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxOemPop {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxOemPop codeSample = new UpdoxCodeSample_FaxOemPop();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxOemPop";
			FaxOemPopRequest faxOemPopRequest = new FaxOemPopRequest();

			//set up credentials
			faxOemPopRequest.auth.applicationId = "applicationId";
			faxOemPopRequest.auth.applicationPassword = "applicationPassword";
			faxOemPopRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxOemPopRequest.lastRetrievedFaxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxOemPopRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxOemPop", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxOemPopResponse faxOemPopResponse = javascriptSerializer.Deserialize<FaxOemPopResponse>(jsonResponse);

			Console.WriteLine(faxOemPopResponse.responseCode);
			Console.WriteLine(faxOemPopResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxOemPopRequest : UpdoxRequest {
			public long lastRetrievedFaxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxOemPopResponse : UpdoxResponse {
			public bool endOfQueue { get; set;}
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
			public bool original { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxOemPop {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxOemPop codeSample = new UpdoxCodeSample_FaxOemPop();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxOemPop";

		FaxOemPopRequest faxOemPopRequest = new FaxOemPopRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxOemPopRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxOemPopRequest.setLastRetrievedFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxOemPopRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxOemPop', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxOemPopResponse faxOemPopResponse = mapper.readValue(jsonResponse, FaxOemPopResponse.class);

		System.out.println(faxOemPopResponse.getResponseCode());
		System.out.println(faxOemPopResponse.getResponseMessage());
	}

	private class FaxOemPopRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long lastRetrievedFaxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getLastRetrievedFaxId() {
			return lastRetrievedFaxId;
		}

		public void setLastRetrievedFaxId(long lastRetrievedFaxId) {
			this.lastRetrievedFaxId = lastRetrievedFaxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxOemPopResponse extends UpdoxResponse {
		private boolean endOfQueue;
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;
		private Boolean original;


		public boolean isEndOfQueue() {
			return endOfQueue;
		}

		public void setEndOfQueue(boolean endOfQueue) {
			this.endOfQueue = endOfQueue;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}

		public Boolean isOriginal() {
			return original;
		}

		public void setOriginal(Boolean original) {
			this.original = original;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

FaxOemPopPdf /io/FaxOemPopPdf

Attempts to retrieve the next available OEM fax as a PDF.

Parameter	Type	Value	Description
lastRetrievedFaxId	Long		The messageId of the last fax that was successfully popped. This message will be archived and not retrieved again.
returnOriginalPdfIfAvailable	Boolean		Defaults to false; if true, the returned PDF will be the original fax PDF if it?s still available. Original fax PDFs are only stored for 14 days. If the original fax PDF is no longer available, then the returned PDF will be constructed from the individual page images (the same as if false were passed). Added February 2025.

Try it! Toggle Notes/Code Samples

FaxOemPopPdf

Attempts to retrieve the next available OEM fax as a PDF.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

If, and only if, the returnOriginalPdfIfAvailable request flag is true, the response will contain an additional original flag. If original is true, the original PDF was able to be retrieved and is contained in the response. If original is false, the original PDF was no longer available, and the PDF contained in the response has been constructed from images of each page.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxOemPopPdf {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxOemPopPdf codeSample = new UpdoxCodeSample_FaxOemPopPdf();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxOemPopPdf";
			FaxOemPopPdfRequest faxOemPopPdfRequest = new FaxOemPopPdfRequest();

			//set up credentials
			faxOemPopPdfRequest.auth.applicationId = "applicationId";
			faxOemPopPdfRequest.auth.applicationPassword = "applicationPassword";
			faxOemPopPdfRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxOemPopPdfRequest.lastRetrievedFaxId = 1L;
			faxOemPopPdfRequest.returnOriginalPdfIfAvailable = true;

			//create the request
			string json = Utilities.buildRequestJson(faxOemPopPdfRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxOemPopPdf", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxOemPopPdfResponse faxOemPopPdfResponse = javascriptSerializer.Deserialize<FaxOemPopPdfResponse>(jsonResponse);

			Console.WriteLine(faxOemPopPdfResponse.responseCode);
			Console.WriteLine(faxOemPopPdfResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxOemPopPdfRequest : UpdoxRequest {
			public long lastRetrievedFaxId { get; set;}
			public bool returnOriginalPdfIfAvailable { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FaxOemPopPdfResponse : UpdoxResponse {
			public bool endOfQueue { get; set;}
			public long messageId { get; set;}
			public String received { get; set;}
			public string from { get; set;}
			public string to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
			public bool original { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_FaxOemPopPdf {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxOemPopPdf codeSample = new UpdoxCodeSample_FaxOemPopPdf();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxOemPopPdf";

		FaxOemPopPdfRequest faxOemPopPdfRequest = new FaxOemPopPdfRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxOemPopPdfRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxOemPopPdfRequest.setLastRetrievedFaxId(1L);
		faxOemPopPdfRequest.setReturnOriginalPdfIfAvailable(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxOemPopPdfRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxOemPopPdf', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxOemPopPdfResponse faxOemPopPdfResponse = mapper.readValue(jsonResponse, FaxOemPopPdfResponse.class);

		System.out.println(faxOemPopPdfResponse.getResponseCode());
		System.out.println(faxOemPopPdfResponse.getResponseMessage());
	}

	private class FaxOemPopPdfRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long lastRetrievedFaxId;
    	private boolean returnOriginalPdfIfAvailable;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getLastRetrievedFaxId() {
			return lastRetrievedFaxId;
		}

		public void setLastRetrievedFaxId(long lastRetrievedFaxId) {
			this.lastRetrievedFaxId = lastRetrievedFaxId;
		}

		public boolean isReturnOriginalPdfIfAvailable() {
			return returnOriginalPdfIfAvailable;
		}

		public void setReturnOriginalPdfIfAvailable(boolean returnOriginalPdfIfAvailable) {
			this.returnOriginalPdfIfAvailable = returnOriginalPdfIfAvailable;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class FaxOemPopPdfResponse extends UpdoxResponse {
		private boolean endOfQueue;
		private long messageId;
		private Timestamp received;
		private String from;
		private String to;
		private List<AttachmentObject> attachments;
		private Boolean original;


		public boolean isEndOfQueue() {
			return endOfQueue;
		}

		public void setEndOfQueue(boolean endOfQueue) {
			this.endOfQueue = endOfQueue;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getFrom() {
			return from;
		}

		public void setFrom(String from) {
			this.from = from;
		}

		public String getTo() {
			return to;
		}

		public void setTo(String to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}

		public Boolean isOriginal() {
			return original;
		}

		public void setOriginal(Boolean original) {
			this.original = original;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

FaxOemSend /io/FaxOemSend

Sends an OEM fax.

Parameter	Type	Description
toName	String	The name of the recipient to send the fax to. Max length 255 characters. This is required.
toFaxNumber	String	The fax number to send the fax to. Can optionally include the NANPA country code ("+1" or "1"). The fax number must be valid and not blocked. Min length 10 characters. Max length 12 characters. This is required.
fromName	String	The name of the sender of the fax. Max length 255 characters. This is required.
fromFaxNumber	String	The number to send the fax from. Max length 255 characters. This is required.
faxContent	String	The Base64 encoded pdf-only file data. This is required.
callbackUrl	String	Callback url for status changes. Max length 255 characters.
busyAttempts	Integer	The (approximate) amount of attempts to make if the receiving fax number is busy. Depending on conditions, we may try more times, but we will never try less. The default is currently 8, and the maximum is 10.

Try it! Toggle Notes/Code Samples

FaxOemSend

Sends an OEM fax.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxOemSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxOemSend codeSample = new UpdoxCodeSample_FaxOemSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxOemSend";
			FaxOemSendRequest faxOemSendRequest = new FaxOemSendRequest();

			//set up credentials
			faxOemSendRequest.auth.applicationId = "applicationId";
			faxOemSendRequest.auth.applicationPassword = "applicationPassword";
			faxOemSendRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxOemSendRequest.toName = "toName";
			faxOemSendRequest.toFaxNumber = "toFaxNumber";
			faxOemSendRequest.fromName = "fromName";
			faxOemSendRequest.fromFaxNumber = "fromFaxNumber";
			faxOemSendRequest.faxContent = "faxContent";
			faxOemSendRequest.callbackUrl = "callbackUrl";
			faxOemSendRequest.busyAttempts = "busyattempts";

			//create the request
			string json = Utilities.buildRequestJson(faxOemSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxOemSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxOemSendResponse faxOemSendResponse = javascriptSerializer.Deserialize<FaxOemSendResponse>(jsonResponse);

			Console.WriteLine(faxOemSendResponse.responseCode);
			Console.WriteLine(faxOemSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxOemSendRequest : UpdoxRequest {
			public string toName { get; set;}
			public string toFaxNumber { get; set;}
			public string fromName { get; set;}
			public string fromFaxNumber { get; set;}
			public string faxContent { get; set;}
			public string callbackUrl { get; set;}
			public int busyAttempts { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxOemSendResponse : UpdoxResponse {
			public long faxId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_FaxOemSend {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxOemSend codeSample = new UpdoxCodeSample_FaxOemSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxOemSend";

		FaxOemSendRequest faxOemSendRequest = new FaxOemSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxOemSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxOemSendRequest.setToName("toName");
		faxOemSendRequest.setToFaxNumber("toFaxNumber");
		faxOemSendRequest.setFromName("fromName");
		faxOemSendRequest.setFromFaxNumber("fromFaxNumber");
		faxOemSendRequest.setFaxContent("faxContent");
		faxOemSendRequest.setCallbackUrl("callbackUrl");
		faxOemSendRequest.setBusyAttempts("busyattempts");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxOemSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxOemSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxOemSendResponse faxOemSendResponse = mapper.readValue(jsonResponse, FaxOemSendResponse.class);

		System.out.println(faxOemSendResponse.getResponseCode());
		System.out.println(faxOemSendResponse.getResponseMessage());
	}

	private class FaxOemSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String toName;
    	private String toFaxNumber;
    	private String fromName;
    	private String fromFaxNumber;
    	private String faxContent;
    	private String callbackUrl;
    	private Integer busyAttempts;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getToName() {
			return toName;
		}

		public void setToName(String toName) {
			this.toName = toName;
		}

		public String getToFaxNumber() {
			return toFaxNumber;
		}

		public void setToFaxNumber(String toFaxNumber) {
			this.toFaxNumber = toFaxNumber;
		}

		public String getFromName() {
			return fromName;
		}

		public void setFromName(String fromName) {
			this.fromName = fromName;
		}

		public String getFromFaxNumber() {
			return fromFaxNumber;
		}

		public void setFromFaxNumber(String fromFaxNumber) {
			this.fromFaxNumber = fromFaxNumber;
		}

		public String getFaxContent() {
			return faxContent;
		}

		public void setFaxContent(String faxContent) {
			this.faxContent = faxContent;
		}

		public String getCallbackUrl() {
			return callbackUrl;
		}

		public void setCallbackUrl(String callbackUrl) {
			this.callbackUrl = callbackUrl;
		}

		public Integer getBusyAttempts() {
			return busyAttempts;
		}

		public void setBusyAttempts(Integer busyAttempts) {
			this.busyAttempts = busyAttempts;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxOemSendResponse extends UpdoxResponse {
		private long faxId;


		public long getFaxId() {
			return faxId;
		}

		public void setFaxId(long faxId) {
			this.faxId = faxId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FaxProvisionedList /io/FaxProvisionedList

Returns a list of provisioned fax numbers associated to a practice.

Try it! Toggle Notes/Code Samples

FaxProvisionedList

Returns a list of provisioned fax numbers associated to a practice.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxProvisionedList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxProvisionedList codeSample = new UpdoxCodeSample_FaxProvisionedList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxProvisionedList";
			FaxProvisionedListRequest faxProvisionedListRequest = new FaxProvisionedListRequest();

			//set up credentials
			faxProvisionedListRequest.auth.applicationId = "applicationId";
			faxProvisionedListRequest.auth.applicationPassword = "applicationPassword";
			faxProvisionedListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(faxProvisionedListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxProvisionedList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxProvisionedListResponse faxProvisionedListResponse = javascriptSerializer.Deserialize<FaxProvisionedListResponse>(jsonResponse);

			Console.WriteLine(faxProvisionedListResponse.responseCode);
			Console.WriteLine(faxProvisionedListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxProvisionedListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxNumberLimited {
			public string faxNumber { get; set;}
			public string status { get; set;}
		}

		public class FaxProvisionedListResponse : UpdoxResponse {
			public List<FaxNumberLimited> faxNumberList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FaxProvisionedList {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxProvisionedList codeSample = new UpdoxCodeSample_FaxProvisionedList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxProvisionedList";

		FaxProvisionedListRequest faxProvisionedListRequest = new FaxProvisionedListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxProvisionedListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxProvisionedListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxProvisionedList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxProvisionedListResponse faxProvisionedListResponse = mapper.readValue(jsonResponse, FaxProvisionedListResponse.class);

		System.out.println(faxProvisionedListResponse.getResponseCode());
		System.out.println(faxProvisionedListResponse.getResponseMessage());
	}

	private class FaxProvisionedListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxNumberLimited {
		private String faxNumber;
		private String status;


		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}
	}

	private static class FaxProvisionedListResponse extends UpdoxResponse {
		private List<FaxNumberLimited> faxNumberList;


		public List<FaxNumberLimited> getFaxNumberList() {
			return faxNumberList;
		}

		public void setFaxNumberList(List<FaxNumberLimited> faxNumberList) {
			this.faxNumberList = faxNumberList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FaxStatusGet /io/FaxStatusGet

Retrieves the status and status message for the fax with the given ID. The status information is listed in Notes.

Parameter	Type	Value	Description
faxId	Long		The ID of the fax to retrieve the status for. There must be at least 1 value(s). This is required.

Try it! Toggle Notes/Code Samples

FaxStatusGet

Retrieves the status and status message for the fax with the given ID. The status information is listed in Notes.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Current set of statuses are:

success
failure then faxStatusMessage will explain the reason for the failure (e.g. busy signal)
queued
received
cancelled
cancel_requested

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FaxStatusGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FaxStatusGet codeSample = new UpdoxCodeSample_FaxStatusGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FaxStatusGet";
			FaxStatusGetRequest faxStatusGetRequest = new FaxStatusGetRequest();

			//set up credentials
			faxStatusGetRequest.auth.applicationId = "applicationId";
			faxStatusGetRequest.auth.applicationPassword = "applicationPassword";
			faxStatusGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			faxStatusGetRequest.faxId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(faxStatusGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FaxStatusGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FaxStatusGetResponse faxStatusGetResponse = javascriptSerializer.Deserialize<FaxStatusGetResponse>(jsonResponse);

			Console.WriteLine(faxStatusGetResponse.responseCode);
			Console.WriteLine(faxStatusGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FaxStatusGetRequest : UpdoxRequest {
			public long faxId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FaxStatusGetResponse : UpdoxResponse {
			public string faxStatus { get; set;}
			public string faxStatusMessage { get; set;}
			public String deliveryTimestamp { get; set;}
			public long pageCount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.sql.Timestamp;

public class UpdoxCodeSample_FaxStatusGet {

	public static void main(String[] args) {
		UpdoxCodeSample_FaxStatusGet codeSample = new UpdoxCodeSample_FaxStatusGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FaxStatusGet";

		FaxStatusGetRequest faxStatusGetRequest = new FaxStatusGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = faxStatusGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		faxStatusGetRequest.setFaxId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(faxStatusGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FaxStatusGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FaxStatusGetResponse faxStatusGetResponse = mapper.readValue(jsonResponse, FaxStatusGetResponse.class);

		System.out.println(faxStatusGetResponse.getResponseCode());
		System.out.println(faxStatusGetResponse.getResponseMessage());
	}

	private class FaxStatusGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long faxId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getFaxId() {
			return faxId;
		}

		public void setFaxId(long faxId) {
			this.faxId = faxId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class FaxStatusGetResponse extends UpdoxResponse {
		private String faxStatus;
		private String faxStatusMessage;
		private Timestamp deliveryTimestamp;
		private long pageCount;


		public String getFaxStatus() {
			return faxStatus;
		}

		public void setFaxStatus(String faxStatus) {
			this.faxStatus = faxStatus;
		}

		public String getFaxStatusMessage() {
			return faxStatusMessage;
		}

		public void setFaxStatusMessage(String faxStatusMessage) {
			this.faxStatusMessage = faxStatusMessage;
		}

		public Timestamp getDeliveryTimestamp() {
			return deliveryTimestamp;
		}

		public void setDeliveryTimestamp(Timestamp deliveryTimestamp) {
			this.deliveryTimestamp = deliveryTimestamp;
		}

		public long getPageCount() {
			return pageCount;
		}

		public void setPageCount(long pageCount) {
			this.pageCount = pageCount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4930`	`no fax found for this ID`

FormActions

RetrieveSubmittedForm /io/form/RetrieveSubmittedForm

Get the content of a submitted form.

Response field submitter will be missing if unknown/anonymous.

Response field externalId will reflect the external id of the form field at API endpoint invocation. All form data and layout will reflect the values present at submission.

Response field type current possible values are:

textbox - Single-Line Text
textarea - Multi-Line Text
datebox - Date Picker
checkbox - Check Box
dropdown - Drop-Down List
radiolist - Radio Button List
checklist - Check Box List
rating - Star Rating
signature - Signature
imageUpload - Image Upload

New types may be added in the future. Please have logic to handle/ignore additional types if they are present in the response.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
formId	String		Form ID to retrieve. This is required.

Try it! Toggle Notes/Code Samples

RetrieveSubmittedForm

Get the content of a submitted form.

Response field submitter will be missing if unknown/anonymous.

Response field externalId will reflect the external id of the form field at API endpoint invocation. All form data and layout will reflect the values present at submission.

Response field type current possible values are:

textbox - Single-Line Text
textarea - Multi-Line Text
datebox - Date Picker
checkbox - Check Box
dropdown - Drop-Down List
radiolist - Radio Button List
checklist - Check Box List
rating - Star Rating
signature - Signature
imageUpload - Image Upload

New types may be added in the future. Please have logic to handle/ignore additional types if they are present in the response.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormRetrieveSubmittedForm {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormRetrieveSubmittedForm codeSample = new UpdoxCodeSample_FormRetrieveSubmittedForm();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormRetrieveSubmittedForm";
			FormRetrieveSubmittedFormRequest formRetrieveSubmittedFormRequest = new FormRetrieveSubmittedFormRequest();

			//set up credentials
			formRetrieveSubmittedFormRequest.auth.applicationId = "applicationId";
			formRetrieveSubmittedFormRequest.auth.applicationPassword = "applicationPassword";
			formRetrieveSubmittedFormRequest.auth.accountId = "accountId";

			//set up request specific parameters
			formRetrieveSubmittedFormRequest.formId = "formId";

			//create the request
			string json = Utilities.buildRequestJson(formRetrieveSubmittedFormRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/RetrieveSubmittedForm", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormRetrieveSubmittedFormResponse formRetrieveSubmittedFormResponse = javascriptSerializer.Deserialize<FormRetrieveSubmittedFormResponse>(jsonResponse);

			Console.WriteLine(formRetrieveSubmittedFormResponse.responseCode);
			Console.WriteLine(formRetrieveSubmittedFormResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FormRetrieveSubmittedFormRequest : UpdoxRequest {
			public string formId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveSubmittedFormSubmitterResponse {
			public string type { get; set;}
			public string id { get; set;}
		}

		public class RetrieveSubmittedFormFieldValueResponse {
			public string value { get; set;}
		}

		public class RetrieveSubmittedFormFieldResponse {
			public string label { get; set;}
			public string externalId { get; set;}
			public string key { get; set;}
			public string type { get; set;}
			public bool required { get; set;}
			public List<RetrieveSubmittedFormFieldValueResponse> values { get; set;}
		}

		public class FormRetrieveSubmittedFormResponse : UpdoxResponse {
			public string formId { get; set;}
			public ZonedDateTime submittedAt { get; set;}
			public RetrieveSubmittedFormSubmitterResponse submitter { get; set;}
			public string title { get; set;}
			public List<RetrieveSubmittedFormFieldResponse> fields { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormRetrieveSubmittedForm {

	public static void main(String[] args) {
		UpdoxCodeSample_FormRetrieveSubmittedForm codeSample = new UpdoxCodeSample_FormRetrieveSubmittedForm();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormRetrieveSubmittedForm";

		FormRetrieveSubmittedFormRequest formRetrieveSubmittedFormRequest = new FormRetrieveSubmittedFormRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formRetrieveSubmittedFormRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		formRetrieveSubmittedFormRequest.setFormId("formId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(formRetrieveSubmittedFormRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/RetrieveSubmittedForm', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormRetrieveSubmittedFormResponse formRetrieveSubmittedFormResponse = mapper.readValue(jsonResponse, FormRetrieveSubmittedFormResponse.class);

		System.out.println(formRetrieveSubmittedFormResponse.getResponseCode());
		System.out.println(formRetrieveSubmittedFormResponse.getResponseMessage());
	}

	private class FormRetrieveSubmittedFormRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String formId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFormId() {
			return formId;
		}

		public void setFormId(String formId) {
			this.formId = formId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveSubmittedFormSubmitterResponse {
		private String type;
		private String id;


		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}
	}

	private static class RetrieveSubmittedFormFieldValueResponse {
		private String value;


		public String getValue() {
			return value;
		}

		public void setValue(String value) {
			this.value = value;
		}
	}

	private static class RetrieveSubmittedFormFieldResponse {
		private String label;
		private String externalId;
		private String key;
		private String type;
		private boolean required;
		private List<RetrieveSubmittedFormFieldValueResponse> values;


		public String getLabel() {
			return label;
		}

		public void setLabel(String label) {
			this.label = label;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public boolean isRequired() {
			return required;
		}

		public void setRequired(boolean required) {
			this.required = required;
		}

		public List<RetrieveSubmittedFormFieldValueResponse> getValues() {
			return values;
		}

		public void setValues(List<RetrieveSubmittedFormFieldValueResponse> values) {
			this.values = values;
		}
	}

	private static class FormRetrieveSubmittedFormResponse extends UpdoxResponse {
		private String formId;
		private ZonedDateTime submittedAt;
		private RetrieveSubmittedFormSubmitterResponse submitter;
		private String title;
		private List<RetrieveSubmittedFormFieldResponse> fields;


		public String getFormId() {
			return formId;
		}

		public void setFormId(String formId) {
			this.formId = formId;
		}

		public ZonedDateTime getSubmittedAt() {
			return submittedAt;
		}

		public void setSubmittedAt(ZonedDateTime submittedAt) {
			this.submittedAt = submittedAt;
		}

		public RetrieveSubmittedFormSubmitterResponse getSubmitter() {
			return submitter;
		}

		public void setSubmitter(RetrieveSubmittedFormSubmitterResponse submitter) {
			this.submitter = submitter;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public List<RetrieveSubmittedFormFieldResponse> getFields() {
			return fields;
		}

		public void setFields(List<RetrieveSubmittedFormFieldResponse> fields) {
			this.fields = fields;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveSubmittedForm/2.0 /io/form/RetrieveSubmittedForm/2.0

Get the content of a submitted form.

Changes from v1.0 to v2.0:

Authentication Level: Full - Application credentials, account identifier, and user identifier
Renamed field formId to submittedFormId in request
Updated/Added the following fields to the response:
- submitter (nullable object)
  - id - Partner ID of the participant from /PatientsSync or /ContactsSync
  - category - Either PATIENT or CONTACT
- formLibraryDetail (nullable object)
  - formLibraryId - Unique identifier of the form within the account form dashboard
  - type - Either VENDOR or ACCOUNT
  - partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal
- assignment (nullable object)
  - submissionId - Assignment submission public ID
  - partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
  - index - Ordering of the form assignment
Removed the following fields to the response:
- formId
Switched the following fields to the response:
- submitter.type - now submitter.category

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
submittedFormId	String		Form ID to retrieve. This is required.

Try it! Toggle Notes/Code Samples

RetrieveSubmittedForm/2.0

Get the content of a submitted form.

Changes from v1.0 to v2.0:

Authentication Level: Full - Application credentials, account identifier, and user identifier
Renamed field formId to submittedFormId in request
Updated/Added the following fields to the response:
- submitter (nullable object)
  - id - Partner ID of the participant from /PatientsSync or /ContactsSync
  - category - Either PATIENT or CONTACT
- formLibraryDetail (nullable object)
  - formLibraryId - Unique identifier of the form within the account form dashboard
  - type - Either VENDOR or ACCOUNT
  - partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal
- assignment (nullable object)
  - submissionId - Assignment submission public ID
  - partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
  - index - Ordering of the form assignment
Removed the following fields to the response:
- formId
Switched the following fields to the response:
- submitter.type - now submitter.category

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Response field submitter will be missing if unknown/anonymous.

Response field field.externalId will reflect the external id of the form field at API endpoint invocation. All form data and layout will reflect the values present at submission.

Response field type current possible values are:

textbox - Single-Line Text
textarea - Multi-Line Text
datebox - Date Picker
checkbox - Check Box
dropdown - Drop-Down List
radiolist - Radio Button List
checklist - Check Box List
rating - Star Rating
signature - Signature
imageUpload - Image Upload

New types may be added in the future. Please have logic to handle/ignore additional types if they are present in the response.

Response field submitter will be missing if no unknown/anonymous.

id - Partner ID of the participant from /PatientsSync or /ContactsSync
category - Either PATIENT or CONTACT

Response field submittedAt is an ISO-8601 formatted date time of when the form was submitted.

Response field title is the title of the form.

Response field formLibraryDetail will be missing if no details available.

formLibraryId - Unique identifier of the form within the account form dashboard
type - Either VENDOR or ACCOUNT
partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal

Response field assignment will be missing if no assignment details.

submissionId - Assignment submission public ID
partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
index - Ordering of the form assignment

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormRetrieveSubmittedForm2_0 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormRetrieveSubmittedForm2_0 codeSample = new UpdoxCodeSample_FormRetrieveSubmittedForm2_0();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormRetrieveSubmittedForm2_0";
			FormRetrieveSubmittedForm2_0Request formRetrieveSubmittedForm2_0Request = new FormRetrieveSubmittedForm2_0Request();

			//set up credentials
			formRetrieveSubmittedForm2_0Request.auth.applicationId = "applicationId";
			formRetrieveSubmittedForm2_0Request.auth.applicationPassword = "applicationPassword";
			formRetrieveSubmittedForm2_0Request.auth.accountId = "accountId";
			formRetrieveSubmittedForm2_0Request.auth.userId = "userId";

			//set up request specific parameters
			formRetrieveSubmittedForm2_0Request.submittedFormId = "submittedFormId";

			//create the request
			string json = Utilities.buildRequestJson(formRetrieveSubmittedForm2_0Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/RetrieveSubmittedForm/2.0", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormRetrieveSubmittedForm2_0Response formRetrieveSubmittedForm2_0Response = javascriptSerializer.Deserialize<FormRetrieveSubmittedForm2_0Response>(jsonResponse);

			Console.WriteLine(formRetrieveSubmittedForm2_0Response.responseCode);
			Console.WriteLine(formRetrieveSubmittedForm2_0Response.responseMessage);

			Environment.Exit (0);
		}


		public class FormRetrieveSubmittedForm2_0Request : UpdoxRequest {
			public string submittedFormId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Companion {
		}

		public class RetrieveFormDashboardFormSubmitter {
			public string id { get; set;}
			public string category { get; set;}
		}

		public class RetrieveSubmittedFormFieldValueResponse {
			public string value { get; set;}
		}

		public class RetrieveSubmittedFormFieldResponse {
			public string label { get; set;}
			public string externalId { get; set;}
			public string key { get; set;}
			public string type { get; set;}
			public bool required { get; set;}
			public List<RetrieveSubmittedFormFieldValueResponse> values { get; set;}
		}

		public class RetrieveFormDashboardFormLibraryDetail {
			public string formLibraryId { get; set;}
			public string type { get; set;}
			public string partnerMetadata { get; set;}
		}

		public class RetrieveFormDashboardFormAssignment {
			public string submissionId { get; set;}
			public string partnerMetadata { get; set;}
			public long index { get; set;}
		}

		public class FormRetrieveSubmittedForm2_0Response : UpdoxResponse {
			public Companion companion { get; set;}
			public RetrieveFormDashboardFormSubmitter submitter { get; set;}
			public ZonedDateTime submittedAt { get; set;}
			public string title { get; set;}
			public List<RetrieveSubmittedFormFieldResponse> fields { get; set;}
			public RetrieveFormDashboardFormLibraryDetail formLibraryDetail { get; set;}
			public RetrieveFormDashboardFormAssignment assignment { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormRetrieveSubmittedForm2_0 {

	public static void main(String[] args) {
		UpdoxCodeSample_FormRetrieveSubmittedForm2_0 codeSample = new UpdoxCodeSample_FormRetrieveSubmittedForm2_0();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormRetrieveSubmittedForm2_0";

		FormRetrieveSubmittedForm2_0Request formRetrieveSubmittedForm2_0Request = new FormRetrieveSubmittedForm2_0Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formRetrieveSubmittedForm2_0Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		formRetrieveSubmittedForm2_0Request.setSubmittedFormId("submittedFormId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(formRetrieveSubmittedForm2_0Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/RetrieveSubmittedForm/2.0', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormRetrieveSubmittedForm2_0Response formRetrieveSubmittedForm2_0Response = mapper.readValue(jsonResponse, FormRetrieveSubmittedForm2_0Response.class);

		System.out.println(formRetrieveSubmittedForm2_0Response.getResponseCode());
		System.out.println(formRetrieveSubmittedForm2_0Response.getResponseMessage());
	}

	private class FormRetrieveSubmittedForm2_0Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String submittedFormId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getSubmittedFormId() {
			return submittedFormId;
		}

		public void setSubmittedFormId(String submittedFormId) {
			this.submittedFormId = submittedFormId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class Companion {

	}

	private static class RetrieveFormDashboardFormSubmitter {
		private String id;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private static class RetrieveSubmittedFormFieldValueResponse {
		private String value;


		public String getValue() {
			return value;
		}

		public void setValue(String value) {
			this.value = value;
		}
	}

	private static class RetrieveSubmittedFormFieldResponse {
		private String label;
		private String externalId;
		private String key;
		private String type;
		private boolean required;
		private List<RetrieveSubmittedFormFieldValueResponse> values;


		public String getLabel() {
			return label;
		}

		public void setLabel(String label) {
			this.label = label;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public boolean isRequired() {
			return required;
		}

		public void setRequired(boolean required) {
			this.required = required;
		}

		public List<RetrieveSubmittedFormFieldValueResponse> getValues() {
			return values;
		}

		public void setValues(List<RetrieveSubmittedFormFieldValueResponse> values) {
			this.values = values;
		}
	}

	private static class RetrieveFormDashboardFormLibraryDetail {
		private String formLibraryId;
		private String type;
		private String partnerMetadata;


		public String getFormLibraryId() {
			return formLibraryId;
		}

		public void setFormLibraryId(String formLibraryId) {
			this.formLibraryId = formLibraryId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}
	}

	private static class RetrieveFormDashboardFormAssignment {
		private String submissionId;
		private String partnerMetadata;
		private Long index;


		public String getSubmissionId() {
			return submissionId;
		}

		public void setSubmissionId(String submissionId) {
			this.submissionId = submissionId;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}

		public Long getIndex() {
			return index;
		}

		public void setIndex(Long index) {
			this.index = index;
		}
	}

	private static class FormRetrieveSubmittedForm2_0Response extends UpdoxResponse {
		private Companion companion;
		private RetrieveFormDashboardFormSubmitter submitter;
		private ZonedDateTime submittedAt;
		private String title;
		private List<RetrieveSubmittedFormFieldResponse> fields;
		private RetrieveFormDashboardFormLibraryDetail formLibraryDetail;
		private RetrieveFormDashboardFormAssignment assignment;


		public Companion getCompanion() {
			return companion;
		}

		public void setCompanion(Companion companion) {
			this.companion = companion;
		}

		public RetrieveFormDashboardFormSubmitter getSubmitter() {
			return submitter;
		}

		public void setSubmitter(RetrieveFormDashboardFormSubmitter submitter) {
			this.submitter = submitter;
		}

		public ZonedDateTime getSubmittedAt() {
			return submittedAt;
		}

		public void setSubmittedAt(ZonedDateTime submittedAt) {
			this.submittedAt = submittedAt;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public List<RetrieveSubmittedFormFieldResponse> getFields() {
			return fields;
		}

		public void setFields(List<RetrieveSubmittedFormFieldResponse> fields) {
			this.fields = fields;
		}

		public RetrieveFormDashboardFormLibraryDetail getFormLibraryDetail() {
			return formLibraryDetail;
		}

		public void setFormLibraryDetail(RetrieveFormDashboardFormLibraryDetail formLibraryDetail) {
			this.formLibraryDetail = formLibraryDetail;
		}

		public RetrieveFormDashboardFormAssignment getAssignment() {
			return assignment;
		}

		public void setAssignment(RetrieveFormDashboardFormAssignment assignment) {
			this.assignment = assignment;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveFormList /io/form/RetrieveFormList

Retrieve the list of active forms in the account's library. Use the /SendFormAssignment API instead of formStandaloneUrl to associate a recipient to a form or set of forms.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Try it! Toggle Notes/Code Samples

RetrieveFormList

Retrieve the list of active forms in the account's library. Use the /SendFormAssignment API instead of formStandaloneUrl to associate a recipient to a form or set of forms.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormRetrieveFormList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormRetrieveFormList codeSample = new UpdoxCodeSample_FormRetrieveFormList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormRetrieveFormList";
			FormRetrieveFormListRequest formRetrieveFormListRequest = new FormRetrieveFormListRequest();

			//set up credentials
			formRetrieveFormListRequest.auth.applicationId = "applicationId";
			formRetrieveFormListRequest.auth.applicationPassword = "applicationPassword";
			formRetrieveFormListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(formRetrieveFormListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/RetrieveFormList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormRetrieveFormListResponse formRetrieveFormListResponse = javascriptSerializer.Deserialize<FormRetrieveFormListResponse>(jsonResponse);

			Console.WriteLine(formRetrieveFormListResponse.responseCode);
			Console.WriteLine(formRetrieveFormListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FormRetrieveFormListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveFormLibraryDetail {
			public string formLibraryId { get; set;}
			public string partnerMetadata { get; set;}
			public string type { get; set;}
			public string title { get; set;}
			public string formStandaloneUrl { get; set;}
			public Instant lastModifiedDate { get; set;}
		}

		public class FormRetrieveFormListResponse : UpdoxResponse {
			public List<RetrieveFormLibraryDetail> formLibraryDetails { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormRetrieveFormList {

	public static void main(String[] args) {
		UpdoxCodeSample_FormRetrieveFormList codeSample = new UpdoxCodeSample_FormRetrieveFormList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormRetrieveFormList";

		FormRetrieveFormListRequest formRetrieveFormListRequest = new FormRetrieveFormListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formRetrieveFormListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(formRetrieveFormListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/RetrieveFormList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormRetrieveFormListResponse formRetrieveFormListResponse = mapper.readValue(jsonResponse, FormRetrieveFormListResponse.class);

		System.out.println(formRetrieveFormListResponse.getResponseCode());
		System.out.println(formRetrieveFormListResponse.getResponseMessage());
	}

	private class FormRetrieveFormListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveFormLibraryDetail {
		private String formLibraryId;
		private String partnerMetadata;
		private String type;
		private String title;
		private String formStandaloneUrl;
		private Instant lastModifiedDate;


		public String getFormLibraryId() {
			return formLibraryId;
		}

		public void setFormLibraryId(String formLibraryId) {
			this.formLibraryId = formLibraryId;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public String getFormStandaloneUrl() {
			return formStandaloneUrl;
		}

		public void setFormStandaloneUrl(String formStandaloneUrl) {
			this.formStandaloneUrl = formStandaloneUrl;
		}

		public Instant getLastModifiedDate() {
			return lastModifiedDate;
		}

		public void setLastModifiedDate(Instant lastModifiedDate) {
			this.lastModifiedDate = lastModifiedDate;
		}
	}

	private static class FormRetrieveFormListResponse extends UpdoxResponse {
		private List<RetrieveFormLibraryDetail> formLibraryDetails;


		public List<RetrieveFormLibraryDetail> getFormLibraryDetails() {
			return formLibraryDetails;
		}

		public void setFormLibraryDetails(List<RetrieveFormLibraryDetail> formLibraryDetails) {
			this.formLibraryDetails = formLibraryDetails;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveSubmittedFormSummaries /io/form/RetrieveSubmittedFormSummaries

Get summaries of submitted forms in the given time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime.

The response will include the submitted formId, submittedAt date/time when the form was submitted, and the title for each form submitted within the timeframe specified by the request parameters. The formId can be used to retrieve the submitted form content using the RetrieveSubmittedForm API.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
fromDatetime	String	From date/time being requested, format is ISO-8601. This is required.
toDatetime	String	To date/time being requested, format is ISO-8601. This is required.
includeTrash	Boolean	To include any forms in the account's trash. This is required.

Try it! Toggle Notes/Code Samples

RetrieveSubmittedFormSummaries

Get summaries of submitted forms in the given time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormRetrieveSubmittedFormSummaries {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormRetrieveSubmittedFormSummaries codeSample = new UpdoxCodeSample_FormRetrieveSubmittedFormSummaries();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormRetrieveSubmittedFormSummaries";
			FormRetrieveSubmittedFormSummariesRequest formRetrieveSubmittedFormSummariesRequest = new FormRetrieveSubmittedFormSummariesRequest();

			//set up credentials
			formRetrieveSubmittedFormSummariesRequest.auth.applicationId = "applicationId";
			formRetrieveSubmittedFormSummariesRequest.auth.applicationPassword = "applicationPassword";
			formRetrieveSubmittedFormSummariesRequest.auth.accountId = "accountId";

			//set up request specific parameters
			formRetrieveSubmittedFormSummariesRequest.fromDatetime = "fromDatetime";
			formRetrieveSubmittedFormSummariesRequest.toDatetime = "toDatetime";
			formRetrieveSubmittedFormSummariesRequest.includeTrash = true;

			//create the request
			string json = Utilities.buildRequestJson(formRetrieveSubmittedFormSummariesRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/RetrieveSubmittedFormSummaries", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormRetrieveSubmittedFormSummariesResponse formRetrieveSubmittedFormSummariesResponse = javascriptSerializer.Deserialize<FormRetrieveSubmittedFormSummariesResponse>(jsonResponse);

			Console.WriteLine(formRetrieveSubmittedFormSummariesResponse.responseCode);
			Console.WriteLine(formRetrieveSubmittedFormSummariesResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FormRetrieveSubmittedFormSummariesRequest : UpdoxRequest {
			public string fromDatetime { get; set;}
			public string toDatetime { get; set;}
			public bool includeTrash { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Companion {
		}

		public class RetrieveSubmittedFormSummary {
			public Companion companion { get; set;}
			public string formId { get; set;}
			public Instant submittedAt { get; set;}
			public string title { get; set;}
		}

		public class FormRetrieveSubmittedFormSummariesResponse : UpdoxResponse {
			public List<RetrieveSubmittedFormSummary> submittedForms { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormRetrieveSubmittedFormSummaries {

	public static void main(String[] args) {
		UpdoxCodeSample_FormRetrieveSubmittedFormSummaries codeSample = new UpdoxCodeSample_FormRetrieveSubmittedFormSummaries();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormRetrieveSubmittedFormSummaries";

		FormRetrieveSubmittedFormSummariesRequest formRetrieveSubmittedFormSummariesRequest = new FormRetrieveSubmittedFormSummariesRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formRetrieveSubmittedFormSummariesRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		formRetrieveSubmittedFormSummariesRequest.setFromDatetime("fromDatetime");
		formRetrieveSubmittedFormSummariesRequest.setToDatetime("toDatetime");
		formRetrieveSubmittedFormSummariesRequest.setIncludeTrash(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(formRetrieveSubmittedFormSummariesRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/RetrieveSubmittedFormSummaries', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormRetrieveSubmittedFormSummariesResponse formRetrieveSubmittedFormSummariesResponse = mapper.readValue(jsonResponse, FormRetrieveSubmittedFormSummariesResponse.class);

		System.out.println(formRetrieveSubmittedFormSummariesResponse.getResponseCode());
		System.out.println(formRetrieveSubmittedFormSummariesResponse.getResponseMessage());
	}

	private class FormRetrieveSubmittedFormSummariesRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDatetime;
    	private String toDatetime;
    	private boolean includeTrash;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDatetime() {
			return fromDatetime;
		}

		public void setFromDatetime(String fromDatetime) {
			this.fromDatetime = fromDatetime;
		}

		public String getToDatetime() {
			return toDatetime;
		}

		public void setToDatetime(String toDatetime) {
			this.toDatetime = toDatetime;
		}

		public boolean isIncludeTrash() {
			return includeTrash;
		}

		public void setIncludeTrash(boolean includeTrash) {
			this.includeTrash = includeTrash;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Companion {

	}

	private static class RetrieveSubmittedFormSummary {
		private Companion companion;
		private String formId;
		private Instant submittedAt;
		private String title;


		public Companion getCompanion() {
			return companion;
		}

		public void setCompanion(Companion companion) {
			this.companion = companion;
		}

		public String getFormId() {
			return formId;
		}

		public void setFormId(String formId) {
			this.formId = formId;
		}

		public Instant getSubmittedAt() {
			return submittedAt;
		}

		public void setSubmittedAt(Instant submittedAt) {
			this.submittedAt = submittedAt;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}
	}

	private static class FormRetrieveSubmittedFormSummariesResponse extends UpdoxResponse {
		private List<RetrieveSubmittedFormSummary> submittedForms;


		public List<RetrieveSubmittedFormSummary> getSubmittedForms() {
			return submittedForms;
		}

		public void setSubmittedForms(List<RetrieveSubmittedFormSummary> submittedForms) {
			this.submittedForms = submittedForms;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveSubmittedFormSummaries/2.0 /io/form/RetrieveSubmittedFormSummaries/2.0

Retrieve summaries of submitted forms in the given time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime.

The response will include the submitted submittedFormId, submittedAt date/time when the form was submitted, and the title for each form submitted within the timeframe specified by the request parameters. The submittedFormId can be used to retrieve the submitted form content using the /RetrieveSubmittedForm/2.0 API.

Changes from v1.0 to v2.0:

Modified the request:
- submittedFormId - Renamed (previously formId). Unique identifier of the form being submitted.
Added the following fields to the response:
- formLibraryDetail
  - formLibraryId - Unique identifier of the form within the account form dashboard
  - type - Either VENDOR or ACCOUNT
  - partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal
- assignment
  - submissionId - Assignment submission public ID
  - partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
  - index - Ordering of the form assignment

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
fromDatetime	String	From date/time being requested, format is ISO-8601. This is required.
toDatetime	String	To date/time being requested, format is ISO-8601. This is required.
includeTrash	Boolean	To include any forms in the account's trash. This is required.

Try it! Toggle Notes/Code Samples

RetrieveSubmittedFormSummaries/2.0

Retrieve summaries of submitted forms in the given time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime.

Changes from v1.0 to v2.0:

Modified the request:
- submittedFormId - Renamed (previously formId). Unique identifier of the form being submitted.
Added the following fields to the response:
- formLibraryDetail
  - formLibraryId - Unique identifier of the form within the account form dashboard
  - type - Either VENDOR or ACCOUNT
  - partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal
- assignment
  - submissionId - Assignment submission public ID
  - partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
  - index - Ordering of the form assignment

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Return the following:

submittedFormId - non-null string (VARCHAR(40)) - Unique identifier of the submitted form
submittedAt - non-null date/time (format ISO-8601) - When the form was submitted
title - non-null string (VARCHAR(255)) - The title of the form
formLibraryDetail (nullable object)
- formLibraryId - Unique identifier of the form within the account form dashboard
- type - Either VENDOR or ACCOUNT
- partnerMetadata - Partner specified metadata for forms of type VENDOR which are created and managed within Partner Portal
assignment (nullable object)
- submissionId - Assignment submission public ID
- partnerMetadata - Specified in the /SendFormAssignment and associated with the form assignment
- index - Ordering of the form assignment

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0 codeSample = new UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormRetrieveSubmittedFormSummaries2_0";
			FormRetrieveSubmittedFormSummaries2_0Request formRetrieveSubmittedFormSummaries2_0Request = new FormRetrieveSubmittedFormSummaries2_0Request();

			//set up credentials
			formRetrieveSubmittedFormSummaries2_0Request.auth.applicationId = "applicationId";
			formRetrieveSubmittedFormSummaries2_0Request.auth.applicationPassword = "applicationPassword";
			formRetrieveSubmittedFormSummaries2_0Request.auth.accountId = "accountId";

			//set up request specific parameters
			formRetrieveSubmittedFormSummaries2_0Request.fromDatetime = "fromDatetime";
			formRetrieveSubmittedFormSummaries2_0Request.toDatetime = "toDatetime";
			formRetrieveSubmittedFormSummaries2_0Request.includeTrash = true;

			//create the request
			string json = Utilities.buildRequestJson(formRetrieveSubmittedFormSummaries2_0Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/RetrieveSubmittedFormSummaries/2.0", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormRetrieveSubmittedFormSummaries2_0Response formRetrieveSubmittedFormSummaries2_0Response = javascriptSerializer.Deserialize<FormRetrieveSubmittedFormSummaries2_0Response>(jsonResponse);

			Console.WriteLine(formRetrieveSubmittedFormSummaries2_0Response.responseCode);
			Console.WriteLine(formRetrieveSubmittedFormSummaries2_0Response.responseMessage);

			Environment.Exit (0);
		}


		public class FormRetrieveSubmittedFormSummaries2_0Request : UpdoxRequest {
			public string fromDatetime { get; set;}
			public string toDatetime { get; set;}
			public bool includeTrash { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveSubmittedFormSummaryFormLibraryDetail {
			public string formLibraryId { get; set;}
			public string type { get; set;}
			public string partnerMetadata { get; set;}
		}

		public class RetrieveSubmittedFormSummaryAssignment {
			public string submissionId { get; set;}
			public string partnerMetadata { get; set;}
			public long index { get; set;}
		}

		public class RetrieveSubmittedFormSummary2 {
			public string submittedFormId { get; set;}
			public Instant submittedAt { get; set;}
			public string title { get; set;}
			public RetrieveSubmittedFormSummaryFormLibraryDetail formLibraryDetail { get; set;}
			public RetrieveSubmittedFormSummaryAssignment assignment { get; set;}
		}

		public class FormRetrieveSubmittedFormSummaries2_0Response : UpdoxResponse {
			public List<RetrieveSubmittedFormSummary2> submittedForms { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0 {

	public static void main(String[] args) {
		UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0 codeSample = new UpdoxCodeSample_FormRetrieveSubmittedFormSummaries2_0();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormRetrieveSubmittedFormSummaries2_0";

		FormRetrieveSubmittedFormSummaries2_0Request formRetrieveSubmittedFormSummaries2_0Request = new FormRetrieveSubmittedFormSummaries2_0Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formRetrieveSubmittedFormSummaries2_0Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		formRetrieveSubmittedFormSummaries2_0Request.setFromDatetime("fromDatetime");
		formRetrieveSubmittedFormSummaries2_0Request.setToDatetime("toDatetime");
		formRetrieveSubmittedFormSummaries2_0Request.setIncludeTrash(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(formRetrieveSubmittedFormSummaries2_0Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/RetrieveSubmittedFormSummaries/2.0', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormRetrieveSubmittedFormSummaries2_0Response formRetrieveSubmittedFormSummaries2_0Response = mapper.readValue(jsonResponse, FormRetrieveSubmittedFormSummaries2_0Response.class);

		System.out.println(formRetrieveSubmittedFormSummaries2_0Response.getResponseCode());
		System.out.println(formRetrieveSubmittedFormSummaries2_0Response.getResponseMessage());
	}

	private class FormRetrieveSubmittedFormSummaries2_0Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDatetime;
    	private String toDatetime;
    	private boolean includeTrash;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDatetime() {
			return fromDatetime;
		}

		public void setFromDatetime(String fromDatetime) {
			this.fromDatetime = fromDatetime;
		}

		public String getToDatetime() {
			return toDatetime;
		}

		public void setToDatetime(String toDatetime) {
			this.toDatetime = toDatetime;
		}

		public boolean isIncludeTrash() {
			return includeTrash;
		}

		public void setIncludeTrash(boolean includeTrash) {
			this.includeTrash = includeTrash;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveSubmittedFormSummaryFormLibraryDetail {
		private String formLibraryId;
		private String type;
		private String partnerMetadata;


		public String getFormLibraryId() {
			return formLibraryId;
		}

		public void setFormLibraryId(String formLibraryId) {
			this.formLibraryId = formLibraryId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}
	}

	private static class RetrieveSubmittedFormSummaryAssignment {
		private String submissionId;
		private String partnerMetadata;
		private Long index;


		public String getSubmissionId() {
			return submissionId;
		}

		public void setSubmissionId(String submissionId) {
			this.submissionId = submissionId;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}

		public Long getIndex() {
			return index;
		}

		public void setIndex(Long index) {
			this.index = index;
		}
	}

	private static class RetrieveSubmittedFormSummary2 {
		private String submittedFormId;
		private Instant submittedAt;
		private String title;
		private RetrieveSubmittedFormSummaryFormLibraryDetail formLibraryDetail;
		private RetrieveSubmittedFormSummaryAssignment assignment;


		public String getSubmittedFormId() {
			return submittedFormId;
		}

		public void setSubmittedFormId(String submittedFormId) {
			this.submittedFormId = submittedFormId;
		}

		public Instant getSubmittedAt() {
			return submittedAt;
		}

		public void setSubmittedAt(Instant submittedAt) {
			this.submittedAt = submittedAt;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public RetrieveSubmittedFormSummaryFormLibraryDetail getFormLibraryDetail() {
			return formLibraryDetail;
		}

		public void setFormLibraryDetail(RetrieveSubmittedFormSummaryFormLibraryDetail formLibraryDetail) {
			this.formLibraryDetail = formLibraryDetail;
		}

		public RetrieveSubmittedFormSummaryAssignment getAssignment() {
			return assignment;
		}

		public void setAssignment(RetrieveSubmittedFormSummaryAssignment assignment) {
			this.assignment = assignment;
		}
	}

	private static class FormRetrieveSubmittedFormSummaries2_0Response extends UpdoxResponse {
		private List<RetrieveSubmittedFormSummary2> submittedForms;


		public List<RetrieveSubmittedFormSummary2> getSubmittedForms() {
			return submittedForms;
		}

		public void setSubmittedForms(List<RetrieveSubmittedFormSummary2> submittedForms) {
			this.submittedForms = submittedForms;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

SendFormAssignment /io/form/SendFormAssignment

Send form(s) to an existing patient/contact via SMS, email, or link.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
recipient			Who should complete this form assignment. This is required.
id	String		Partner ID of the recipient (One of: ContactSync or PatientSync `id` field). This is required.
category	String		One of: 'patient' or 'contact'. This is required.
partnerMetadata	String		The optional metadata associated with this form assignment. Used for vendor information only. Min length 1 characters. Max length 64 characters.
notificationMethod			Specify the delivery method for the form assignment. If using the contact information on file, there is no need to supply a phone number or email address. If alternative contact information should be used for the form assignment, please specify either an SMS phone number or email address. This is required.
method	String		Which method of delivery the provider has selected for the form. Accepted values are: `SMS`, `LINK`, or `EMAIL`. If `LINK` is selected, the caller is responsible for delivery to the recipient of the returned `assignmentSubmissionUrl`. This is required.
altNotificationSmsNumber	String		If alternative contact information, which differs from that on file for the recipient (patient/contact), should be used, specify the 10-digit US number to send the form assignment to. This will take priority over what?s in the address book. Max length 10 characters.
altNotificationEmailAddress	String		If alternative contact information, which differs from that on file for the recipient (patient/contact), should be used, specify the email address to send the form assignment to. This will take priority over what?s in the address book. Max length 255 characters.
assignedForms	List	add remove	Ordered list of forms to include in the form assignment. Elements should be `active` `formLibraryId`s from `/RetrieveFormList` for the account. This is required.

	String

Try it! Toggle Notes/Code Samples

SendFormAssignment

Send form(s) to an existing patient/contact via SMS, email, or link.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FormSendFormAssignment {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FormSendFormAssignment codeSample = new UpdoxCodeSample_FormSendFormAssignment();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FormSendFormAssignment";
			FormSendFormAssignmentRequest formSendFormAssignmentRequest = new FormSendFormAssignmentRequest();

			//set up credentials
			formSendFormAssignmentRequest.auth.applicationId = "applicationId";
			formSendFormAssignmentRequest.auth.applicationPassword = "applicationPassword";
			formSendFormAssignmentRequest.auth.accountId = "accountId";
			formSendFormAssignmentRequest.auth.userId = "userId";

			//set up request specific parameters
			UpdoxRecipient recipient = new UpdoxRecipient();
			recipient.id = "id";
			recipient.category = "category";
			formSendFormAssignmentRequest.recipient = recipient;
			formSendFormAssignmentRequest.partnerMetadata = "partnerMetadata";
			SendFormAssignmentNotificationMethod notificationMethod = new SendFormAssignmentNotificationMethod();
			notificationMethod.method = "method";
			notificationMethod.altNotificationSmsNumber = "altNotificationSmsNumber";
			notificationMethod.altNotificationEmailAddress = "test@test.com";
			formSendFormAssignmentRequest.notificationMethod = notificationMethod;
			List<string> assignedForms = new List<string>();
			string assignedFormsString = "assignedForms";
			assignedForms.Add(assignedFormsString);
			formSendFormAssignmentRequest.assignedForms = assignedForms;

			//create the request
			string json = Utilities.buildRequestJson(formSendFormAssignmentRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "form/SendFormAssignment", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FormSendFormAssignmentResponse formSendFormAssignmentResponse = javascriptSerializer.Deserialize<FormSendFormAssignmentResponse>(jsonResponse);

			Console.WriteLine(formSendFormAssignmentResponse.responseCode);
			Console.WriteLine(formSendFormAssignmentResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UpdoxRecipient {
			public string id { get; set;}
			public string category { get; set;}
		}

		public class SendFormAssignmentNotificationMethod {
			public string method { get; set;}
			public string altNotificationSmsNumber { get; set;}
			public string altNotificationEmailAddress { get; set;}
		}

		public class FormSendFormAssignmentRequest : UpdoxRequest {
			public UpdoxRecipient recipient { get; set;}
			public string partnerMetadata { get; set;}
			public SendFormAssignmentNotificationMethod notificationMethod { get; set;}
			public List<string> assignedForms { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FormSendFormAssignmentResponse : UpdoxResponse {
			public string assignmentSubmissionId { get; set;}
			public string assignmentSubmissionUrl { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_FormSendFormAssignment {

	public static void main(String[] args) {
		UpdoxCodeSample_FormSendFormAssignment codeSample = new UpdoxCodeSample_FormSendFormAssignment();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FormSendFormAssignment";

		FormSendFormAssignmentRequest formSendFormAssignmentRequest = new FormSendFormAssignmentRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = formSendFormAssignmentRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		UpdoxRecipient recipient = new UpdoxRecipient();
		recipient.setId("id");
		recipient.setCategory("category");
		formSendFormAssignmentRequest.setRecipient(recipient);
		formSendFormAssignmentRequest.setPartnerMetadata("partnerMetadata");
		SendFormAssignmentNotificationMethod notificationMethod = new SendFormAssignmentNotificationMethod();
		notificationMethod.setMethod("method");
		notificationMethod.setAltNotificationSmsNumber("altNotificationSmsNumber");
		notificationMethod.setAltNotificationEmailAddress("test@test.com");
		formSendFormAssignmentRequest.setNotificationMethod(notificationMethod);
	List<String> assignedForms = new ArrayList<>();
		String assignedFormsString = "assignedForms";
		assignedForms.add(assignedFormsString);
		formSendFormAssignmentRequest.setAssignedForms(assignedForms);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(formSendFormAssignmentRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'form/SendFormAssignment', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FormSendFormAssignmentResponse formSendFormAssignmentResponse = mapper.readValue(jsonResponse, FormSendFormAssignmentResponse.class);

		System.out.println(formSendFormAssignmentResponse.getResponseCode());
		System.out.println(formSendFormAssignmentResponse.getResponseMessage());
	}

	private static class UpdoxRecipient {
		private String id;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private static class SendFormAssignmentNotificationMethod {
		private String method;
		private String altNotificationSmsNumber;
		private String altNotificationEmailAddress;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public String getAltNotificationSmsNumber() {
			return altNotificationSmsNumber;
		}

		public void setAltNotificationSmsNumber(String altNotificationSmsNumber) {
			this.altNotificationSmsNumber = altNotificationSmsNumber;
		}

		public String getAltNotificationEmailAddress() {
			return altNotificationEmailAddress;
		}

		public void setAltNotificationEmailAddress(String altNotificationEmailAddress) {
			this.altNotificationEmailAddress = altNotificationEmailAddress;
		}
	}

	private class FormSendFormAssignmentRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private UpdoxRecipient recipient;
    	private String partnerMetadata;
    	private SendFormAssignmentNotificationMethod notificationMethod;
    	private List<String> assignedForms;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public UpdoxRecipient getRecipient() {
			return recipient;
		}

		public void setRecipient(UpdoxRecipient recipient) {
			this.recipient = recipient;
		}

		public String getPartnerMetadata() {
			return partnerMetadata;
		}

		public void setPartnerMetadata(String partnerMetadata) {
			this.partnerMetadata = partnerMetadata;
		}

		public SendFormAssignmentNotificationMethod getNotificationMethod() {
			return notificationMethod;
		}

		public void setNotificationMethod(SendFormAssignmentNotificationMethod notificationMethod) {
			this.notificationMethod = notificationMethod;
		}

		public List<String> getAssignedForms() {
			return assignedForms;
		}

		public void setAssignedForms(List<String> assignedForms) {
			this.assignedForms = assignedForms;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class FormSendFormAssignmentResponse extends UpdoxResponse {
		private String assignmentSubmissionId;
		private String assignmentSubmissionUrl;


		public String getAssignmentSubmissionId() {
			return assignmentSubmissionId;
		}

		public void setAssignmentSubmissionId(String assignmentSubmissionId) {
			this.assignmentSubmissionId = assignmentSubmissionId;
		}

		public String getAssignmentSubmissionUrl() {
			return assignmentSubmissionUrl;
		}

		public void setAssignmentSubmissionUrl(String assignmentSubmissionUrl) {
			this.assignmentSubmissionUrl = assignmentSubmissionUrl;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4035`	`SMS number not verified; verification has been requested.`
`4033`	`SMS number verification has been rejected; contact support.`
`4039`	`On file account business information is insufficient for verification.`
`4070`	`Invalid recipient`
`4015`	`Unauthorized - API not enabled for the request's access rights`

IntegrationActions

CalendarsSync /io/CalendarsSync

Creates or modifies a calendar.

Parameter	Type	Value	Description
id	String		This is required.
title	String		Name of the calendar. This is required.
color	String		Hexadecimal color code of background. e.g. #ccc. This is required.
textColor	String		Hexadecimal color code of text. e.g. #333. This is required.
publicCalendar	Boolean		Set to true to make the calendar visible to patients.
active	Boolean		Set to true to make the calendar active.
reminderTurnOff	Boolean		Set to true to turn off reminders for this calendar.
blackouts	List	add remove	Unavailable dates, in YYYY-MM-DD format. e.g. 2025-02-02.

	String
monday	List	add remove	Monday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
tuesday	List	add remove	Tuesday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
wednesday	List	add remove	Wednesday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
thursday	List	add remove	Thursday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
friday	List	add remove	Friday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
saturday	List	add remove	Saturday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...
sunday	List	add remove	Sunday hours.

start	Int		Start time of availability, in minutes after midnight. e.g. 540 = 9:00 am. The value must be between 0 and 1439. This is required.
end	Int		End time of availability, in minutes after midnight. The value must be between 0 and 1439. This is required.
public	Boolean		Set to true if the hours should be visible to patients.
types	String		Appointment types separated by commas, e.g. 101, 102, 103, ...

Try it! Toggle Notes/Code Samples

CalendarsSync

Creates or modifies a calendar.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_CalendarsSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_CalendarsSync codeSample = new UpdoxCodeSample_CalendarsSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "CalendarsSync";
			CalendarsSyncRequest calendarsSyncRequest = new CalendarsSyncRequest();

			//set up credentials
			calendarsSyncRequest.auth.applicationId = "applicationId";
			calendarsSyncRequest.auth.applicationPassword = "applicationPassword";
			calendarsSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			calendarsSyncRequest.id = "id";
			calendarsSyncRequest.title = "title";
			calendarsSyncRequest.color = "color";
			calendarsSyncRequest.textColor = "textColor";
			calendarsSyncRequest.publicCalendar = true;
			calendarsSyncRequest.active = true;
			calendarsSyncRequest.reminderTurnOff = true;
			List<string> blackouts = new List<string>();
			string blackoutsString = "blackouts";
			blackouts.Add(blackoutsString);
			calendarsSyncRequest.blackouts = blackouts;
			List<Hours> monday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			monday.Add(hours);
			calendarsSyncRequest.monday = monday;
			List<Hours> tuesday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			tuesday.Add(hours);
			calendarsSyncRequest.tuesday = tuesday;
			List<Hours> wednesday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			wednesday.Add(hours);
			calendarsSyncRequest.wednesday = wednesday;
			List<Hours> thursday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			thursday.Add(hours);
			calendarsSyncRequest.thursday = thursday;
			List<Hours> friday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			friday.Add(hours);
			calendarsSyncRequest.friday = friday;
			List<Hours> saturday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			saturday.Add(hours);
			calendarsSyncRequest.saturday = saturday;
			List<Hours> sunday = new List<Hours>();
			Hours hours = new Hours();
			hours.start = 1;
			hours.end = 1;
			hours.@public = true;
			hours.types = "types";
			sunday.Add(hours);
			calendarsSyncRequest.sunday = sunday;

			//create the request
			string json = Utilities.buildRequestJson(calendarsSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "CalendarsSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			CalendarsSyncResponse calendarsSyncResponse = javascriptSerializer.Deserialize<CalendarsSyncResponse>(jsonResponse);

			Console.WriteLine(calendarsSyncResponse.responseCode);
			Console.WriteLine(calendarsSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Hours {
			public int start { get; set;}
			public int end { get; set;}
			public bool @public { get; set;}
			public string types { get; set;}
		}

		public class CalendarsSyncRequest : UpdoxRequest {
			public string id { get; set;}
			public string title { get; set;}
			public string color { get; set;}
			public string textColor { get; set;}
			public bool publicCalendar { get; set;}
			public bool active { get; set;}
			public bool reminderTurnOff { get; set;}
			public List<string> blackouts { get; set;}
			public List<Hours> monday { get; set;}
			public List<Hours> tuesday { get; set;}
			public List<Hours> wednesday { get; set;}
			public List<Hours> thursday { get; set;}
			public List<Hours> friday { get; set;}
			public List<Hours> saturday { get; set;}
			public List<Hours> sunday { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class CalendarsSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_CalendarsSync {

	public static void main(String[] args) {
		UpdoxCodeSample_CalendarsSync codeSample = new UpdoxCodeSample_CalendarsSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "CalendarsSync";

		CalendarsSyncRequest calendarsSyncRequest = new CalendarsSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = calendarsSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		calendarsSyncRequest.setId("id");
		calendarsSyncRequest.setTitle("title");
		calendarsSyncRequest.setColor("color");
		calendarsSyncRequest.setTextColor("textColor");
		calendarsSyncRequest.setPublicCalendar(true);
		calendarsSyncRequest.setActive(true);
		calendarsSyncRequest.setReminderTurnOff(true);
	List<String> blackouts = new ArrayList<>();
		String blackoutsString = "blackouts";
		blackouts.add(blackoutsString);
		calendarsSyncRequest.setBlackouts(blackouts);
	List<Hours> monday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		monday.add(hours);
		calendarsSyncRequest.setMonday(monday);
	List<Hours> tuesday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		tuesday.add(hours);
		calendarsSyncRequest.setTuesday(tuesday);
	List<Hours> wednesday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		wednesday.add(hours);
		calendarsSyncRequest.setWednesday(wednesday);
	List<Hours> thursday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		thursday.add(hours);
		calendarsSyncRequest.setThursday(thursday);
	List<Hours> friday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		friday.add(hours);
		calendarsSyncRequest.setFriday(friday);
	List<Hours> saturday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		saturday.add(hours);
		calendarsSyncRequest.setSaturday(saturday);
	List<Hours> sunday = new ArrayList<>();
		Hours hours = new Hours();
		hours.setStart(1);
		hours.setEnd(1);
		hours.setPublick(true);
		hours.setTypes("types");
		sunday.add(hours);
		calendarsSyncRequest.setSunday(sunday);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(calendarsSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'CalendarsSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		CalendarsSyncResponse calendarsSyncResponse = mapper.readValue(jsonResponse, CalendarsSyncResponse.class);

		System.out.println(calendarsSyncResponse.getResponseCode());
		System.out.println(calendarsSyncResponse.getResponseMessage());
	}

	private static class Hours {
		private int start;
		private int end;
		private boolean publick;
		private String types;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getEnd() {
			return end;
		}

		public void setEnd(int end) {
			this.end = end;
		}

		public boolean isPublick() {
			return publick;
		}

		public void setPublick(boolean publick) {
			this.publick = publick;
		}

		public String getTypes() {
			return types;
		}

		public void setTypes(String types) {
			this.types = types;
		}
	}

	private class CalendarsSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String id;
    	private String title;
    	private String color;
    	private String textColor;
    	private boolean publicCalendar;
    	private boolean active;
    	private boolean reminderTurnOff;
    	private List<String> blackouts;
    	private List<Hours> monday;
    	private List<Hours> tuesday;
    	private List<Hours> wednesday;
    	private List<Hours> thursday;
    	private List<Hours> friday;
    	private List<Hours> saturday;
    	private List<Hours> sunday;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public String getColor() {
			return color;
		}

		public void setColor(String color) {
			this.color = color;
		}

		public String getTextColor() {
			return textColor;
		}

		public void setTextColor(String textColor) {
			this.textColor = textColor;
		}

		public boolean isPublicCalendar() {
			return publicCalendar;
		}

		public void setPublicCalendar(boolean publicCalendar) {
			this.publicCalendar = publicCalendar;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}

		public List<String> getBlackouts() {
			return blackouts;
		}

		public void setBlackouts(List<String> blackouts) {
			this.blackouts = blackouts;
		}

		public List<Hours> getMonday() {
			return monday;
		}

		public void setMonday(List<Hours> monday) {
			this.monday = monday;
		}

		public List<Hours> getTuesday() {
			return tuesday;
		}

		public void setTuesday(List<Hours> tuesday) {
			this.tuesday = tuesday;
		}

		public List<Hours> getWednesday() {
			return wednesday;
		}

		public void setWednesday(List<Hours> wednesday) {
			this.wednesday = wednesday;
		}

		public List<Hours> getThursday() {
			return thursday;
		}

		public void setThursday(List<Hours> thursday) {
			this.thursday = thursday;
		}

		public List<Hours> getFriday() {
			return friday;
		}

		public void setFriday(List<Hours> friday) {
			this.friday = friday;
		}

		public List<Hours> getSaturday() {
			return saturday;
		}

		public void setSaturday(List<Hours> saturday) {
			this.saturday = saturday;
		}

		public List<Hours> getSunday() {
			return sunday;
		}

		public void setSunday(List<Hours> sunday) {
			this.sunday = sunday;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class CalendarsSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ContactsSync /io/ContactsSync

Creates or modifies one or more contacts.

Parameter	Type	Value
contacts	List	add remove

id	String
firstName	String
middleName	String
lastName	String
businessName	String
address1	String
address2	String
city	String
state	String
country	String
zip5	String
dob	String
emailAddress	String
homePhone	String
workPhone	String
mobileNumber	String
faxNumber	String
active	Boolean
contactType	String
oldId	String

Try it! Toggle Notes/Code Samples

ContactsSync

Creates or modifies one or more contacts.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

System will parse list of contacts and attempt to find existing records based on the id passed in. If no match is found and an old id value is supplied, an additional check for that identifier will be performed prior to inserting a new record. If a match is not found, a new contact is created with the information supplied.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ContactsSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ContactsSync codeSample = new UpdoxCodeSample_ContactsSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ContactsSync";
			ContactsSyncRequest contactsSyncRequest = new ContactsSyncRequest();

			//set up credentials
			contactsSyncRequest.auth.applicationId = "applicationId";
			contactsSyncRequest.auth.applicationPassword = "applicationPassword";
			contactsSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalContact> contacts = new List<ExternalContact>();
			ExternalContact externalContact = new ExternalContact();
			externalContact.id = "id";
			externalContact.firstName = "firstName";
			externalContact.middleName = "middleName";
			externalContact.lastName = "lastName";
			externalContact.businessName = "businessName";
			externalContact.address1 = "address1";
			externalContact.address2 = "address2";
			externalContact.city = "Dublin";
			externalContact.state = "OH";
			externalContact.country = "country";
			externalContact.zip5 = "43017";
			externalContact.dob = "dob";
			externalContact.emailAddress = "test@test.com";
			externalContact.homePhone = "6148675309";
			externalContact.workPhone = "6148675309";
			externalContact.mobileNumber = "mobileNumber";
			externalContact.faxNumber = "faxNumber";
			externalContact.active = true;
			externalContact.contactType = "contactType";
			externalContact.oldId = "oldId";
			contacts.Add(externalContact);
			contactsSyncRequest.contacts = contacts;

			//create the request
			string json = Utilities.buildRequestJson(contactsSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ContactsSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ContactsSyncResponse contactsSyncResponse = javascriptSerializer.Deserialize<ContactsSyncResponse>(jsonResponse);

			Console.WriteLine(contactsSyncResponse.responseCode);
			Console.WriteLine(contactsSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalContact {
			public string id { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string businessName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string country { get; set;}
			public string zip5 { get; set;}
			public string dob { get; set;}
			public string emailAddress { get; set;}
			public string homePhone { get; set;}
			public string workPhone { get; set;}
			public string mobileNumber { get; set;}
			public string faxNumber { get; set;}
			public bool active { get; set;}
			public string contactType { get; set;}
			public string oldId { get; set;}
		}

		public class ContactsSyncRequest : UpdoxRequest {
			public List<ExternalContact> contacts { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class ContactsSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ContactsSync {

	public static void main(String[] args) {
		UpdoxCodeSample_ContactsSync codeSample = new UpdoxCodeSample_ContactsSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ContactsSync";

		ContactsSyncRequest contactsSyncRequest = new ContactsSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = contactsSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalContact> contacts = new ArrayList<>();
		ExternalContact externalContact = new ExternalContact();
		externalContact.setId("id");
		externalContact.setFirstName("firstName");
		externalContact.setMiddleName("middleName");
		externalContact.setLastName("lastName");
		externalContact.setBusinessName("businessName");
		externalContact.setAddress1("address1");
		externalContact.setAddress2("address2");
		externalContact.setCity("Dublin");
		externalContact.setState("OH");
		externalContact.setCountry("country");
		externalContact.setZip5("43017");
		externalContact.setDob("dob");
		externalContact.setEmailAddress("test@test.com");
		externalContact.setHomePhone("6148675309");
		externalContact.setWorkPhone("6148675309");
		externalContact.setMobileNumber("mobileNumber");
		externalContact.setFaxNumber("faxNumber");
		externalContact.setActive(true);
		externalContact.setContactType("contactType");
		externalContact.setOldId("oldId");
		contacts.add(externalContact);
		contactsSyncRequest.setContacts(contacts);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(contactsSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ContactsSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ContactsSyncResponse contactsSyncResponse = mapper.readValue(jsonResponse, ContactsSyncResponse.class);

		System.out.println(contactsSyncResponse.getResponseCode());
		System.out.println(contactsSyncResponse.getResponseMessage());
	}

	private static class ExternalContact {
		private String id;
		private String firstName;
		private String middleName;
		private String lastName;
		private String businessName;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String country;
		private String zip5;
		private String dob;
		private String emailAddress;
		private String homePhone;
		private String workPhone;
		private String mobileNumber;
		private String faxNumber;
		private boolean active;
		private String contactType;
		private String oldId;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getBusinessName() {
			return businessName;
		}

		public void setBusinessName(String businessName) {
			this.businessName = businessName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getZip5() {
			return zip5;
		}

		public void setZip5(String zip5) {
			this.zip5 = zip5;
		}

		public String getDob() {
			return dob;
		}

		public void setDob(String dob) {
			this.dob = dob;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getMobileNumber() {
			return mobileNumber;
		}

		public void setMobileNumber(String mobileNumber) {
			this.mobileNumber = mobileNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getOldId() {
			return oldId;
		}

		public void setOldId(String oldId) {
			this.oldId = oldId;
		}
	}

	private class ContactsSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalContact> contacts;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalContact> getContacts() {
			return contacts;
		}

		public void setContacts(List<ExternalContact> contacts) {
			this.contacts = contacts;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class ContactsSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

EhrUsersSync /io/EhrUsersSync

Creates or modifies one or more EHR users.

Parameter	Type	Value
ehrUsers	List	add remove

id	String
providerId	String
firstName	String
middleName	String
lastName	String
active	Boolean
canSignOff	Boolean
isDoctor	Boolean

Try it! Toggle Notes/Code Samples

EhrUsersSync

Creates or modifies one or more EHR users.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_EhrUsersSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_EhrUsersSync codeSample = new UpdoxCodeSample_EhrUsersSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "EhrUsersSync";
			EhrUsersSyncRequest ehrUsersSyncRequest = new EhrUsersSyncRequest();

			//set up credentials
			ehrUsersSyncRequest.auth.applicationId = "applicationId";
			ehrUsersSyncRequest.auth.applicationPassword = "applicationPassword";
			ehrUsersSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalEmrUser> ehrUsers = new List<ExternalEmrUser>();
			ExternalEmrUser externalEmrUser = new ExternalEmrUser();
			externalEmrUser.id = "id";
			externalEmrUser.providerId = "providerId";
			externalEmrUser.firstName = "firstName";
			externalEmrUser.middleName = "middleName";
			externalEmrUser.lastName = "lastName";
			externalEmrUser.active = true;
			externalEmrUser.canSignOff = true;
			externalEmrUser.isDoctor = true;
			ehrUsers.Add(externalEmrUser);
			ehrUsersSyncRequest.ehrUsers = ehrUsers;

			//create the request
			string json = Utilities.buildRequestJson(ehrUsersSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "EhrUsersSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			EhrUsersSyncResponse ehrUsersSyncResponse = javascriptSerializer.Deserialize<EhrUsersSyncResponse>(jsonResponse);

			Console.WriteLine(ehrUsersSyncResponse.responseCode);
			Console.WriteLine(ehrUsersSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalEmrUser {
			public string id { get; set;}
			public string providerId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public bool active { get; set;}
			public bool canSignOff { get; set;}
			public bool isDoctor { get; set;}
		}

		public class EhrUsersSyncRequest : UpdoxRequest {
			public List<ExternalEmrUser> ehrUsers { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class EhrUsersSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_EhrUsersSync {

	public static void main(String[] args) {
		UpdoxCodeSample_EhrUsersSync codeSample = new UpdoxCodeSample_EhrUsersSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "EhrUsersSync";

		EhrUsersSyncRequest ehrUsersSyncRequest = new EhrUsersSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = ehrUsersSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalEmrUser> ehrUsers = new ArrayList<>();
		ExternalEmrUser externalEmrUser = new ExternalEmrUser();
		externalEmrUser.setId("id");
		externalEmrUser.setProviderId("providerId");
		externalEmrUser.setFirstName("firstName");
		externalEmrUser.setMiddleName("middleName");
		externalEmrUser.setLastName("lastName");
		externalEmrUser.setActive(true);
		externalEmrUser.setCanSignOff(true);
		externalEmrUser.setIsDoctor(true);
		ehrUsers.add(externalEmrUser);
		ehrUsersSyncRequest.setEhrUsers(ehrUsers);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(ehrUsersSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'EhrUsersSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		EhrUsersSyncResponse ehrUsersSyncResponse = mapper.readValue(jsonResponse, EhrUsersSyncResponse.class);

		System.out.println(ehrUsersSyncResponse.getResponseCode());
		System.out.println(ehrUsersSyncResponse.getResponseMessage());
	}

	private static class ExternalEmrUser {
		private String id;
		private String providerId;
		private String firstName;
		private String middleName;
		private String lastName;
		private boolean active;
		private boolean canSignOff;
		private boolean isDoctor;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getProviderId() {
			return providerId;
		}

		public void setProviderId(String providerId) {
			this.providerId = providerId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isCanSignOff() {
			return canSignOff;
		}

		public void setCanSignOff(boolean canSignOff) {
			this.canSignOff = canSignOff;
		}

		public boolean isIsDoctor() {
			return isDoctor;
		}

		public void setIsDoctor(boolean isDoctor) {
			this.isDoctor = isDoctor;
		}
	}

	private class EhrUsersSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalEmrUser> ehrUsers;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalEmrUser> getEhrUsers() {
			return ehrUsers;
		}

		public void setEhrUsers(List<ExternalEmrUser> ehrUsers) {
			this.ehrUsers = ehrUsers;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class EhrUsersSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FileUpload /io/FileUpload

Upload files to the practice's inbox

Image files will be converted to smart B&W standard fax resolution

Parameter	Type	Value	Description
attachments	Array	add remove	Array of attachments to upload, each attachment content is expected Base64 encoded. This is required.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

FileUpload

Upload files to the practice's inbox

Image files will be converted to smart B&W standard fax resolution

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FileUpload {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FileUpload codeSample = new UpdoxCodeSample_FileUpload();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FileUpload";
			FileUploadRequest fileUploadRequest = new FileUploadRequest();

			//set up credentials
			fileUploadRequest.auth.applicationId = "applicationId";
			fileUploadRequest.auth.applicationPassword = "applicationPassword";
			fileUploadRequest.auth.accountId = "accountId";
			fileUploadRequest.auth.userId = "userId";

			//set up request specific parameters
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			fileUploadRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(fileUploadRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FileUpload", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FileUploadResponse fileUploadResponse = javascriptSerializer.Deserialize<FileUploadResponse>(jsonResponse);

			Console.WriteLine(fileUploadResponse.responseCode);
			Console.WriteLine(fileUploadResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FileUploadRequest : UpdoxRequest {
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FileUploadResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_FileUpload {

	public static void main(String[] args) {
		UpdoxCodeSample_FileUpload codeSample = new UpdoxCodeSample_FileUpload();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FileUpload";

		FileUploadRequest fileUploadRequest = new FileUploadRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = fileUploadRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		fileUploadRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(fileUploadRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FileUpload', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FileUploadResponse fileUploadResponse = mapper.readValue(jsonResponse, FileUploadResponse.class);

		System.out.println(fileUploadResponse.getResponseCode());
		System.out.println(fileUploadResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class FileUploadRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class FileUploadResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

FileUserUpload /io/FileUserUpload

Upload files to the user's inbox

Image files will be converted to the image resolution set in the user's "Convert Printed/Uploaded items" profile setting

Parameter	Type	Value	Description
attachments	Array	add remove	Array of attachments to upload, each attachment content is expected to be Base64 encoded. This is required.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

FileUserUpload

Upload files to the user's inbox

Image files will be converted to the image resolution set in the user's "Convert Printed/Uploaded items" profile setting

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_FileUserUpload {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_FileUserUpload codeSample = new UpdoxCodeSample_FileUserUpload();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "FileUserUpload";
			FileUserUploadRequest fileUserUploadRequest = new FileUserUploadRequest();

			//set up credentials
			fileUserUploadRequest.auth.applicationId = "applicationId";
			fileUserUploadRequest.auth.applicationPassword = "applicationPassword";
			fileUserUploadRequest.auth.accountId = "accountId";
			fileUserUploadRequest.auth.userId = "userId";

			//set up request specific parameters
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			fileUserUploadRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(fileUserUploadRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "FileUserUpload", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			FileUserUploadResponse fileUserUploadResponse = javascriptSerializer.Deserialize<FileUserUploadResponse>(jsonResponse);

			Console.WriteLine(fileUserUploadResponse.responseCode);
			Console.WriteLine(fileUserUploadResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class FileUserUploadRequest : UpdoxRequest {
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FileUserUploadResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_FileUserUpload {

	public static void main(String[] args) {
		UpdoxCodeSample_FileUserUpload codeSample = new UpdoxCodeSample_FileUserUpload();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "FileUserUpload";

		FileUserUploadRequest fileUserUploadRequest = new FileUserUploadRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = fileUserUploadRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		fileUserUploadRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(fileUserUploadRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'FileUserUpload', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		FileUserUploadResponse fileUserUploadResponse = mapper.readValue(jsonResponse, FileUserUploadResponse.class);

		System.out.println(fileUserUploadResponse.getResponseCode());
		System.out.println(fileUserUploadResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class FileUserUploadRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class FileUserUploadResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

IPSync /io/IPSync

Sync IP or domain of practice.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
ip	String	The IP or domain of the practice. This is required.
port	Long	Optional port to use with the IP address.
path	String	Optional path after the IP and port.
protocol	String	Protocol to be used. If provided, must be either 'http' or 'https'.

Try it! Toggle Notes/Code Samples

IPSync

Sync IP or domain of practice.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_IPSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_IPSync codeSample = new UpdoxCodeSample_IPSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "IPSync";
			IPSyncRequest iPSyncRequest = new IPSyncRequest();

			//set up credentials
			iPSyncRequest.auth.applicationId = "applicationId";
			iPSyncRequest.auth.applicationPassword = "applicationPassword";
			iPSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			iPSyncRequest.ip = "ip";
			iPSyncRequest.port = 1L;
			iPSyncRequest.path = "path";
			iPSyncRequest.protocol = "protocol";

			//create the request
			string json = Utilities.buildRequestJson(iPSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "IPSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			IPSyncResponse iPSyncResponse = javascriptSerializer.Deserialize<IPSyncResponse>(jsonResponse);

			Console.WriteLine(iPSyncResponse.responseCode);
			Console.WriteLine(iPSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class IPSyncRequest : UpdoxRequest {
			public string ip { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public string protocol { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class IPSyncResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_IPSync {

	public static void main(String[] args) {
		UpdoxCodeSample_IPSync codeSample = new UpdoxCodeSample_IPSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "IPSync";

		IPSyncRequest iPSyncRequest = new IPSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = iPSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		iPSyncRequest.setIp("ip");
		iPSyncRequest.setPort(1L);
		iPSyncRequest.setPath("path");
		iPSyncRequest.setProtocol("protocol");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(iPSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'IPSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		IPSyncResponse iPSyncResponse = mapper.readValue(jsonResponse, IPSyncResponse.class);

		System.out.println(iPSyncResponse.getResponseCode());
		System.out.println(iPSyncResponse.getResponseMessage());
	}

	private class IPSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ip;
    	private long port;
    	private String path;
    	private String protocol;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIp() {
			return ip;
		}

		public void setIp(String ip) {
			this.ip = ip;
		}

		public long getPort() {
			return port;
		}

		public void setPort(long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IPSyncResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4162`	`ip is invalid`
`4165`	`port is invalid`

IPSync/1.1 /io/IPSync/1.1

Sync IP or domain of practice.

Parameter	Type	Description
ip	String	The IP or domain of the practice. This is required.
port	Long	Optional port to use with the IP address.
path	String	Optional path after the IP and port.
protocol	String	Protocol to be used. Must be one of the following values: http, https. This is required.

Try it! Toggle Notes/Code Samples

IPSync/1.1

Sync IP or domain of practice.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_IPSync1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_IPSync1_1 codeSample = new UpdoxCodeSample_IPSync1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "IPSync1_1";
			IPSync1_1Request iPSync1_1Request = new IPSync1_1Request();

			//set up credentials
			iPSync1_1Request.auth.applicationId = "applicationId";
			iPSync1_1Request.auth.applicationPassword = "applicationPassword";
			iPSync1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			iPSync1_1Request.ip = "ip";
			iPSync1_1Request.port = 1L;
			iPSync1_1Request.path = "path";
			iPSync1_1Request.protocol = "protocol";

			//create the request
			string json = Utilities.buildRequestJson(iPSync1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "IPSync/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			IPSync1_1Response iPSync1_1Response = javascriptSerializer.Deserialize<IPSync1_1Response>(jsonResponse);

			Console.WriteLine(iPSync1_1Response.responseCode);
			Console.WriteLine(iPSync1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class IPSync1_1Request : UpdoxRequest {
			public string ip { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public string protocol { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class IPSync1_1Response : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_IPSync1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_IPSync1_1 codeSample = new UpdoxCodeSample_IPSync1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "IPSync1_1";

		IPSync1_1Request iPSync1_1Request = new IPSync1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = iPSync1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		iPSync1_1Request.setIp("ip");
		iPSync1_1Request.setPort(1L);
		iPSync1_1Request.setPath("path");
		iPSync1_1Request.setProtocol("protocol");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(iPSync1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'IPSync/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		IPSync1_1Response iPSync1_1Response = mapper.readValue(jsonResponse, IPSync1_1Response.class);

		System.out.println(iPSync1_1Response.getResponseCode());
		System.out.println(iPSync1_1Response.getResponseMessage());
	}

	private class IPSync1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ip;
    	private long port;
    	private String path;
    	private String protocol;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIp() {
			return ip;
		}

		public void setIp(String ip) {
			this.ip = ip;
		}

		public long getPort() {
			return port;
		}

		public void setPort(long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IPSync1_1Response extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4162`	`ip is invalid`
`4165`	`port is invalid`

ImportCategoriesSync /io/ImportCategoriesSync

Creates or modifies one or more Import categories.

Parameter	Type	Value
categories	List	add remove

key	String
display	String
active	Boolean
order	Int

Try it! Toggle Notes/Code Samples

ImportCategoriesSync

Creates or modifies one or more Import categories.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ImportCategoriesSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ImportCategoriesSync codeSample = new UpdoxCodeSample_ImportCategoriesSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ImportCategoriesSync";
			ImportCategoriesSyncRequest importCategoriesSyncRequest = new ImportCategoriesSyncRequest();

			//set up credentials
			importCategoriesSyncRequest.auth.applicationId = "applicationId";
			importCategoriesSyncRequest.auth.applicationPassword = "applicationPassword";
			importCategoriesSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalCategory> categories = new List<ExternalCategory>();
			ExternalCategory externalCategory = new ExternalCategory();
			externalCategory.key = "key";
			externalCategory.display = "display";
			externalCategory.active = true;
			externalCategory.order = 1;
			categories.Add(externalCategory);
			importCategoriesSyncRequest.categories = categories;

			//create the request
			string json = Utilities.buildRequestJson(importCategoriesSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ImportCategoriesSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ImportCategoriesSyncResponse importCategoriesSyncResponse = javascriptSerializer.Deserialize<ImportCategoriesSyncResponse>(jsonResponse);

			Console.WriteLine(importCategoriesSyncResponse.responseCode);
			Console.WriteLine(importCategoriesSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalCategory {
			public string key { get; set;}
			public string display { get; set;}
			public bool active { get; set;}
			public int order { get; set;}
		}

		public class ImportCategoriesSyncRequest : UpdoxRequest {
			public List<ExternalCategory> categories { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class ImportCategoriesSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ImportCategoriesSync {

	public static void main(String[] args) {
		UpdoxCodeSample_ImportCategoriesSync codeSample = new UpdoxCodeSample_ImportCategoriesSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ImportCategoriesSync";

		ImportCategoriesSyncRequest importCategoriesSyncRequest = new ImportCategoriesSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = importCategoriesSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalCategory> categories = new ArrayList<>();
		ExternalCategory externalCategory = new ExternalCategory();
		externalCategory.setKey("key");
		externalCategory.setDisplay("display");
		externalCategory.setActive(true);
		externalCategory.setOrder(1);
		categories.add(externalCategory);
		importCategoriesSyncRequest.setCategories(categories);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(importCategoriesSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ImportCategoriesSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ImportCategoriesSyncResponse importCategoriesSyncResponse = mapper.readValue(jsonResponse, ImportCategoriesSyncResponse.class);

		System.out.println(importCategoriesSyncResponse.getResponseCode());
		System.out.println(importCategoriesSyncResponse.getResponseMessage());
	}

	private static class ExternalCategory {
		private String key;
		private String display;
		private boolean active;
		private int order;


		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}

		public String getDisplay() {
			return display;
		}

		public void setDisplay(String display) {
			this.display = display;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public int getOrder() {
			return order;
		}

		public void setOrder(int order) {
			this.order = order;
		}
	}

	private class ImportCategoriesSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalCategory> categories;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalCategory> getCategories() {
			return categories;
		}

		public void setCategories(List<ExternalCategory> categories) {
			this.categories = categories;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class ImportCategoriesSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

LocationsSync /io/LocationsSync

Creates or modifies one or more locations.

Parameter	Type	Value	Description
locations	List	add remove	Array of locations.

id	String		Your id of the location. This is required.
code	String		A code for the location.
name	String		The name of the location.
address1	String
address2	String
city	String
state	String
zip	String
country	String
dayphone	String
evephone	String
faxphone	String
apptphone	String
emailAddress	String
about	String
showInPortal	Boolean		Show this location on the portal.
active	Boolean		Set location active status.
sortOrder	Long		Sort order, defaults to 0.
url	String		URL of this location.
reminderTurnOff	Boolean		Turn off reminders for this location. Defaults to false.
locationHours	Array	add remove	Open hours.

id	Int		0=Sun, 1=Mon, 2=Tue, 3=Wed, 4=Thu, 5=Fri, 6=Sat. Defaults to 0 if not specified. The value must be between 0 and 6.
is_open	Boolean		Open for business? Defaults to false.
open	Int		Opens at, minutes from midnight. Defaults to 540(9am). The value must be between 0 and 1440.
close	Int		Closes at, minutes from midnight. Defaults to 1020(5pm). The value must be between 0 and 1440.
showAboutUs	Boolean
showFaxNumber	Boolean
showPhoneNumber	Boolean
showAddress	Boolean
showHours	Boolean
showEmailAddress	Boolean

Try it! Toggle Notes/Code Samples

LocationsSync

Creates or modifies one or more locations.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_LocationsSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_LocationsSync codeSample = new UpdoxCodeSample_LocationsSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "LocationsSync";
			LocationsSyncRequest locationsSyncRequest = new LocationsSyncRequest();

			//set up credentials
			locationsSyncRequest.auth.applicationId = "applicationId";
			locationsSyncRequest.auth.applicationPassword = "applicationPassword";
			locationsSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			Hours locationHoursHours = new Hours();
			locationHoursHours.id = 1;
			locationHoursHours.is_open = true;
			locationHoursHours.open = 1;
			locationHoursHours.close = 1;
			Hours[] locationHours = new Hours[]{locationHoursHours};
			List<Location> locations = new List<Location>();
			Location location = new Location();
			location.id = "id";
			location.code = "code";
			location.name = "name";
			location.address1 = "address1";
			location.address2 = "address2";
			location.city = "Dublin";
			location.state = "OH";
			location.zip = "43017";
			location.country = "country";
			location.dayphone = "6148675309";
			location.evephone = "6148675309";
			location.faxphone = "6148675309";
			location.apptphone = "6148675309";
			location.emailAddress = "test@test.com";
			location.about = "about";
			location.showInPortal = true;
			location.active = true;
			location.sortOrder = 1L;
			location.url = "url";
			location.reminderTurnOff = true;
			location.locationHours = locationHours;
			location.showAboutUs = true;
			location.showFaxNumber = true;
			location.showPhoneNumber = true;
			location.showAddress = true;
			location.showHours = true;
			location.showEmailAddress = true;
			locations.Add(location);
			locationsSyncRequest.locations = locations;

			//create the request
			string json = Utilities.buildRequestJson(locationsSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "LocationsSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			LocationsSyncResponse locationsSyncResponse = javascriptSerializer.Deserialize<LocationsSyncResponse>(jsonResponse);

			Console.WriteLine(locationsSyncResponse.responseCode);
			Console.WriteLine(locationsSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Hours {
			public int id { get; set;}
			public bool is_open { get; set;}
			public int open { get; set;}
			public int close { get; set;}
		}

		public class Location {
			public string id { get; set;}
			public string code { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string country { get; set;}
			public string dayphone { get; set;}
			public string evephone { get; set;}
			public string faxphone { get; set;}
			public string apptphone { get; set;}
			public string emailAddress { get; set;}
			public string about { get; set;}
			public bool showInPortal { get; set;}
			public bool active { get; set;}
			public long sortOrder { get; set;}
			public string url { get; set;}
			public bool reminderTurnOff { get; set;}
			public Hours[] locationHours { get; set;}
			public bool showAboutUs { get; set;}
			public bool showFaxNumber { get; set;}
			public bool showPhoneNumber { get; set;}
			public bool showAddress { get; set;}
			public bool showHours { get; set;}
			public bool showEmailAddress { get; set;}
		}

		public class LocationsSyncRequest : UpdoxRequest {
			public List<Location> locations { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class LocationsSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_LocationsSync {

	public static void main(String[] args) {
		UpdoxCodeSample_LocationsSync codeSample = new UpdoxCodeSample_LocationsSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "LocationsSync";

		LocationsSyncRequest locationsSyncRequest = new LocationsSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = locationsSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		Hours locationHoursHours = new Hours();
		locationHoursHours.setId(1);
		locationHoursHours.setIs_open(true);
		locationHoursHours.setOpen(1);
		locationHoursHours.setClose(1);
		Hours[] locationHours = new Hours[]{locationHoursHours};
	List<Location> locations = new ArrayList<>();
		Location location = new Location();
		location.setId("id");
		location.setCode("code");
		location.setName("name");
		location.setAddress1("address1");
		location.setAddress2("address2");
		location.setCity("Dublin");
		location.setState("OH");
		location.setZip("43017");
		location.setCountry("country");
		location.setDayphone("6148675309");
		location.setEvephone("6148675309");
		location.setFaxphone("6148675309");
		location.setApptphone("6148675309");
		location.setEmailAddress("test@test.com");
		location.setAbout("about");
		location.setShowInPortal(true);
		location.setActive(true);
		location.setSortOrder(1L);
		location.setUrl("url");
		location.setReminderTurnOff(true);
		location.setLocationHours(locationHours);
		location.setShowAboutUs(true);
		location.setShowFaxNumber(true);
		location.setShowPhoneNumber(true);
		location.setShowAddress(true);
		location.setShowHours(true);
		location.setShowEmailAddress(true);
		locations.add(location);
		locationsSyncRequest.setLocations(locations);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(locationsSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'LocationsSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		LocationsSyncResponse locationsSyncResponse = mapper.readValue(jsonResponse, LocationsSyncResponse.class);

		System.out.println(locationsSyncResponse.getResponseCode());
		System.out.println(locationsSyncResponse.getResponseMessage());
	}

	private static class Hours {
		private int id;
		private boolean is_open;
		private int open;
		private int close;


		public int getId() {
			return id;
		}

		public void setId(int id) {
			this.id = id;
		}

		public boolean isIs_open() {
			return is_open;
		}

		public void setIs_open(boolean is_open) {
			this.is_open = is_open;
		}

		public int getOpen() {
			return open;
		}

		public void setOpen(int open) {
			this.open = open;
		}

		public int getClose() {
			return close;
		}

		public void setClose(int close) {
			this.close = close;
		}
	}

	private static class Location {
		private String id;
		private String code;
		private String name;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String zip;
		private String country;
		private String dayphone;
		private String evephone;
		private String faxphone;
		private String apptphone;
		private String emailAddress;
		private String about;
		private boolean showInPortal;
		private boolean active;
		private long sortOrder;
		private String url;
		private boolean reminderTurnOff;
		private Hours[] locationHours;
		private boolean showAboutUs;
		private boolean showFaxNumber;
		private boolean showPhoneNumber;
		private boolean showAddress;
		private boolean showHours;
		private boolean showEmailAddress;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getDayphone() {
			return dayphone;
		}

		public void setDayphone(String dayphone) {
			this.dayphone = dayphone;
		}

		public String getEvephone() {
			return evephone;
		}

		public void setEvephone(String evephone) {
			this.evephone = evephone;
		}

		public String getFaxphone() {
			return faxphone;
		}

		public void setFaxphone(String faxphone) {
			this.faxphone = faxphone;
		}

		public String getApptphone() {
			return apptphone;
		}

		public void setApptphone(String apptphone) {
			this.apptphone = apptphone;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getAbout() {
			return about;
		}

		public void setAbout(String about) {
			this.about = about;
		}

		public boolean isShowInPortal() {
			return showInPortal;
		}

		public void setShowInPortal(boolean showInPortal) {
			this.showInPortal = showInPortal;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public long getSortOrder() {
			return sortOrder;
		}

		public void setSortOrder(long sortOrder) {
			this.sortOrder = sortOrder;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}

		public Hours[] getLocationHours() {
			return locationHours;
		}

		public void setLocationHours(Hours[] locationHours) {
			this.locationHours = locationHours;
		}

		public boolean isShowAboutUs() {
			return showAboutUs;
		}

		public void setShowAboutUs(boolean showAboutUs) {
			this.showAboutUs = showAboutUs;
		}

		public boolean isShowFaxNumber() {
			return showFaxNumber;
		}

		public void setShowFaxNumber(boolean showFaxNumber) {
			this.showFaxNumber = showFaxNumber;
		}

		public boolean isShowPhoneNumber() {
			return showPhoneNumber;
		}

		public void setShowPhoneNumber(boolean showPhoneNumber) {
			this.showPhoneNumber = showPhoneNumber;
		}

		public boolean isShowAddress() {
			return showAddress;
		}

		public void setShowAddress(boolean showAddress) {
			this.showAddress = showAddress;
		}

		public boolean isShowHours() {
			return showHours;
		}

		public void setShowHours(boolean showHours) {
			this.showHours = showHours;
		}

		public boolean isShowEmailAddress() {
			return showEmailAddress;
		}

		public void setShowEmailAddress(boolean showEmailAddress) {
			this.showEmailAddress = showEmailAddress;
		}
	}

	private class LocationsSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<Location> locations;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<Location> getLocations() {
			return locations;
		}

		public void setLocations(List<Location> locations) {
			this.locations = locations;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class LocationsSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PatientBalancesSync /io/PatientBalancesSync

Update one or more patient balances.

Parameter	Type	Value
patientBalances	List	add remove

patientId	String
balance	String

Try it! Toggle Notes/Code Samples

PatientBalancesSync

Update one or more patient balances.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientBalancesSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientBalancesSync codeSample = new UpdoxCodeSample_PatientBalancesSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientBalancesSync";
			PatientBalancesSyncRequest patientBalancesSyncRequest = new PatientBalancesSyncRequest();

			//set up credentials
			patientBalancesSyncRequest.auth.applicationId = "applicationId";
			patientBalancesSyncRequest.auth.applicationPassword = "applicationPassword";
			patientBalancesSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalPatientBalance> patientBalances = new List<ExternalPatientBalance>();
			ExternalPatientBalance externalPatientBalance = new ExternalPatientBalance();
			externalPatientBalance.patientId = "patientId";
			externalPatientBalance.balance = "balance";
			patientBalances.Add(externalPatientBalance);
			patientBalancesSyncRequest.patientBalances = patientBalances;

			//create the request
			string json = Utilities.buildRequestJson(patientBalancesSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientBalancesSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientBalancesSyncResponse patientBalancesSyncResponse = javascriptSerializer.Deserialize<PatientBalancesSyncResponse>(jsonResponse);

			Console.WriteLine(patientBalancesSyncResponse.responseCode);
			Console.WriteLine(patientBalancesSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalPatientBalance {
			public string patientId { get; set;}
			public string balance { get; set;}
		}

		public class PatientBalancesSyncRequest : UpdoxRequest {
			public List<ExternalPatientBalance> patientBalances { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class PatientBalancesSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PatientBalancesSync {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientBalancesSync codeSample = new UpdoxCodeSample_PatientBalancesSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientBalancesSync";

		PatientBalancesSyncRequest patientBalancesSyncRequest = new PatientBalancesSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientBalancesSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalPatientBalance> patientBalances = new ArrayList<>();
		ExternalPatientBalance externalPatientBalance = new ExternalPatientBalance();
		externalPatientBalance.setPatientId("patientId");
		externalPatientBalance.setBalance("balance");
		patientBalances.add(externalPatientBalance);
		patientBalancesSyncRequest.setPatientBalances(patientBalances);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientBalancesSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientBalancesSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientBalancesSyncResponse patientBalancesSyncResponse = mapper.readValue(jsonResponse, PatientBalancesSyncResponse.class);

		System.out.println(patientBalancesSyncResponse.getResponseCode());
		System.out.println(patientBalancesSyncResponse.getResponseMessage());
	}

	private static class ExternalPatientBalance {
		private String patientId;
		private String balance;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getBalance() {
			return balance;
		}

		public void setBalance(String balance) {
			this.balance = balance;
		}
	}

	private class PatientBalancesSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalPatientBalance> patientBalances;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalPatientBalance> getPatientBalances() {
			return patientBalances;
		}

		public void setPatientBalances(List<ExternalPatientBalance> patientBalances) {
			this.patientBalances = patientBalances;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class PatientBalancesSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PatientsSync /io/PatientsSync

Creates or modifies one or more patients, optionally including primary and/or secondary insurance. This API call should only be used for syncing patient data, not for contacts.

Note: id field was removed December 2023 as it was an unused field.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patients	List	add remove

chartNumber	String		The chart number of the patient, 64 characters max if included.
internalId	String		The id of the patient. This is required.
firstName	String		The first name of the patient.
middleName	String		The middle name of the patient.
lastName	String		The last name of the patient.
sex	String		The gender of the patient. Must be one of the following values: m, f, o, male, female, other, u, unknown.
address1	String		The address of the patient.
address2	String		The extra address information of the patient.
city	String		The city of the patient.
state	String		The state/province of the patient.
countryCode	String		The ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the patient's address.
zip5	String		The zip code of the patient, expect 5 digits.
dob	String		The date of birth of the patient, expected format is 'yyyy-MM-dd'.
emailAddress	String		The email address of the patient.
homePhone	String		The home phone number of the patient.
workPhone	String		The work phone number of the patient.
workExtension	String		The extension of the work phone number of the patient.
mobileNumber	String		The cell phone number of the patient.
faxNumber	String		The fax phone number of the patient.
reminderMethodId	Int		The reminder communication preference of the patient. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0.
active	Boolean		If patient is active, expect boolean value.
contactType	String		Expected value is 'patient'. If left blank, contactType will default to 'patient'.
defaultProvider	String		The default provider of the patient.
maritalStatus	String		The marital status of the patient, expected values are 'single', 'married', 'divorced', 'widowed', 'other'.
primaryInsurance			The primary insurance of the patient.
companyName	String
phoneNumber	String
address1	String
address2	String
city	String
state	String
zip	String
policyNumber	String
groupNumber	String
planName	String
groupName	String
effectiveDate	String
expirationDate	String
guarantorRelationship	String
guarantorName	String
guarantorFirstName	String
guarantorMiddleName	String
guarantorLastName	String
guarantorDob	String
guarantorGender	String
copayAmount	String
secondaryInsurance			The secondary insurance of the patient.
companyName	String
phoneNumber	String
address1	String
address2	String
city	String
state	String
zip	String
policyNumber	String
groupNumber	String
planName	String
groupName	String
effectiveDate	String
expirationDate	String
guarantorRelationship	String
guarantorName	String
guarantorFirstName	String
guarantorMiddleName	String
guarantorLastName	String
guarantorDob	String
guarantorGender	String
copayAmount	String
languagePref	String		The language preference of the patient. Must be one of the following values: English, Spanish.

Try it! Toggle Notes/Code Samples

PatientsSync

Creates or modifies one or more patients, optionally including primary and/or secondary insurance. This API call should only be used for syncing patient data, not for contacts.

Note: id field was removed December 2023 as it was an unused field.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

System will parse list of patients and attempt to find existing records based on the id passed in. If no match is found and an old id value is supplied, an additional check for that identifier will be performed prior to inserting a new record. If a match is not found, a new patient is created with the information supplied.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientsSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientsSync codeSample = new UpdoxCodeSample_PatientsSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientsSync";
			PatientsSyncRequest patientsSyncRequest = new PatientsSyncRequest();

			//set up credentials
			patientsSyncRequest.auth.applicationId = "applicationId";
			patientsSyncRequest.auth.applicationPassword = "applicationPassword";
			patientsSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			ExternalInsurance primaryInsurance = new ExternalInsurance();
			primaryInsurance.companyName = "companyName";
			primaryInsurance.phoneNumber = "6148675309";
			primaryInsurance.address1 = "address1";
			primaryInsurance.address2 = "address2";
			primaryInsurance.city = "Dublin";
			primaryInsurance.state = "OH";
			primaryInsurance.zip = "43017";
			primaryInsurance.policyNumber = "policyNumber";
			primaryInsurance.groupNumber = "groupNumber";
			primaryInsurance.planName = "planName";
			primaryInsurance.groupName = "groupName";
			primaryInsurance.effectiveDate = "effectiveDate";
			primaryInsurance.expirationDate = "expirationDate";
			primaryInsurance.guarantorRelationship = "guarantorRelationship";
			primaryInsurance.guarantorName = "guarantorName";
			primaryInsurance.guarantorFirstName = "guarantorFirstName";
			primaryInsurance.guarantorMiddleName = "guarantorMiddleName";
			primaryInsurance.guarantorLastName = "guarantorLastName";
			primaryInsurance.guarantorDob = "guarantorDob";
			primaryInsurance.guarantorGender = "guarantorGender";
			primaryInsurance.copayAmount = "copayAmount";
			ExternalInsurance secondaryInsurance = new ExternalInsurance();
			secondaryInsurance.companyName = "companyName";
			secondaryInsurance.phoneNumber = "6148675309";
			secondaryInsurance.address1 = "address1";
			secondaryInsurance.address2 = "address2";
			secondaryInsurance.city = "Dublin";
			secondaryInsurance.state = "OH";
			secondaryInsurance.zip = "43017";
			secondaryInsurance.policyNumber = "policyNumber";
			secondaryInsurance.groupNumber = "groupNumber";
			secondaryInsurance.planName = "planName";
			secondaryInsurance.groupName = "groupName";
			secondaryInsurance.effectiveDate = "effectiveDate";
			secondaryInsurance.expirationDate = "expirationDate";
			secondaryInsurance.guarantorRelationship = "guarantorRelationship";
			secondaryInsurance.guarantorName = "guarantorName";
			secondaryInsurance.guarantorFirstName = "guarantorFirstName";
			secondaryInsurance.guarantorMiddleName = "guarantorMiddleName";
			secondaryInsurance.guarantorLastName = "guarantorLastName";
			secondaryInsurance.guarantorDob = "guarantorDob";
			secondaryInsurance.guarantorGender = "guarantorGender";
			secondaryInsurance.copayAmount = "copayAmount";
			List<ExternalPatient> patients = new List<ExternalPatient>();
			ExternalPatient externalPatient = new ExternalPatient();
			externalPatient.chartNumber = "chartNumber";
			externalPatient.internalId = "internalId";
			externalPatient.firstName = "firstName";
			externalPatient.middleName = "middleName";
			externalPatient.lastName = "lastName";
			externalPatient.sex = "M";
			externalPatient.address1 = "address1";
			externalPatient.address2 = "address2";
			externalPatient.city = "Dublin";
			externalPatient.state = "OH";
			externalPatient.countryCode = "countryCode";
			externalPatient.zip5 = "43017";
			externalPatient.dob = "dob";
			externalPatient.emailAddress = "test@test.com";
			externalPatient.homePhone = "6148675309";
			externalPatient.workPhone = "6148675309";
			externalPatient.workExtension = "workExtension";
			externalPatient.mobileNumber = "mobileNumber";
			externalPatient.faxNumber = "faxNumber";
			externalPatient.reminderMethodId = 1;
			externalPatient.active = true;
			externalPatient.contactType = "contactType";
			externalPatient.defaultProvider = "defaultProvider";
			externalPatient.maritalStatus = "M";
			externalPatient.primaryInsurance = primaryInsurance;
			externalPatient.secondaryInsurance = secondaryInsurance;
			externalPatient.languagePref = "languagePref";
			patients.Add(externalPatient);
			patientsSyncRequest.patients = patients;

			//create the request
			string json = Utilities.buildRequestJson(patientsSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientsSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientsSyncResponse patientsSyncResponse = javascriptSerializer.Deserialize<PatientsSyncResponse>(jsonResponse);

			Console.WriteLine(patientsSyncResponse.responseCode);
			Console.WriteLine(patientsSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalInsurance {
			public string companyName { get; set;}
			public string phoneNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string policyNumber { get; set;}
			public string groupNumber { get; set;}
			public string planName { get; set;}
			public string groupName { get; set;}
			public string effectiveDate { get; set;}
			public string expirationDate { get; set;}
			public string guarantorRelationship { get; set;}
			public string guarantorName { get; set;}
			public string guarantorFirstName { get; set;}
			public string guarantorMiddleName { get; set;}
			public string guarantorLastName { get; set;}
			public string guarantorDob { get; set;}
			public string guarantorGender { get; set;}
			public string copayAmount { get; set;}
		}

		public class ExternalPatient {
			public string chartNumber { get; set;}
			public string internalId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string sex { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string countryCode { get; set;}
			public string zip5 { get; set;}
			public string dob { get; set;}
			public string emailAddress { get; set;}
			public string homePhone { get; set;}
			public string workPhone { get; set;}
			public string workExtension { get; set;}
			public string mobileNumber { get; set;}
			public string faxNumber { get; set;}
			public int reminderMethodId { get; set;}
			public bool active { get; set;}
			public string contactType { get; set;}
			public string defaultProvider { get; set;}
			public string maritalStatus { get; set;}
			public ExternalInsurance primaryInsurance { get; set;}
			public ExternalInsurance secondaryInsurance { get; set;}
			public string languagePref { get; set;}
		}

		public class PatientsSyncRequest : UpdoxRequest {
			public List<ExternalPatient> patients { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class PatientsSyncResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PatientsSync {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientsSync codeSample = new UpdoxCodeSample_PatientsSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientsSync";

		PatientsSyncRequest patientsSyncRequest = new PatientsSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientsSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		ExternalInsurance primaryInsurance = new ExternalInsurance();
		primaryInsurance.setCompanyName("companyName");
		primaryInsurance.setPhoneNumber("6148675309");
		primaryInsurance.setAddress1("address1");
		primaryInsurance.setAddress2("address2");
		primaryInsurance.setCity("Dublin");
		primaryInsurance.setState("OH");
		primaryInsurance.setZip("43017");
		primaryInsurance.setPolicyNumber("policyNumber");
		primaryInsurance.setGroupNumber("groupNumber");
		primaryInsurance.setPlanName("planName");
		primaryInsurance.setGroupName("groupName");
		primaryInsurance.setEffectiveDate("effectiveDate");
		primaryInsurance.setExpirationDate("expirationDate");
		primaryInsurance.setGuarantorRelationship("guarantorRelationship");
		primaryInsurance.setGuarantorName("guarantorName");
		primaryInsurance.setGuarantorFirstName("guarantorFirstName");
		primaryInsurance.setGuarantorMiddleName("guarantorMiddleName");
		primaryInsurance.setGuarantorLastName("guarantorLastName");
		primaryInsurance.setGuarantorDob("guarantorDob");
		primaryInsurance.setGuarantorGender("guarantorGender");
		primaryInsurance.setCopayAmount("copayAmount");
		ExternalInsurance secondaryInsurance = new ExternalInsurance();
		secondaryInsurance.setCompanyName("companyName");
		secondaryInsurance.setPhoneNumber("6148675309");
		secondaryInsurance.setAddress1("address1");
		secondaryInsurance.setAddress2("address2");
		secondaryInsurance.setCity("Dublin");
		secondaryInsurance.setState("OH");
		secondaryInsurance.setZip("43017");
		secondaryInsurance.setPolicyNumber("policyNumber");
		secondaryInsurance.setGroupNumber("groupNumber");
		secondaryInsurance.setPlanName("planName");
		secondaryInsurance.setGroupName("groupName");
		secondaryInsurance.setEffectiveDate("effectiveDate");
		secondaryInsurance.setExpirationDate("expirationDate");
		secondaryInsurance.setGuarantorRelationship("guarantorRelationship");
		secondaryInsurance.setGuarantorName("guarantorName");
		secondaryInsurance.setGuarantorFirstName("guarantorFirstName");
		secondaryInsurance.setGuarantorMiddleName("guarantorMiddleName");
		secondaryInsurance.setGuarantorLastName("guarantorLastName");
		secondaryInsurance.setGuarantorDob("guarantorDob");
		secondaryInsurance.setGuarantorGender("guarantorGender");
		secondaryInsurance.setCopayAmount("copayAmount");
	List<ExternalPatient> patients = new ArrayList<>();
		ExternalPatient externalPatient = new ExternalPatient();
		externalPatient.setChartNumber("chartNumber");
		externalPatient.setInternalId("internalId");
		externalPatient.setFirstName("firstName");
		externalPatient.setMiddleName("middleName");
		externalPatient.setLastName("lastName");
		externalPatient.setSex("M");
		externalPatient.setAddress1("address1");
		externalPatient.setAddress2("address2");
		externalPatient.setCity("Dublin");
		externalPatient.setState("OH");
		externalPatient.setCountryCode("countryCode");
		externalPatient.setZip5("43017");
		externalPatient.setDob("dob");
		externalPatient.setEmailAddress("test@test.com");
		externalPatient.setHomePhone("6148675309");
		externalPatient.setWorkPhone("6148675309");
		externalPatient.setWorkExtension("workExtension");
		externalPatient.setMobileNumber("mobileNumber");
		externalPatient.setFaxNumber("faxNumber");
		externalPatient.setReminderMethodId(1);
		externalPatient.setActive(true);
		externalPatient.setContactType("contactType");
		externalPatient.setDefaultProvider("defaultProvider");
		externalPatient.setMaritalStatus("M");
		externalPatient.setPrimaryInsurance(primaryInsurance);
		externalPatient.setSecondaryInsurance(secondaryInsurance);
		externalPatient.setLanguagePref("languagePref");
		patients.add(externalPatient);
		patientsSyncRequest.setPatients(patients);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientsSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientsSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientsSyncResponse patientsSyncResponse = mapper.readValue(jsonResponse, PatientsSyncResponse.class);

		System.out.println(patientsSyncResponse.getResponseCode());
		System.out.println(patientsSyncResponse.getResponseMessage());
	}

	private static class ExternalInsurance {
		private String companyName;
		private String phoneNumber;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String zip;
		private String policyNumber;
		private String groupNumber;
		private String planName;
		private String groupName;
		private String effectiveDate;
		private String expirationDate;
		private String guarantorRelationship;
		private String guarantorName;
		private String guarantorFirstName;
		private String guarantorMiddleName;
		private String guarantorLastName;
		private String guarantorDob;
		private String guarantorGender;
		private String copayAmount;


		public String getCompanyName() {
			return companyName;
		}

		public void setCompanyName(String companyName) {
			this.companyName = companyName;
		}

		public String getPhoneNumber() {
			return phoneNumber;
		}

		public void setPhoneNumber(String phoneNumber) {
			this.phoneNumber = phoneNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getPolicyNumber() {
			return policyNumber;
		}

		public void setPolicyNumber(String policyNumber) {
			this.policyNumber = policyNumber;
		}

		public String getGroupNumber() {
			return groupNumber;
		}

		public void setGroupNumber(String groupNumber) {
			this.groupNumber = groupNumber;
		}

		public String getPlanName() {
			return planName;
		}

		public void setPlanName(String planName) {
			this.planName = planName;
		}

		public String getGroupName() {
			return groupName;
		}

		public void setGroupName(String groupName) {
			this.groupName = groupName;
		}

		public String getEffectiveDate() {
			return effectiveDate;
		}

		public void setEffectiveDate(String effectiveDate) {
			this.effectiveDate = effectiveDate;
		}

		public String getExpirationDate() {
			return expirationDate;
		}

		public void setExpirationDate(String expirationDate) {
			this.expirationDate = expirationDate;
		}

		public String getGuarantorRelationship() {
			return guarantorRelationship;
		}

		public void setGuarantorRelationship(String guarantorRelationship) {
			this.guarantorRelationship = guarantorRelationship;
		}

		public String getGuarantorName() {
			return guarantorName;
		}

		public void setGuarantorName(String guarantorName) {
			this.guarantorName = guarantorName;
		}

		public String getGuarantorFirstName() {
			return guarantorFirstName;
		}

		public void setGuarantorFirstName(String guarantorFirstName) {
			this.guarantorFirstName = guarantorFirstName;
		}

		public String getGuarantorMiddleName() {
			return guarantorMiddleName;
		}

		public void setGuarantorMiddleName(String guarantorMiddleName) {
			this.guarantorMiddleName = guarantorMiddleName;
		}

		public String getGuarantorLastName() {
			return guarantorLastName;
		}

		public void setGuarantorLastName(String guarantorLastName) {
			this.guarantorLastName = guarantorLastName;
		}

		public String getGuarantorDob() {
			return guarantorDob;
		}

		public void setGuarantorDob(String guarantorDob) {
			this.guarantorDob = guarantorDob;
		}

		public String getGuarantorGender() {
			return guarantorGender;
		}

		public void setGuarantorGender(String guarantorGender) {
			this.guarantorGender = guarantorGender;
		}

		public String getCopayAmount() {
			return copayAmount;
		}

		public void setCopayAmount(String copayAmount) {
			this.copayAmount = copayAmount;
		}
	}

	private static class ExternalPatient {
		private String chartNumber;
		private String internalId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String sex;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String countryCode;
		private String zip5;
		private String dob;
		private String emailAddress;
		private String homePhone;
		private String workPhone;
		private String workExtension;
		private String mobileNumber;
		private String faxNumber;
		private int reminderMethodId;
		private boolean active;
		private String contactType;
		private String defaultProvider;
		private String maritalStatus;
		private ExternalInsurance primaryInsurance;
		private ExternalInsurance secondaryInsurance;
		private String languagePref;


		public String getChartNumber() {
			return chartNumber;
		}

		public void setChartNumber(String chartNumber) {
			this.chartNumber = chartNumber;
		}

		public String getInternalId() {
			return internalId;
		}

		public void setInternalId(String internalId) {
			this.internalId = internalId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getSex() {
			return sex;
		}

		public void setSex(String sex) {
			this.sex = sex;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getZip5() {
			return zip5;
		}

		public void setZip5(String zip5) {
			this.zip5 = zip5;
		}

		public String getDob() {
			return dob;
		}

		public void setDob(String dob) {
			this.dob = dob;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExtension() {
			return workExtension;
		}

		public void setWorkExtension(String workExtension) {
			this.workExtension = workExtension;
		}

		public String getMobileNumber() {
			return mobileNumber;
		}

		public void setMobileNumber(String mobileNumber) {
			this.mobileNumber = mobileNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getDefaultProvider() {
			return defaultProvider;
		}

		public void setDefaultProvider(String defaultProvider) {
			this.defaultProvider = defaultProvider;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public ExternalInsurance getPrimaryInsurance() {
			return primaryInsurance;
		}

		public void setPrimaryInsurance(ExternalInsurance primaryInsurance) {
			this.primaryInsurance = primaryInsurance;
		}

		public ExternalInsurance getSecondaryInsurance() {
			return secondaryInsurance;
		}

		public void setSecondaryInsurance(ExternalInsurance secondaryInsurance) {
			this.secondaryInsurance = secondaryInsurance;
		}

		public String getLanguagePref() {
			return languagePref;
		}

		public void setLanguagePref(String languagePref) {
			this.languagePref = languagePref;
		}
	}

	private class PatientsSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalPatient> patients;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalPatient> getPatients() {
			return patients;
		}

		public void setPatients(List<ExternalPatient> patients) {
			this.patients = patients;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class PatientsSyncResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PatientsSync/1.1 /io/PatientsSync/1.1

Creates or modifies one or more patients. This API call should only be used for syncing patient data. /ContactsSync should be used to sync contacts.

Changes from v1.0 to v1.1:

location - A patient will be associated to a location based on the location code from the /LocationsSync.
suffix - Suffix will only accept values that match the Updox UI. Toggle the Suffix list in the Description column below to view the accepted values.
Removed the primaryInsurance and secondaryInsurance objects along with all of their nested fields.
Removed id - This was an Updox identifier.
Renamed internalId to patientId which is the id of the patient. This is required.
All address fields are now nested under the Address object.
Renamed zip5 to postal, which can now accept 5 or 9 digit "US" or "US Territory" codes as well as Canadian postal codes.
state must be a valid 2 character "US"/"US Territory" state or Canadian province that corresponds with the countryCode provided. Toggle the State Codes list in the Description column below to view the accepted values.
countryCode is now a required field if a postal code is entered and it must match the patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. Toggle the Country Code list in the Description column below to view the accepted values.
If an empty location or suffix is submitted, any previous value will be overridden.
An error will be returned for invalid location or suffix values.

Parameter	Type	Value	Description
patients	List	add remove

chartNumber	String		The chart number of the patient, 64 characters max if included.
patientId	String		The id of the patient. This is required.
firstName	String		The first name of the patient.
middleName	String		The middle name of the patient.
lastName	String		The last name of the patient.
suffix	String		The suffix of the patient. Suffixes: MD RN JR SR I II III IV V VI APN APNP APR APRN CNM CNP CPNP CRNA DC DDS DMD DNP DO DPM DPT DSN ESQ LCMT LCSW LMSW LP LPN LSW NP OD OT OTD PA PAC PharmD PhD PsyD PSYCH PT REV .
sex	String		The gender of the patient. Must be one of the following values: m, f, o, male, female, other, u, unknown.
address			Address information for the patient.
address1	String		The address of the patient.
address2	String		The extra address information of the patient.
city	String		The city of the patient.
state	String		The user's 2 character state/province code. The state/province code must be valid for the provided `country` field. If `country` is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon .
countryCode	String		The patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
postal	String		The account's valid postal code based on the country: If "US" or "US Territory" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code .
dob	String		The date of birth of the patient, expected format is 'yyyy-MM-dd'.
emailAddress	String		The email address of the patient.
homePhone	String		The home phone number of the patient.
workPhone	String		The work phone number of the patient.
workExtension	String		The extension of the work phone number of the patient.
mobileNumber	String		The cell phone number of the patient.
faxNumber	String		The fax phone number of the patient.
reminderMethodId	Int		The reminder communication preference of the patient. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0.
active	Boolean		If patient is active, expect boolean value.
contactType	String		Expected value is 'patient'. If left blank, contactType will default to 'patient'.
defaultProvider	String		The default provider of the patient.
maritalStatus	String		The marital status of the patient, expected values are 'single', 'married', 'divorced', 'widowed', 'other'.
languagePref	String		The language preference of the patient. Must be one of the following values: English, Spanish.
defaultLocationId	String		Location of the patient.

Try it! Toggle Notes/Code Samples

PatientsSync/1.1

Creates or modifies one or more patients. This API call should only be used for syncing patient data. /ContactsSync should be used to sync contacts.

Changes from v1.0 to v1.1:

location - A patient will be associated to a location based on the location code from the /LocationsSync.
suffix - Suffix will only accept values that match the Updox UI. Toggle the Suffix list in the Description column below to view the accepted values.
Removed the primaryInsurance and secondaryInsurance objects along with all of their nested fields.
Removed id - This was an Updox identifier.
Renamed internalId to patientId which is the id of the patient. This is required.
All address fields are now nested under the Address object.
Renamed zip5 to postal, which can now accept 5 or 9 digit "US" or "US Territory" codes as well as Canadian postal codes.
state must be a valid 2 character "US"/"US Territory" state or Canadian province that corresponds with the countryCode provided. Toggle the State Codes list in the Description column below to view the accepted values.
countryCode is now a required field if a postal code is entered and it must match the patient's 2 digit country code from ISO 3166 Country Codes Alpha-2. Toggle the Country Code list in the Description column below to view the accepted values.
If an empty location or suffix is submitted, any previous value will be overridden.
An error will be returned for invalid location or suffix values.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientsSync1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientsSync1_1 codeSample = new UpdoxCodeSample_PatientsSync1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientsSync1_1";
			PatientsSync1_1Request patientsSync1_1Request = new PatientsSync1_1Request();

			//set up credentials
			patientsSync1_1Request.auth.applicationId = "applicationId";
			patientsSync1_1Request.auth.applicationPassword = "applicationPassword";
			patientsSync1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			Address address = new Address();
			address.address1 = "address1";
			address.address2 = "address2";
			address.city = "Dublin";
			address.state = "OH";
			address.countryCode = "countryCode";
			address.postal = "postal";
			List<ExternalPatient1_1> patients = new List<ExternalPatient1_1>();
			ExternalPatient1_1 externalPatient1_1 = new ExternalPatient1_1();
			externalPatient1_1.chartNumber = "chartNumber";
			externalPatient1_1.patientId = "patientId";
			externalPatient1_1.firstName = "firstName";
			externalPatient1_1.middleName = "middleName";
			externalPatient1_1.lastName = "lastName";
			externalPatient1_1.suffix = "suffix";
			externalPatient1_1.sex = "M";
			externalPatient1_1.address = address;
			externalPatient1_1.dob = "dob";
			externalPatient1_1.emailAddress = "test@test.com";
			externalPatient1_1.homePhone = "6148675309";
			externalPatient1_1.workPhone = "6148675309";
			externalPatient1_1.workExtension = "workExtension";
			externalPatient1_1.mobileNumber = "mobileNumber";
			externalPatient1_1.faxNumber = "faxNumber";
			externalPatient1_1.reminderMethodId = 1;
			externalPatient1_1.active = true;
			externalPatient1_1.contactType = "contactType";
			externalPatient1_1.defaultProvider = "defaultProvider";
			externalPatient1_1.maritalStatus = "M";
			externalPatient1_1.languagePref = "languagePref";
			externalPatient1_1.defaultLocationId = "defaultLocationId";
			patients.Add(externalPatient1_1);
			patientsSync1_1Request.patients = patients;

			//create the request
			string json = Utilities.buildRequestJson(patientsSync1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientsSync/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientsSync1_1Response patientsSync1_1Response = javascriptSerializer.Deserialize<PatientsSync1_1Response>(jsonResponse);

			Console.WriteLine(patientsSync1_1Response.responseCode);
			Console.WriteLine(patientsSync1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class Address {
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string countryCode { get; set;}
			public string postal { get; set;}
		}

		public class ExternalPatient1_1 {
			public string chartNumber { get; set;}
			public string patientId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string suffix { get; set;}
			public string sex { get; set;}
			public Address address { get; set;}
			public string dob { get; set;}
			public string emailAddress { get; set;}
			public string homePhone { get; set;}
			public string workPhone { get; set;}
			public string workExtension { get; set;}
			public string mobileNumber { get; set;}
			public string faxNumber { get; set;}
			public int reminderMethodId { get; set;}
			public bool active { get; set;}
			public string contactType { get; set;}
			public string defaultProvider { get; set;}
			public string maritalStatus { get; set;}
			public string languagePref { get; set;}
			public string defaultLocationId { get; set;}
		}

		public class PatientsSync1_1Request : UpdoxRequest {
			public List<ExternalPatient1_1> patients { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class PatientsSync1_1Response : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PatientsSync1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientsSync1_1 codeSample = new UpdoxCodeSample_PatientsSync1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientsSync1_1";

		PatientsSync1_1Request patientsSync1_1Request = new PatientsSync1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientsSync1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		Address address = new Address();
		address.setAddress1("address1");
		address.setAddress2("address2");
		address.setCity("Dublin");
		address.setState("OH");
		address.setCountryCode("countryCode");
		address.setPostal("postal");
	List<ExternalPatient1_1> patients = new ArrayList<>();
		ExternalPatient1_1 externalPatient1_1 = new ExternalPatient1_1();
		externalPatient1_1.setChartNumber("chartNumber");
		externalPatient1_1.setPatientId("patientId");
		externalPatient1_1.setFirstName("firstName");
		externalPatient1_1.setMiddleName("middleName");
		externalPatient1_1.setLastName("lastName");
		externalPatient1_1.setSuffix("suffix");
		externalPatient1_1.setSex("M");
		externalPatient1_1.setAddress(address);
		externalPatient1_1.setDob("dob");
		externalPatient1_1.setEmailAddress("test@test.com");
		externalPatient1_1.setHomePhone("6148675309");
		externalPatient1_1.setWorkPhone("6148675309");
		externalPatient1_1.setWorkExtension("workExtension");
		externalPatient1_1.setMobileNumber("mobileNumber");
		externalPatient1_1.setFaxNumber("faxNumber");
		externalPatient1_1.setReminderMethodId(1);
		externalPatient1_1.setActive(true);
		externalPatient1_1.setContactType("contactType");
		externalPatient1_1.setDefaultProvider("defaultProvider");
		externalPatient1_1.setMaritalStatus("M");
		externalPatient1_1.setLanguagePref("languagePref");
		externalPatient1_1.setDefaultLocationId("defaultLocationId");
		patients.add(externalPatient1_1);
		patientsSync1_1Request.setPatients(patients);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientsSync1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientsSync/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientsSync1_1Response patientsSync1_1Response = mapper.readValue(jsonResponse, PatientsSync1_1Response.class);

		System.out.println(patientsSync1_1Response.getResponseCode());
		System.out.println(patientsSync1_1Response.getResponseMessage());
	}

	private static class Address {
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String countryCode;
		private String postal;


		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}
	}

	private static class ExternalPatient1_1 {
		private String chartNumber;
		private String patientId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String suffix;
		private String sex;
		private Address address;
		private String dob;
		private String emailAddress;
		private String homePhone;
		private String workPhone;
		private String workExtension;
		private String mobileNumber;
		private String faxNumber;
		private int reminderMethodId;
		private boolean active;
		private String contactType;
		private String defaultProvider;
		private String maritalStatus;
		private String languagePref;
		private String defaultLocationId;


		public String getChartNumber() {
			return chartNumber;
		}

		public void setChartNumber(String chartNumber) {
			this.chartNumber = chartNumber;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getSex() {
			return sex;
		}

		public void setSex(String sex) {
			this.sex = sex;
		}

		public Address getAddress() {
			return address;
		}

		public void setAddress(Address address) {
			this.address = address;
		}

		public String getDob() {
			return dob;
		}

		public void setDob(String dob) {
			this.dob = dob;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getHomePhone() {
			return homePhone;
		}

		public void setHomePhone(String homePhone) {
			this.homePhone = homePhone;
		}

		public String getWorkPhone() {
			return workPhone;
		}

		public void setWorkPhone(String workPhone) {
			this.workPhone = workPhone;
		}

		public String getWorkExtension() {
			return workExtension;
		}

		public void setWorkExtension(String workExtension) {
			this.workExtension = workExtension;
		}

		public String getMobileNumber() {
			return mobileNumber;
		}

		public void setMobileNumber(String mobileNumber) {
			this.mobileNumber = mobileNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getContactType() {
			return contactType;
		}

		public void setContactType(String contactType) {
			this.contactType = contactType;
		}

		public String getDefaultProvider() {
			return defaultProvider;
		}

		public void setDefaultProvider(String defaultProvider) {
			this.defaultProvider = defaultProvider;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getLanguagePref() {
			return languagePref;
		}

		public void setLanguagePref(String languagePref) {
			this.languagePref = languagePref;
		}

		public String getDefaultLocationId() {
			return defaultLocationId;
		}

		public void setDefaultLocationId(String defaultLocationId) {
			this.defaultLocationId = defaultLocationId;
		}
	}

	private class PatientsSync1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalPatient1_1> patients;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalPatient1_1> getPatients() {
			return patients;
		}

		public void setPatients(List<ExternalPatient1_1> patients) {
			this.patients = patients;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class PatientsSync1_1Response extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeCalendarsRetrieve /io/PracticeCalendarsRetrieve

Returns a list of the current practice calendars.

Parameter	Type	Value	Description
activeOnly	Boolean

Try it! Toggle Notes/Code Samples

PracticeCalendarsRetrieve

Returns a list of the current practice calendars.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeCalendarsRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeCalendarsRetrieve codeSample = new UpdoxCodeSample_PracticeCalendarsRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeCalendarsRetrieve";
			PracticeCalendarsRetrieveRequest practiceCalendarsRetrieveRequest = new PracticeCalendarsRetrieveRequest();

			//set up credentials
			practiceCalendarsRetrieveRequest.auth.applicationId = "applicationId";
			practiceCalendarsRetrieveRequest.auth.applicationPassword = "applicationPassword";
			practiceCalendarsRetrieveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			practiceCalendarsRetrieveRequest.activeOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(practiceCalendarsRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeCalendarsRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeCalendarsRetrieveResponse practiceCalendarsRetrieveResponse = javascriptSerializer.Deserialize<PracticeCalendarsRetrieveResponse>(jsonResponse);

			Console.WriteLine(practiceCalendarsRetrieveResponse.responseCode);
			Console.WriteLine(practiceCalendarsRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeCalendarsRetrieveRequest : UpdoxRequest {
			public bool activeOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MemberSchedule {
			public long serialVersionUID { get; set;}
			public long id { get; set;}
			public string externalId { get; set;}
			public long vcWaitingRoomId { get; set;}
			public string title { get; set;}
			public long pid { get; set;}
			public string color { get; set;}
			public string textColor { get; set;}
			public bool publick { get; set;}
			public string rules { get; set;}
			public bool active { get; set;}
			public bool reminderTurnOff { get; set;}
			public string blackouts { get; set;}
		}

		public class PracticeCalendarsRetrieveResponse : UpdoxResponse {
			public List<MemberSchedule> calendars { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeCalendarsRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeCalendarsRetrieve codeSample = new UpdoxCodeSample_PracticeCalendarsRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeCalendarsRetrieve";

		PracticeCalendarsRetrieveRequest practiceCalendarsRetrieveRequest = new PracticeCalendarsRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceCalendarsRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		practiceCalendarsRetrieveRequest.setActiveOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceCalendarsRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeCalendarsRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeCalendarsRetrieveResponse practiceCalendarsRetrieveResponse = mapper.readValue(jsonResponse, PracticeCalendarsRetrieveResponse.class);

		System.out.println(practiceCalendarsRetrieveResponse.getResponseCode());
		System.out.println(practiceCalendarsRetrieveResponse.getResponseMessage());
	}

	private class PracticeCalendarsRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private boolean activeOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public boolean isActiveOnly() {
			return activeOnly;
		}

		public void setActiveOnly(boolean activeOnly) {
			this.activeOnly = activeOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class MemberSchedule {
		private long serialVersionUID;
		private long id;
		private String externalId;
		private Long vcWaitingRoomId;
		private String title;
		private long pid;
		private String color;
		private String textColor;
		private boolean publick;
		private String rules;
		private boolean active;
		private boolean reminderTurnOff;
		private String blackouts;


		public long getSerialVersionUID() {
			return serialVersionUID;
		}

		public void setSerialVersionUID(long serialVersionUID) {
			this.serialVersionUID = serialVersionUID;
		}

		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public Long getVcWaitingRoomId() {
			return vcWaitingRoomId;
		}

		public void setVcWaitingRoomId(Long vcWaitingRoomId) {
			this.vcWaitingRoomId = vcWaitingRoomId;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public long getPid() {
			return pid;
		}

		public void setPid(long pid) {
			this.pid = pid;
		}

		public String getColor() {
			return color;
		}

		public void setColor(String color) {
			this.color = color;
		}

		public String getTextColor() {
			return textColor;
		}

		public void setTextColor(String textColor) {
			this.textColor = textColor;
		}

		public boolean isPublick() {
			return publick;
		}

		public void setPublick(boolean publick) {
			this.publick = publick;
		}

		public String getRules() {
			return rules;
		}

		public void setRules(String rules) {
			this.rules = rules;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}

		public String getBlackouts() {
			return blackouts;
		}

		public void setBlackouts(String blackouts) {
			this.blackouts = blackouts;
		}
	}

	private static class PracticeCalendarsRetrieveResponse extends UpdoxResponse {
		private List<MemberSchedule> calendars;


		public List<MemberSchedule> getCalendars() {
			return calendars;
		}

		public void setCalendars(List<MemberSchedule> calendars) {
			this.calendars = calendars;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeKeyGet /io/PracticeKeyGet

Generates and returns a base64 encoded encryption key and associates with requesting account identifier

Try it! Toggle Notes/Code Samples

PracticeKeyGet

Generates and returns a base64 encoded encryption key and associates with requesting account identifier

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeKeyGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeKeyGet codeSample = new UpdoxCodeSample_PracticeKeyGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeKeyGet";
			PracticeKeyGetRequest practiceKeyGetRequest = new PracticeKeyGetRequest();

			//set up credentials
			practiceKeyGetRequest.auth.applicationId = "applicationId";
			practiceKeyGetRequest.auth.applicationPassword = "applicationPassword";
			practiceKeyGetRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceKeyGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeKeyGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeKeyGetResponse practiceKeyGetResponse = javascriptSerializer.Deserialize<PracticeKeyGetResponse>(jsonResponse);

			Console.WriteLine(practiceKeyGetResponse.responseCode);
			Console.WriteLine(practiceKeyGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeKeyGetRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeKeyGetResponse : UpdoxResponse {
			public string key { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeKeyGet {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeKeyGet codeSample = new UpdoxCodeSample_PracticeKeyGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeKeyGet";

		PracticeKeyGetRequest practiceKeyGetRequest = new PracticeKeyGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceKeyGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceKeyGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeKeyGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeKeyGetResponse practiceKeyGetResponse = mapper.readValue(jsonResponse, PracticeKeyGetResponse.class);

		System.out.println(practiceKeyGetResponse.getResponseCode());
		System.out.println(practiceKeyGetResponse.getResponseMessage());
	}

	private class PracticeKeyGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PracticeKeyGetResponse extends UpdoxResponse {
		private String key;


		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeKeySave /io/PracticeKeySave

Save an api key for a practice for communicating with partner apis

Parameter	Type	Value	Description
apiKey	String		Api key value. This is required.

Try it! Toggle Notes/Code Samples

PracticeKeySave

Save an api key for a practice for communicating with partner apis

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeKeySave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeKeySave codeSample = new UpdoxCodeSample_PracticeKeySave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeKeySave";
			PracticeKeySaveRequest practiceKeySaveRequest = new PracticeKeySaveRequest();

			//set up credentials
			practiceKeySaveRequest.auth.applicationId = "applicationId";
			practiceKeySaveRequest.auth.applicationPassword = "applicationPassword";
			practiceKeySaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			practiceKeySaveRequest.apiKey = "apiKey";

			//create the request
			string json = Utilities.buildRequestJson(practiceKeySaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeKeySave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeKeySaveResponse practiceKeySaveResponse = javascriptSerializer.Deserialize<PracticeKeySaveResponse>(jsonResponse);

			Console.WriteLine(practiceKeySaveResponse.responseCode);
			Console.WriteLine(practiceKeySaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeKeySaveRequest : UpdoxRequest {
			public string apiKey { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PracticeKeySaveResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeKeySave {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeKeySave codeSample = new UpdoxCodeSample_PracticeKeySave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeKeySave";

		PracticeKeySaveRequest practiceKeySaveRequest = new PracticeKeySaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceKeySaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		practiceKeySaveRequest.setApiKey("apiKey");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceKeySaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeKeySave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeKeySaveResponse practiceKeySaveResponse = mapper.readValue(jsonResponse, PracticeKeySaveResponse.class);

		System.out.println(practiceKeySaveResponse.getResponseCode());
		System.out.println(practiceKeySaveResponse.getResponseMessage());
	}

	private class PracticeKeySaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String apiKey;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getApiKey() {
			return apiKey;
		}

		public void setApiKey(String apiKey) {
			this.apiKey = apiKey;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PracticeKeySaveResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeLocationsRetrieve /io/PracticeLocationsRetrieve

Returns a list of the current practice locations.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
activeOnly	Boolean

Try it! Toggle Notes/Code Samples

PracticeLocationsRetrieve

Returns a list of the current practice locations.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeLocationsRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeLocationsRetrieve codeSample = new UpdoxCodeSample_PracticeLocationsRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeLocationsRetrieve";
			PracticeLocationsRetrieveRequest practiceLocationsRetrieveRequest = new PracticeLocationsRetrieveRequest();

			//set up credentials
			practiceLocationsRetrieveRequest.auth.applicationId = "applicationId";
			practiceLocationsRetrieveRequest.auth.applicationPassword = "applicationPassword";
			practiceLocationsRetrieveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			practiceLocationsRetrieveRequest.activeOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(practiceLocationsRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeLocationsRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeLocationsRetrieveResponse practiceLocationsRetrieveResponse = javascriptSerializer.Deserialize<PracticeLocationsRetrieveResponse>(jsonResponse);

			Console.WriteLine(practiceLocationsRetrieveResponse.responseCode);
			Console.WriteLine(practiceLocationsRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeLocationsRetrieveRequest : UpdoxRequest {
			public bool activeOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeLocationWithZip {
			public long dEFAULT_PRACTICE_LOCATION_ID { get; set;}
			public long id { get; set;}
			public long pid { get; set;}
			public string code { get; set;}
			public string name { get; set;}
			public string externalId { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string country { get; set;}
			public string dayphone { get; set;}
			public string evephone { get; set;}
			public string faxphone { get; set;}
			public string apptphone { get; set;}
			public string emailAddress { get; set;}
			public string about { get; set;}
			public string hours { get; set;}
			public string showHide { get; set;}
			public bool showInPortal { get; set;}
			public bool active { get; set;}
			public long sortOrder { get; set;}
			public string url { get; set;}
			public bool reminderTurnOff { get; set;}
			public string zip { get; set;}
		}

		public class PracticeLocationsRetrieveResponse : UpdoxResponse {
			public List<PracticeLocationWithZip> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeLocationsRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeLocationsRetrieve codeSample = new UpdoxCodeSample_PracticeLocationsRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeLocationsRetrieve";

		PracticeLocationsRetrieveRequest practiceLocationsRetrieveRequest = new PracticeLocationsRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceLocationsRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		practiceLocationsRetrieveRequest.setActiveOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceLocationsRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeLocationsRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeLocationsRetrieveResponse practiceLocationsRetrieveResponse = mapper.readValue(jsonResponse, PracticeLocationsRetrieveResponse.class);

		System.out.println(practiceLocationsRetrieveResponse.getResponseCode());
		System.out.println(practiceLocationsRetrieveResponse.getResponseMessage());
	}

	private class PracticeLocationsRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private boolean activeOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public boolean isActiveOnly() {
			return activeOnly;
		}

		public void setActiveOnly(boolean activeOnly) {
			this.activeOnly = activeOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PracticeLocationWithZip {
		private long dEFAULT_PRACTICE_LOCATION_ID;
		private long id;
		private long pid;
		private String code;
		private String name;
		private String externalId;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String country;
		private String dayphone;
		private String evephone;
		private String faxphone;
		private String apptphone;
		private String emailAddress;
		private String about;
		private String hours;
		private String showHide;
		private boolean showInPortal;
		private boolean active;
		private long sortOrder;
		private String url;
		private boolean reminderTurnOff;
		private String zip;


		public long getDEFAULT_PRACTICE_LOCATION_ID() {
			return dEFAULT_PRACTICE_LOCATION_ID;
		}

		public void setDEFAULT_PRACTICE_LOCATION_ID(long dEFAULT_PRACTICE_LOCATION_ID) {
			this.dEFAULT_PRACTICE_LOCATION_ID = dEFAULT_PRACTICE_LOCATION_ID;
		}

		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public long getPid() {
			return pid;
		}

		public void setPid(long pid) {
			this.pid = pid;
		}

		public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getDayphone() {
			return dayphone;
		}

		public void setDayphone(String dayphone) {
			this.dayphone = dayphone;
		}

		public String getEvephone() {
			return evephone;
		}

		public void setEvephone(String evephone) {
			this.evephone = evephone;
		}

		public String getFaxphone() {
			return faxphone;
		}

		public void setFaxphone(String faxphone) {
			this.faxphone = faxphone;
		}

		public String getApptphone() {
			return apptphone;
		}

		public void setApptphone(String apptphone) {
			this.apptphone = apptphone;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getAbout() {
			return about;
		}

		public void setAbout(String about) {
			this.about = about;
		}

		public String getHours() {
			return hours;
		}

		public void setHours(String hours) {
			this.hours = hours;
		}

		public String getShowHide() {
			return showHide;
		}

		public void setShowHide(String showHide) {
			this.showHide = showHide;
		}

		public boolean isShowInPortal() {
			return showInPortal;
		}

		public void setShowInPortal(boolean showInPortal) {
			this.showInPortal = showInPortal;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public long getSortOrder() {
			return sortOrder;
		}

		public void setSortOrder(long sortOrder) {
			this.sortOrder = sortOrder;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class PracticeLocationsRetrieveResponse extends UpdoxResponse {
		private List<PracticeLocationWithZip> locations;


		public List<PracticeLocationWithZip> getLocations() {
			return locations;
		}

		public void setLocations(List<PracticeLocationWithZip> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeLocationsRetrieve/1.1 /io/PracticeLocationsRetrieve/1.1

Returns a list of the current practice locations.

Changes from v1.0 to v1.1:

zip - renamed to postalCode for better international address support

Parameter	Type	Value	Description
activeOnly	Boolean

Try it! Toggle Notes/Code Samples

PracticeLocationsRetrieve/1.1

Returns a list of the current practice locations.

Changes from v1.0 to v1.1:

zip - renamed to postalCode for better international address support

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeLocationsRetrieve1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeLocationsRetrieve1_1 codeSample = new UpdoxCodeSample_PracticeLocationsRetrieve1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeLocationsRetrieve1_1";
			PracticeLocationsRetrieve1_1Request practiceLocationsRetrieve1_1Request = new PracticeLocationsRetrieve1_1Request();

			//set up credentials
			practiceLocationsRetrieve1_1Request.auth.applicationId = "applicationId";
			practiceLocationsRetrieve1_1Request.auth.applicationPassword = "applicationPassword";
			practiceLocationsRetrieve1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			practiceLocationsRetrieve1_1Request.activeOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(practiceLocationsRetrieve1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeLocationsRetrieve/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeLocationsRetrieve1_1Response practiceLocationsRetrieve1_1Response = javascriptSerializer.Deserialize<PracticeLocationsRetrieve1_1Response>(jsonResponse);

			Console.WriteLine(practiceLocationsRetrieve1_1Response.responseCode);
			Console.WriteLine(practiceLocationsRetrieve1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeLocationsRetrieve1_1Request : UpdoxRequest {
			public bool activeOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeLocationWithPostalCode {
			public long dEFAULT_PRACTICE_LOCATION_ID { get; set;}
			public long id { get; set;}
			public long pid { get; set;}
			public string code { get; set;}
			public string name { get; set;}
			public string externalId { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string country { get; set;}
			public string dayphone { get; set;}
			public string evephone { get; set;}
			public string faxphone { get; set;}
			public string apptphone { get; set;}
			public string emailAddress { get; set;}
			public string about { get; set;}
			public string hours { get; set;}
			public string showHide { get; set;}
			public bool showInPortal { get; set;}
			public bool active { get; set;}
			public long sortOrder { get; set;}
			public string url { get; set;}
			public bool reminderTurnOff { get; set;}
			public string postalCode { get; set;}
		}

		public class PracticeLocationsRetrieve1_1Response : UpdoxResponse {
			public List<PracticeLocationWithPostalCode> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeLocationsRetrieve1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeLocationsRetrieve1_1 codeSample = new UpdoxCodeSample_PracticeLocationsRetrieve1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeLocationsRetrieve1_1";

		PracticeLocationsRetrieve1_1Request practiceLocationsRetrieve1_1Request = new PracticeLocationsRetrieve1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceLocationsRetrieve1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		practiceLocationsRetrieve1_1Request.setActiveOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceLocationsRetrieve1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeLocationsRetrieve/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeLocationsRetrieve1_1Response practiceLocationsRetrieve1_1Response = mapper.readValue(jsonResponse, PracticeLocationsRetrieve1_1Response.class);

		System.out.println(practiceLocationsRetrieve1_1Response.getResponseCode());
		System.out.println(practiceLocationsRetrieve1_1Response.getResponseMessage());
	}

	private class PracticeLocationsRetrieve1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private boolean activeOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public boolean isActiveOnly() {
			return activeOnly;
		}

		public void setActiveOnly(boolean activeOnly) {
			this.activeOnly = activeOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PracticeLocationWithPostalCode {
		private long dEFAULT_PRACTICE_LOCATION_ID;
		private long id;
		private long pid;
		private String code;
		private String name;
		private String externalId;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String country;
		private String dayphone;
		private String evephone;
		private String faxphone;
		private String apptphone;
		private String emailAddress;
		private String about;
		private String hours;
		private String showHide;
		private boolean showInPortal;
		private boolean active;
		private long sortOrder;
		private String url;
		private boolean reminderTurnOff;
		private String postalCode;


		public long getDEFAULT_PRACTICE_LOCATION_ID() {
			return dEFAULT_PRACTICE_LOCATION_ID;
		}

		public void setDEFAULT_PRACTICE_LOCATION_ID(long dEFAULT_PRACTICE_LOCATION_ID) {
			this.dEFAULT_PRACTICE_LOCATION_ID = dEFAULT_PRACTICE_LOCATION_ID;
		}

		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public long getPid() {
			return pid;
		}

		public void setPid(long pid) {
			this.pid = pid;
		}

		public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getExternalId() {
			return externalId;
		}

		public void setExternalId(String externalId) {
			this.externalId = externalId;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getDayphone() {
			return dayphone;
		}

		public void setDayphone(String dayphone) {
			this.dayphone = dayphone;
		}

		public String getEvephone() {
			return evephone;
		}

		public void setEvephone(String evephone) {
			this.evephone = evephone;
		}

		public String getFaxphone() {
			return faxphone;
		}

		public void setFaxphone(String faxphone) {
			this.faxphone = faxphone;
		}

		public String getApptphone() {
			return apptphone;
		}

		public void setApptphone(String apptphone) {
			this.apptphone = apptphone;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public String getAbout() {
			return about;
		}

		public void setAbout(String about) {
			this.about = about;
		}

		public String getHours() {
			return hours;
		}

		public void setHours(String hours) {
			this.hours = hours;
		}

		public String getShowHide() {
			return showHide;
		}

		public void setShowHide(String showHide) {
			this.showHide = showHide;
		}

		public boolean isShowInPortal() {
			return showInPortal;
		}

		public void setShowInPortal(boolean showInPortal) {
			this.showInPortal = showInPortal;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public long getSortOrder() {
			return sortOrder;
		}

		public void setSortOrder(long sortOrder) {
			this.sortOrder = sortOrder;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public boolean isReminderTurnOff() {
			return reminderTurnOff;
		}

		public void setReminderTurnOff(boolean reminderTurnOff) {
			this.reminderTurnOff = reminderTurnOff;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}
	}

	private static class PracticeLocationsRetrieve1_1Response extends UpdoxResponse {
		private List<PracticeLocationWithPostalCode> locations;


		public List<PracticeLocationWithPostalCode> getLocations() {
			return locations;
		}

		public void setLocations(List<PracticeLocationWithPostalCode> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

QueueDequeue /io/QueueDequeue

Retrieves the next queued message of the specified type, optionally marking the previously retrieved message complete

Parameter	Type	Value	Description
lastHandledMessageId	String		The messageId of the last message that was successfully dequeued. This message will be archived and not retrieved again.
messageType	String		The type(s) of messages to dequeue. Valid values are: `ANY, DIRECT, FAX, PORTAL, PRINT_QUEUED`.

Try it! Toggle Notes/Code Samples

QueueDequeue

Retrieves the next queued message of the specified type, optionally marking the previously retrieved message complete

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_QueueDequeue {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_QueueDequeue codeSample = new UpdoxCodeSample_QueueDequeue();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "QueueDequeue";
			QueueDequeueRequest queueDequeueRequest = new QueueDequeueRequest();

			//set up credentials
			queueDequeueRequest.auth.applicationId = "applicationId";
			queueDequeueRequest.auth.applicationPassword = "applicationPassword";
			queueDequeueRequest.auth.accountId = "accountId";

			//set up request specific parameters
			queueDequeueRequest.lastHandledMessageId = "lastHandledMessageId";
			queueDequeueRequest.messageType = "messageType";

			//create the request
			string json = Utilities.buildRequestJson(queueDequeueRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "QueueDequeue", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			QueueDequeueResponse queueDequeueResponse = javascriptSerializer.Deserialize<QueueDequeueResponse>(jsonResponse);

			Console.WriteLine(queueDequeueResponse.responseCode);
			Console.WriteLine(queueDequeueResponse.responseMessage);

			Environment.Exit (0);
		}


		public class QueueDequeueRequest : UpdoxRequest {
			public string lastHandledMessageId { get; set;}
			public string messageType { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class QueueDequeueResponse : UpdoxResponse {
			public string messageId { get; set;}
			public int attempts { get; set;}
			public string accountId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_QueueDequeue {

	public static void main(String[] args) {
		UpdoxCodeSample_QueueDequeue codeSample = new UpdoxCodeSample_QueueDequeue();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "QueueDequeue";

		QueueDequeueRequest queueDequeueRequest = new QueueDequeueRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = queueDequeueRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		queueDequeueRequest.setLastHandledMessageId("lastHandledMessageId");
		queueDequeueRequest.setMessageType("messageType");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(queueDequeueRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'QueueDequeue', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		QueueDequeueResponse queueDequeueResponse = mapper.readValue(jsonResponse, QueueDequeueResponse.class);

		System.out.println(queueDequeueResponse.getResponseCode());
		System.out.println(queueDequeueResponse.getResponseMessage());
	}

	private class QueueDequeueRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String lastHandledMessageId;
    	private String messageType;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getLastHandledMessageId() {
			return lastHandledMessageId;
		}

		public void setLastHandledMessageId(String lastHandledMessageId) {
			this.lastHandledMessageId = lastHandledMessageId;
		}

		public String getMessageType() {
			return messageType;
		}

		public void setMessageType(String messageType) {
			this.messageType = messageType;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class QueueDequeueResponse extends UpdoxResponse {
		private String messageId;
		private int attempts;
		private String accountId;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public int getAttempts() {
			return attempts;
		}

		public void setAttempts(int attempts) {
			this.attempts = attempts;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

QueueList /io/QueueList

Returns a list of queued messages for a given practice

Try it! Toggle Notes/Code Samples

QueueList

Returns a list of queued messages for a given practice

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_QueueList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_QueueList codeSample = new UpdoxCodeSample_QueueList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "QueueList";
			QueueListRequest queueListRequest = new QueueListRequest();

			//set up credentials
			queueListRequest.auth.applicationId = "applicationId";
			queueListRequest.auth.applicationPassword = "applicationPassword";
			queueListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(queueListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "QueueList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			QueueListResponse queueListResponse = javascriptSerializer.Deserialize<QueueListResponse>(jsonResponse);

			Console.WriteLine(queueListResponse.responseCode);
			Console.WriteLine(queueListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class QueueListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class QueueMessageSummary {
			public string messageId { get; set;}
			public string messageType { get; set;}
			public long queuedDateTime { get; set;}
			public int processAttemptCount { get; set;}
			public bool processed { get; set;}
			public string statusText { get; set;}
		}

		public class QueueListResponse : UpdoxResponse {
			public List<QueueMessageSummary> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_QueueList {

	public static void main(String[] args) {
		UpdoxCodeSample_QueueList codeSample = new UpdoxCodeSample_QueueList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "QueueList";

		QueueListRequest queueListRequest = new QueueListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = queueListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(queueListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'QueueList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		QueueListResponse queueListResponse = mapper.readValue(jsonResponse, QueueListResponse.class);

		System.out.println(queueListResponse.getResponseCode());
		System.out.println(queueListResponse.getResponseMessage());
	}

	private class QueueListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class QueueMessageSummary {
		private String messageId;
		private String messageType;
		private long queuedDateTime;
		private int processAttemptCount;
		private boolean processed;
		private String statusText;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageType() {
			return messageType;
		}

		public void setMessageType(String messageType) {
			this.messageType = messageType;
		}

		public long getQueuedDateTime() {
			return queuedDateTime;
		}

		public void setQueuedDateTime(long queuedDateTime) {
			this.queuedDateTime = queuedDateTime;
		}

		public int getProcessAttemptCount() {
			return processAttemptCount;
		}

		public void setProcessAttemptCount(int processAttemptCount) {
			this.processAttemptCount = processAttemptCount;
		}

		public boolean isProcessed() {
			return processed;
		}

		public void setProcessed(boolean processed) {
			this.processed = processed;
		}

		public String getStatusText() {
			return statusText;
		}

		public void setStatusText(String statusText) {
			this.statusText = statusText;
		}
	}

	private static class QueueListResponse extends UpdoxResponse {
		private List<QueueMessageSummary> messages;


		public List<QueueMessageSummary> getMessages() {
			return messages;
		}

		public void setMessages(List<QueueMessageSummary> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

QueueRetrieve /io/QueueRetrieve

Retrieves a single queued message based on the supplied messageId

Parameter	Type	Value	Description
messageId	String		The ID of the queue message to retrieve. The value must contain exactly 36 characters. This is required.
method	String		Allows you to specify a `method`. Not all `messageTypes` allows this, see notes for a complete list.

Try it! Toggle Notes/Code Samples

QueueRetrieve

Retrieves a single queued message based on the supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

In addition to the messageId, QueueRetrieve allows you to specify a method. Supported methods are listed below:

MessageType	Method	Description	Error(s)
`ImportPDFRequest`	base64	Adds a new value, "documentBase64", to the response message, which holds the Base64 encoded data of `documentUrl`	`4022 File not found`
`inbound-fax`	base64Pdf	Adds a new value, "documentBase64Pdf", to the response message, which holds a PDF representation of the `documentId`

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_QueueRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_QueueRetrieve codeSample = new UpdoxCodeSample_QueueRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "QueueRetrieve";
			QueueRetrieveRequest queueRetrieveRequest = new QueueRetrieveRequest();

			//set up credentials
			queueRetrieveRequest.auth.applicationId = "applicationId";
			queueRetrieveRequest.auth.applicationPassword = "applicationPassword";
			queueRetrieveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			queueRetrieveRequest.messageId = "messageId";
			queueRetrieveRequest.method = "method";

			//create the request
			string json = Utilities.buildRequestJson(queueRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "QueueRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			QueueRetrieveResponse queueRetrieveResponse = javascriptSerializer.Deserialize<QueueRetrieveResponse>(jsonResponse);

			Console.WriteLine(queueRetrieveResponse.responseCode);
			Console.WriteLine(queueRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class QueueRetrieveRequest : UpdoxRequest {
			public string messageId { get; set;}
			public string method { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class QueueMessageSummary {
			public string messageId { get; set;}
			public string messageType { get; set;}
			public long queuedDateTime { get; set;}
			public int processAttemptCount { get; set;}
			public bool processed { get; set;}
			public string statusText { get; set;}
		}

		public class QueueRetrieveResponse : UpdoxResponse {
			public QueueMessageSummary summary { get; set;}
			public Dictionary<String, Object> message { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.Map;

public class UpdoxCodeSample_QueueRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_QueueRetrieve codeSample = new UpdoxCodeSample_QueueRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "QueueRetrieve";

		QueueRetrieveRequest queueRetrieveRequest = new QueueRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = queueRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		queueRetrieveRequest.setMessageId("messageId");
		queueRetrieveRequest.setMethod("method");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(queueRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'QueueRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		QueueRetrieveResponse queueRetrieveResponse = mapper.readValue(jsonResponse, QueueRetrieveResponse.class);

		System.out.println(queueRetrieveResponse.getResponseCode());
		System.out.println(queueRetrieveResponse.getResponseMessage());
	}

	private class QueueRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String messageId;
    	private String method;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class QueueMessageSummary {
		private String messageId;
		private String messageType;
		private long queuedDateTime;
		private int processAttemptCount;
		private boolean processed;
		private String statusText;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageType() {
			return messageType;
		}

		public void setMessageType(String messageType) {
			this.messageType = messageType;
		}

		public long getQueuedDateTime() {
			return queuedDateTime;
		}

		public void setQueuedDateTime(long queuedDateTime) {
			this.queuedDateTime = queuedDateTime;
		}

		public int getProcessAttemptCount() {
			return processAttemptCount;
		}

		public void setProcessAttemptCount(int processAttemptCount) {
			this.processAttemptCount = processAttemptCount;
		}

		public boolean isProcessed() {
			return processed;
		}

		public void setProcessed(boolean processed) {
			this.processed = processed;
		}

		public String getStatusText() {
			return statusText;
		}

		public void setStatusText(String statusText) {
			this.statusText = statusText;
		}
	}

	private static class QueueRetrieveResponse extends UpdoxResponse {
		private QueueMessageSummary summary;
		private Map message;


		public QueueMessageSummary getSummary() {
			return summary;
		}

		public void setSummary(QueueMessageSummary summary) {
			this.summary = summary;
		}

		public Map getMessage() {
			return message;
		}

		public void setMessage(Map message) {
			this.message = message;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

QueueUpdate /io/QueueUpdate

Updates a single queued message based on the supplied messageId

Parameter	Type	Description
messageId	String	The ID of the queue message to retrieve. The value must contain exactly 36 characters. This is required.
statusType	String	Setting this value to `ERROR` or `WARNING` will generate an inbox message to the user who imported the item into the EHR.
statusText	String	The body of the message associated with the status type provided.
markProcessed	Boolean	True to mark this queue message as processed.

Try it! Toggle Notes/Code Samples

QueueUpdate

Updates a single queued message based on the supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Using the StatusType and StatusText

When importing data to the EHR, there may be validations or post-processes in place. If you have received but are rejecting the import for any reason, you can use these values to communicate the reason back to the user (i.e. "ERROR" and "File size too large; please select fewer pages and reimport.").

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_QueueUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_QueueUpdate codeSample = new UpdoxCodeSample_QueueUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "QueueUpdate";
			QueueUpdateRequest queueUpdateRequest = new QueueUpdateRequest();

			//set up credentials
			queueUpdateRequest.auth.applicationId = "applicationId";
			queueUpdateRequest.auth.applicationPassword = "applicationPassword";
			queueUpdateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			queueUpdateRequest.messageId = "messageId";
			queueUpdateRequest.statusType = "statusType";
			queueUpdateRequest.statusText = "statusText";
			queueUpdateRequest.markProcessed = true;

			//create the request
			string json = Utilities.buildRequestJson(queueUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "QueueUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			QueueUpdateResponse queueUpdateResponse = javascriptSerializer.Deserialize<QueueUpdateResponse>(jsonResponse);

			Console.WriteLine(queueUpdateResponse.responseCode);
			Console.WriteLine(queueUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class QueueUpdateRequest : UpdoxRequest {
			public string messageId { get; set;}
			public string statusType { get; set;}
			public string statusText { get; set;}
			public bool markProcessed { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class QueueMessageSummary {
			public string messageId { get; set;}
			public string messageType { get; set;}
			public long queuedDateTime { get; set;}
			public int processAttemptCount { get; set;}
			public bool processed { get; set;}
			public string statusText { get; set;}
		}

		public class QueueUpdateResponse : UpdoxResponse {
			public QueueMessageSummary summary { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_QueueUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_QueueUpdate codeSample = new UpdoxCodeSample_QueueUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "QueueUpdate";

		QueueUpdateRequest queueUpdateRequest = new QueueUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = queueUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		queueUpdateRequest.setMessageId("messageId");
		queueUpdateRequest.setStatusType("statusType");
		queueUpdateRequest.setStatusText("statusText");
		queueUpdateRequest.setMarkProcessed(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(queueUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'QueueUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		QueueUpdateResponse queueUpdateResponse = mapper.readValue(jsonResponse, QueueUpdateResponse.class);

		System.out.println(queueUpdateResponse.getResponseCode());
		System.out.println(queueUpdateResponse.getResponseMessage());
	}

	private class QueueUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String messageId;
    	private String statusType;
    	private String statusText;
    	private boolean markProcessed;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getStatusType() {
			return statusType;
		}

		public void setStatusType(String statusType) {
			this.statusType = statusType;
		}

		public String getStatusText() {
			return statusText;
		}

		public void setStatusText(String statusText) {
			this.statusText = statusText;
		}

		public boolean isMarkProcessed() {
			return markProcessed;
		}

		public void setMarkProcessed(boolean markProcessed) {
			this.markProcessed = markProcessed;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class QueueMessageSummary {
		private String messageId;
		private String messageType;
		private long queuedDateTime;
		private int processAttemptCount;
		private boolean processed;
		private String statusText;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageType() {
			return messageType;
		}

		public void setMessageType(String messageType) {
			this.messageType = messageType;
		}

		public long getQueuedDateTime() {
			return queuedDateTime;
		}

		public void setQueuedDateTime(long queuedDateTime) {
			this.queuedDateTime = queuedDateTime;
		}

		public int getProcessAttemptCount() {
			return processAttemptCount;
		}

		public void setProcessAttemptCount(int processAttemptCount) {
			this.processAttemptCount = processAttemptCount;
		}

		public boolean isProcessed() {
			return processed;
		}

		public void setProcessed(boolean processed) {
			this.processed = processed;
		}

		public String getStatusText() {
			return statusText;
		}

		public void setStatusText(String statusText) {
			this.statusText = statusText;
		}
	}

	private static class QueueUpdateResponse extends UpdoxResponse {
		private QueueMessageSummary summary;


		public QueueMessageSummary getSummary() {
			return summary;
		}

		public void setSummary(QueueMessageSummary summary) {
			this.summary = summary;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

SyncPracticeCalendars /io/SyncPracticeCalendars

Creates or modify one or more calendars

Parameter	Type	Value
calendars	List	add remove

id	String
title	String
active	Boolean

Try it! Toggle Notes/Code Samples

SyncPracticeCalendars

Creates or modify one or more calendars

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_SyncPracticeCalendars {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_SyncPracticeCalendars codeSample = new UpdoxCodeSample_SyncPracticeCalendars();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "SyncPracticeCalendars";
			SyncPracticeCalendarsRequest syncPracticeCalendarsRequest = new SyncPracticeCalendarsRequest();

			//set up credentials
			syncPracticeCalendarsRequest.auth.applicationId = "applicationId";
			syncPracticeCalendarsRequest.auth.applicationPassword = "applicationPassword";
			syncPracticeCalendarsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<ExternalCalendar> calendars = new List<ExternalCalendar>();
			ExternalCalendar externalCalendar = new ExternalCalendar();
			externalCalendar.id = "id";
			externalCalendar.title = "title";
			externalCalendar.active = true;
			calendars.Add(externalCalendar);
			syncPracticeCalendarsRequest.calendars = calendars;

			//create the request
			string json = Utilities.buildRequestJson(syncPracticeCalendarsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "SyncPracticeCalendars", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			SyncPracticeCalendarsResponse syncPracticeCalendarsResponse = javascriptSerializer.Deserialize<SyncPracticeCalendarsResponse>(jsonResponse);

			Console.WriteLine(syncPracticeCalendarsResponse.responseCode);
			Console.WriteLine(syncPracticeCalendarsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ExternalCalendar {
			public string id { get; set;}
			public string title { get; set;}
			public bool active { get; set;}
		}

		public class SyncPracticeCalendarsRequest : UpdoxRequest {
			public List<ExternalCalendar> calendars { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class IdAndStatus {
			public string id { get; set;}
			public long updoxId { get; set;}
			public bool success { get; set;}
			public string message { get; set;}
		}

		public class SyncPracticeCalendarsResponse : UpdoxResponse {
			public List<IdAndStatus> statuses { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_SyncPracticeCalendars {

	public static void main(String[] args) {
		UpdoxCodeSample_SyncPracticeCalendars codeSample = new UpdoxCodeSample_SyncPracticeCalendars();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "SyncPracticeCalendars";

		SyncPracticeCalendarsRequest syncPracticeCalendarsRequest = new SyncPracticeCalendarsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = syncPracticeCalendarsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<ExternalCalendar> calendars = new ArrayList<>();
		ExternalCalendar externalCalendar = new ExternalCalendar();
		externalCalendar.setId("id");
		externalCalendar.setTitle("title");
		externalCalendar.setActive(true);
		calendars.add(externalCalendar);
		syncPracticeCalendarsRequest.setCalendars(calendars);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(syncPracticeCalendarsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'SyncPracticeCalendars', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		SyncPracticeCalendarsResponse syncPracticeCalendarsResponse = mapper.readValue(jsonResponse, SyncPracticeCalendarsResponse.class);

		System.out.println(syncPracticeCalendarsResponse.getResponseCode());
		System.out.println(syncPracticeCalendarsResponse.getResponseMessage());
	}

	private static class ExternalCalendar {
		private String id;
		private String title;
		private boolean active;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}
	}

	private class SyncPracticeCalendarsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<ExternalCalendar> calendars;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<ExternalCalendar> getCalendars() {
			return calendars;
		}

		public void setCalendars(List<ExternalCalendar> calendars) {
			this.calendars = calendars;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class IdAndStatus {
		private String id;
		private Long updoxId;
		private boolean success;
		private String message;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public Long getUpdoxId() {
			return updoxId;
		}

		public void setUpdoxId(Long updoxId) {
			this.updoxId = updoxId;
		}

		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}
	}

	private static class SyncPracticeCalendarsResponse extends UpdoxResponse {
		private List<IdAndStatus> statuses;


		public List<IdAndStatus> getStatuses() {
			return statuses;
		}

		public void setStatuses(List<IdAndStatus> statuses) {
			this.statuses = statuses;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MeaningfulUse_2017_Actions

MeasurePatientAccess2017Get /io/MeasurePatientAccess2017Get

List patients that received a CDA in the patient portal for data from 2017/01/01 (inclusive) through 2017/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2017Get

List patients that received a CDA in the patient portal for data from 2017/01/01 (inclusive) through 2017/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2017Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2017Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2017Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2017Get";
			MeasurePatientAccess2017GetRequest measurePatientAccess2017GetRequest = new MeasurePatientAccess2017GetRequest();

			//set up credentials
			measurePatientAccess2017GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2017GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2017GetRequest.auth.accountId = "accountId";
			measurePatientAccess2017GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2017GetRequest.startTime = 1L;
			measurePatientAccess2017GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2017GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2017Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2017GetResponse measurePatientAccess2017GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2017GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2017GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2017GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2017GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2017GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2017Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2017Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2017Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2017Get";

		MeasurePatientAccess2017GetRequest measurePatientAccess2017GetRequest = new MeasurePatientAccess2017GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2017GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2017GetRequest.setStartTime(1L);
		measurePatientAccess2017GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2017GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2017Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2017GetResponse measurePatientAccess2017GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2017GetResponse.class);

		System.out.println(measurePatientAccess2017GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2017GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2017GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2017GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MeasureSecureMsg2017Get /io/MeasureSecureMsg2017Get

List patients that received a secure message in the patient portal for data from 2017/01/01 (inclusive) through 2017/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureSecureMsg2017Get

List patients that received a secure message in the patient portal for data from 2017/01/01 (inclusive) through 2017/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureSecureMsg2017Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureSecureMsg2017Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2017Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureSecureMsg2017Get";
			MeasureSecureMsg2017GetRequest measureSecureMsg2017GetRequest = new MeasureSecureMsg2017GetRequest();

			//set up credentials
			measureSecureMsg2017GetRequest.auth.applicationId = "applicationId";
			measureSecureMsg2017GetRequest.auth.applicationPassword = "applicationPassword";
			measureSecureMsg2017GetRequest.auth.accountId = "accountId";
			measureSecureMsg2017GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureSecureMsg2017GetRequest.startTime = 1L;
			measureSecureMsg2017GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureSecureMsg2017GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureSecureMsg2017Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureSecureMsg2017GetResponse measureSecureMsg2017GetResponse = javascriptSerializer.Deserialize<MeasureSecureMsg2017GetResponse>(jsonResponse);

			Console.WriteLine(measureSecureMsg2017GetResponse.responseCode);
			Console.WriteLine(measureSecureMsg2017GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureSecureMsg2017GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureSecureMsg2017GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureSecureMsg2017Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureSecureMsg2017Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2017Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureSecureMsg2017Get";

		MeasureSecureMsg2017GetRequest measureSecureMsg2017GetRequest = new MeasureSecureMsg2017GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureSecureMsg2017GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureSecureMsg2017GetRequest.setStartTime(1L);
		measureSecureMsg2017GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureSecureMsg2017GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureSecureMsg2017Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureSecureMsg2017GetResponse measureSecureMsg2017GetResponse = mapper.readValue(jsonResponse, MeasureSecureMsg2017GetResponse.class);

		System.out.println(measureSecureMsg2017GetResponse.getResponseCode());
		System.out.println(measureSecureMsg2017GetResponse.getResponseMessage());
	}

	private class MeasureSecureMsg2017GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureSecureMsg2017GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MeaningfulUse_2018_Actions

MeasurePatientAccess2018Get /io/MeasurePatientAccess2018Get

List patients that received a CDA in the patient portal for data from 2018/01/01 (inclusive) through 2019/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2018Get

List patients that received a CDA in the patient portal for data from 2018/01/01 (inclusive) through 2019/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier. Note: Since this measure requires information that is not available to the Updox Patient Portal but is available to the EHR, the EHR vendor is responsible for:

- Reducing the numerator if a patient did not receive a CCD for every office visit and within the time limit specified by the regulations (e.g. within 4 business days of when the information became available to the provider)
- Calculating performance at the TIN/NPI or group TIN level for the ACI and ACI Transition measures

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2018Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2018Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2018Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2018Get";
			MeasurePatientAccess2018GetRequest measurePatientAccess2018GetRequest = new MeasurePatientAccess2018GetRequest();

			//set up credentials
			measurePatientAccess2018GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2018GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2018GetRequest.auth.accountId = "accountId";
			measurePatientAccess2018GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2018GetRequest.startTime = 1L;
			measurePatientAccess2018GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2018GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2018Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2018GetResponse measurePatientAccess2018GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2018GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2018GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2018GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2018GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2018GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2018Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2018Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2018Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2018Get";

		MeasurePatientAccess2018GetRequest measurePatientAccess2018GetRequest = new MeasurePatientAccess2018GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2018GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2018GetRequest.setStartTime(1L);
		measurePatientAccess2018GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2018GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2018Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2018GetResponse measurePatientAccess2018GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2018GetResponse.class);

		System.out.println(measurePatientAccess2018GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2018GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2018GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2018GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureSecureMsg2018Get /io/MeasureSecureMsg2018Get

List patients that received a secure message in the patient portal for data from 2018/01/01 (inclusive) through 2019/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureSecureMsg2018Get

List patients that received a secure message in the patient portal for data from 2018/01/01 (inclusive) through 2019/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

- Calculating performance at the TIN/NPI or group TIN level for the ACI and ACI Transition measures

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureSecureMsg2018Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureSecureMsg2018Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2018Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureSecureMsg2018Get";
			MeasureSecureMsg2018GetRequest measureSecureMsg2018GetRequest = new MeasureSecureMsg2018GetRequest();

			//set up credentials
			measureSecureMsg2018GetRequest.auth.applicationId = "applicationId";
			measureSecureMsg2018GetRequest.auth.applicationPassword = "applicationPassword";
			measureSecureMsg2018GetRequest.auth.accountId = "accountId";
			measureSecureMsg2018GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureSecureMsg2018GetRequest.startTime = 1L;
			measureSecureMsg2018GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureSecureMsg2018GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureSecureMsg2018Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureSecureMsg2018GetResponse measureSecureMsg2018GetResponse = javascriptSerializer.Deserialize<MeasureSecureMsg2018GetResponse>(jsonResponse);

			Console.WriteLine(measureSecureMsg2018GetResponse.responseCode);
			Console.WriteLine(measureSecureMsg2018GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureSecureMsg2018GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureSecureMsg2018GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureSecureMsg2018Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureSecureMsg2018Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2018Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureSecureMsg2018Get";

		MeasureSecureMsg2018GetRequest measureSecureMsg2018GetRequest = new MeasureSecureMsg2018GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureSecureMsg2018GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureSecureMsg2018GetRequest.setStartTime(1L);
		measureSecureMsg2018GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureSecureMsg2018GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureSecureMsg2018Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureSecureMsg2018GetResponse measureSecureMsg2018GetResponse = mapper.readValue(jsonResponse, MeasureSecureMsg2018GetResponse.class);

		System.out.println(measureSecureMsg2018GetResponse.getResponseCode());
		System.out.println(measureSecureMsg2018GetResponse.getResponseMessage());
	}

	private class MeasureSecureMsg2018GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureSecureMsg2018GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2019_Actions

MeasurePatientAccess2019Get /io/MeasurePatientAccess2019Get

List patients that received a CDA in the patient portal for data from 2019/01/01 (inclusive) through 2020/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2019Get

List patients that received a CDA in the patient portal for data from 2019/01/01 (inclusive) through 2020/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2019Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2019Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2019Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2019Get";
			MeasurePatientAccess2019GetRequest measurePatientAccess2019GetRequest = new MeasurePatientAccess2019GetRequest();

			//set up credentials
			measurePatientAccess2019GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2019GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2019GetRequest.auth.accountId = "accountId";
			measurePatientAccess2019GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2019GetRequest.startTime = 1L;
			measurePatientAccess2019GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2019GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2019Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2019GetResponse measurePatientAccess2019GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2019GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2019GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2019GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2019GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2019GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2019Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2019Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2019Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2019Get";

		MeasurePatientAccess2019GetRequest measurePatientAccess2019GetRequest = new MeasurePatientAccess2019GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2019GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2019GetRequest.setStartTime(1L);
		measurePatientAccess2019GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2019GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2019Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2019GetResponse measurePatientAccess2019GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2019GetResponse.class);

		System.out.println(measurePatientAccess2019GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2019GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2019GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2019GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureSecureMsg2019Get /io/MeasureSecureMsg2019Get

List patients that received a secure message in the patient portal for data from 2019/01/01 (inclusive) through 2020/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureSecureMsg2019Get

List patients that received a secure message in the patient portal for data from 2019/01/01 (inclusive) through 2020/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureSecureMsg2019Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureSecureMsg2019Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2019Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureSecureMsg2019Get";
			MeasureSecureMsg2019GetRequest measureSecureMsg2019GetRequest = new MeasureSecureMsg2019GetRequest();

			//set up credentials
			measureSecureMsg2019GetRequest.auth.applicationId = "applicationId";
			measureSecureMsg2019GetRequest.auth.applicationPassword = "applicationPassword";
			measureSecureMsg2019GetRequest.auth.accountId = "accountId";
			measureSecureMsg2019GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureSecureMsg2019GetRequest.startTime = 1L;
			measureSecureMsg2019GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureSecureMsg2019GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureSecureMsg2019Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureSecureMsg2019GetResponse measureSecureMsg2019GetResponse = javascriptSerializer.Deserialize<MeasureSecureMsg2019GetResponse>(jsonResponse);

			Console.WriteLine(measureSecureMsg2019GetResponse.responseCode);
			Console.WriteLine(measureSecureMsg2019GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureSecureMsg2019GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureSecureMsg2019GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureSecureMsg2019Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureSecureMsg2019Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2019Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureSecureMsg2019Get";

		MeasureSecureMsg2019GetRequest measureSecureMsg2019GetRequest = new MeasureSecureMsg2019GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureSecureMsg2019GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureSecureMsg2019GetRequest.setStartTime(1L);
		measureSecureMsg2019GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureSecureMsg2019GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureSecureMsg2019Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureSecureMsg2019GetResponse measureSecureMsg2019GetResponse = mapper.readValue(jsonResponse, MeasureSecureMsg2019GetResponse.class);

		System.out.println(measureSecureMsg2019GetResponse.getResponseCode());
		System.out.println(measureSecureMsg2019GetResponse.getResponseMessage());
	}

	private class MeasureSecureMsg2019GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureSecureMsg2019GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2020_Actions

MeasurePatientAccess2020Get /io/MeasurePatientAccess2020Get

List patients that received a CDA in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2020Get

List patients that received a CDA in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2020Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2020Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2020Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2020Get";
			MeasurePatientAccess2020GetRequest measurePatientAccess2020GetRequest = new MeasurePatientAccess2020GetRequest();

			//set up credentials
			measurePatientAccess2020GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2020GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2020GetRequest.auth.accountId = "accountId";
			measurePatientAccess2020GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2020GetRequest.startTime = 1L;
			measurePatientAccess2020GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2020GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2020Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2020GetResponse measurePatientAccess2020GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2020GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2020GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2020GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2020GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2020GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2020Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2020Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2020Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2020Get";

		MeasurePatientAccess2020GetRequest measurePatientAccess2020GetRequest = new MeasurePatientAccess2020GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2020GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2020GetRequest.setStartTime(1L);
		measurePatientAccess2020GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2020GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2020Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2020GetResponse measurePatientAccess2020GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2020GetResponse.class);

		System.out.println(measurePatientAccess2020GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2020GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2020GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2020GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureSecureMsg2020Get /io/MeasureSecureMsg2020Get

List patients that received a secure message in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureSecureMsg2020Get

List patients that received a secure message in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureSecureMsg2020Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureSecureMsg2020Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2020Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureSecureMsg2020Get";
			MeasureSecureMsg2020GetRequest measureSecureMsg2020GetRequest = new MeasureSecureMsg2020GetRequest();

			//set up credentials
			measureSecureMsg2020GetRequest.auth.applicationId = "applicationId";
			measureSecureMsg2020GetRequest.auth.applicationPassword = "applicationPassword";
			measureSecureMsg2020GetRequest.auth.accountId = "accountId";
			measureSecureMsg2020GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureSecureMsg2020GetRequest.startTime = 1L;
			measureSecureMsg2020GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureSecureMsg2020GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureSecureMsg2020Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureSecureMsg2020GetResponse measureSecureMsg2020GetResponse = javascriptSerializer.Deserialize<MeasureSecureMsg2020GetResponse>(jsonResponse);

			Console.WriteLine(measureSecureMsg2020GetResponse.responseCode);
			Console.WriteLine(measureSecureMsg2020GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureSecureMsg2020GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureSecureMsg2020GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureSecureMsg2020Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureSecureMsg2020Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2020Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureSecureMsg2020Get";

		MeasureSecureMsg2020GetRequest measureSecureMsg2020GetRequest = new MeasureSecureMsg2020GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureSecureMsg2020GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureSecureMsg2020GetRequest.setStartTime(1L);
		measureSecureMsg2020GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureSecureMsg2020GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureSecureMsg2020Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureSecureMsg2020GetResponse measureSecureMsg2020GetResponse = mapper.readValue(jsonResponse, MeasureSecureMsg2020GetResponse.class);

		System.out.println(measureSecureMsg2020GetResponse.getResponseCode());
		System.out.println(measureSecureMsg2020GetResponse.getResponseMessage());
	}

	private class MeasureSecureMsg2020GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureSecureMsg2020GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureVDT2020Get /io/MeasureVDT2020Get

List patients that viewed, downloaded, or sent a CDA in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureVDT2020Get

List patients that viewed, downloaded, or sent a CDA in the patient portal for data from 2020/01/01 (inclusive) through 2021/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureVDT2020Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureVDT2020Get codeSample = new UpdoxCodeSample_MeasureVDT2020Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureVDT2020Get";
			MeasureVDT2020GetRequest measureVDT2020GetRequest = new MeasureVDT2020GetRequest();

			//set up credentials
			measureVDT2020GetRequest.auth.applicationId = "applicationId";
			measureVDT2020GetRequest.auth.applicationPassword = "applicationPassword";
			measureVDT2020GetRequest.auth.accountId = "accountId";
			measureVDT2020GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureVDT2020GetRequest.startTime = 1L;
			measureVDT2020GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureVDT2020GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureVDT2020Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureVDT2020GetResponse measureVDT2020GetResponse = javascriptSerializer.Deserialize<MeasureVDT2020GetResponse>(jsonResponse);

			Console.WriteLine(measureVDT2020GetResponse.responseCode);
			Console.WriteLine(measureVDT2020GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureVDT2020GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureVDT2020GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureVDT2020Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureVDT2020Get codeSample = new UpdoxCodeSample_MeasureVDT2020Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureVDT2020Get";

		MeasureVDT2020GetRequest measureVDT2020GetRequest = new MeasureVDT2020GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureVDT2020GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureVDT2020GetRequest.setStartTime(1L);
		measureVDT2020GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureVDT2020GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureVDT2020Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureVDT2020GetResponse measureVDT2020GetResponse = mapper.readValue(jsonResponse, MeasureVDT2020GetResponse.class);

		System.out.println(measureVDT2020GetResponse.getResponseCode());
		System.out.println(measureVDT2020GetResponse.getResponseMessage());
	}

	private class MeasureVDT2020GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureVDT2020GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2021_Actions

MeasurePatientAccess2021Get /io/MeasurePatientAccess2021Get

List patients that received a CDA in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2021Get

List patients that received a CDA in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2021Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2021Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2021Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2021Get";
			MeasurePatientAccess2021GetRequest measurePatientAccess2021GetRequest = new MeasurePatientAccess2021GetRequest();

			//set up credentials
			measurePatientAccess2021GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2021GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2021GetRequest.auth.accountId = "accountId";
			measurePatientAccess2021GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2021GetRequest.startTime = 1L;
			measurePatientAccess2021GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2021GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2021Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2021GetResponse measurePatientAccess2021GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2021GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2021GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2021GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2021GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2021GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2021Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2021Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2021Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2021Get";

		MeasurePatientAccess2021GetRequest measurePatientAccess2021GetRequest = new MeasurePatientAccess2021GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2021GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2021GetRequest.setStartTime(1L);
		measurePatientAccess2021GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2021GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2021Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2021GetResponse measurePatientAccess2021GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2021GetResponse.class);

		System.out.println(measurePatientAccess2021GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2021GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2021GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2021GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureSecureMsg2021Get /io/MeasureSecureMsg2021Get

List patients that received a secure message in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureSecureMsg2021Get

List patients that received a secure message in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureSecureMsg2021Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureSecureMsg2021Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2021Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureSecureMsg2021Get";
			MeasureSecureMsg2021GetRequest measureSecureMsg2021GetRequest = new MeasureSecureMsg2021GetRequest();

			//set up credentials
			measureSecureMsg2021GetRequest.auth.applicationId = "applicationId";
			measureSecureMsg2021GetRequest.auth.applicationPassword = "applicationPassword";
			measureSecureMsg2021GetRequest.auth.accountId = "accountId";
			measureSecureMsg2021GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureSecureMsg2021GetRequest.startTime = 1L;
			measureSecureMsg2021GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureSecureMsg2021GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureSecureMsg2021Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureSecureMsg2021GetResponse measureSecureMsg2021GetResponse = javascriptSerializer.Deserialize<MeasureSecureMsg2021GetResponse>(jsonResponse);

			Console.WriteLine(measureSecureMsg2021GetResponse.responseCode);
			Console.WriteLine(measureSecureMsg2021GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureSecureMsg2021GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureSecureMsg2021GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureSecureMsg2021Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureSecureMsg2021Get codeSample = new UpdoxCodeSample_MeasureSecureMsg2021Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureSecureMsg2021Get";

		MeasureSecureMsg2021GetRequest measureSecureMsg2021GetRequest = new MeasureSecureMsg2021GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureSecureMsg2021GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureSecureMsg2021GetRequest.setStartTime(1L);
		measureSecureMsg2021GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureSecureMsg2021GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureSecureMsg2021Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureSecureMsg2021GetResponse measureSecureMsg2021GetResponse = mapper.readValue(jsonResponse, MeasureSecureMsg2021GetResponse.class);

		System.out.println(measureSecureMsg2021GetResponse.getResponseCode());
		System.out.println(measureSecureMsg2021GetResponse.getResponseMessage());
	}

	private class MeasureSecureMsg2021GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureSecureMsg2021GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeasureVDT2021Get /io/MeasureVDT2021Get

List patients that viewed, downloaded, or sent a CDA in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasureVDT2021Get

List patients that viewed, downloaded, or sent a CDA in the patient portal for data from 2021/01/01 (inclusive) through 2022/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasureVDT2021Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasureVDT2021Get codeSample = new UpdoxCodeSample_MeasureVDT2021Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasureVDT2021Get";
			MeasureVDT2021GetRequest measureVDT2021GetRequest = new MeasureVDT2021GetRequest();

			//set up credentials
			measureVDT2021GetRequest.auth.applicationId = "applicationId";
			measureVDT2021GetRequest.auth.applicationPassword = "applicationPassword";
			measureVDT2021GetRequest.auth.accountId = "accountId";
			measureVDT2021GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measureVDT2021GetRequest.startTime = 1L;
			measureVDT2021GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measureVDT2021GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasureVDT2021Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasureVDT2021GetResponse measureVDT2021GetResponse = javascriptSerializer.Deserialize<MeasureVDT2021GetResponse>(jsonResponse);

			Console.WriteLine(measureVDT2021GetResponse.responseCode);
			Console.WriteLine(measureVDT2021GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasureVDT2021GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasureVDT2021GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasureVDT2021Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasureVDT2021Get codeSample = new UpdoxCodeSample_MeasureVDT2021Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasureVDT2021Get";

		MeasureVDT2021GetRequest measureVDT2021GetRequest = new MeasureVDT2021GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measureVDT2021GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measureVDT2021GetRequest.setStartTime(1L);
		measureVDT2021GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measureVDT2021GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasureVDT2021Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasureVDT2021GetResponse measureVDT2021GetResponse = mapper.readValue(jsonResponse, MeasureVDT2021GetResponse.class);

		System.out.println(measureVDT2021GetResponse.getResponseCode());
		System.out.println(measureVDT2021GetResponse.getResponseMessage());
	}

	private class MeasureVDT2021GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasureVDT2021GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2022_Actions

MeasurePatientAccess2022Get /io/MeasurePatientAccess2022Get

List patients that received a CDA in the patient portal for data from 2022/01/01 (inclusive) through 2023/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2022Get

List patients that received a CDA in the patient portal for data from 2022/01/01 (inclusive) through 2023/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2022Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2022Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2022Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2022Get";
			MeasurePatientAccess2022GetRequest measurePatientAccess2022GetRequest = new MeasurePatientAccess2022GetRequest();

			//set up credentials
			measurePatientAccess2022GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2022GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2022GetRequest.auth.accountId = "accountId";
			measurePatientAccess2022GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2022GetRequest.startTime = 1L;
			measurePatientAccess2022GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2022GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2022Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2022GetResponse measurePatientAccess2022GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2022GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2022GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2022GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2022GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2022GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2022Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2022Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2022Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2022Get";

		MeasurePatientAccess2022GetRequest measurePatientAccess2022GetRequest = new MeasurePatientAccess2022GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2022GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2022GetRequest.setStartTime(1L);
		measurePatientAccess2022GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2022GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2022Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2022GetResponse measurePatientAccess2022GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2022GetResponse.class);

		System.out.println(measurePatientAccess2022GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2022GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2022GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2022GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2023_Actions

MeasurePatientAccess2023Get /io/MeasurePatientAccess2023Get

List patients that received a CDA in the patient portal for data from 2023/01/01 (inclusive) through 2024/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2023Get

List patients that received a CDA in the patient portal for data from 2023/01/01 (inclusive) through 2024/01/01 (exclusive) and/or a one year increment.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2023Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2023Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2023Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2023Get";
			MeasurePatientAccess2023GetRequest measurePatientAccess2023GetRequest = new MeasurePatientAccess2023GetRequest();

			//set up credentials
			measurePatientAccess2023GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2023GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2023GetRequest.auth.accountId = "accountId";
			measurePatientAccess2023GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2023GetRequest.startTime = 1L;
			measurePatientAccess2023GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2023GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2023Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2023GetResponse measurePatientAccess2023GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2023GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2023GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2023GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2023GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2023GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2023Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2023Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2023Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2023Get";

		MeasurePatientAccess2023GetRequest measurePatientAccess2023GetRequest = new MeasurePatientAccess2023GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2023GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2023GetRequest.setStartTime(1L);
		measurePatientAccess2023GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2023GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2023Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2023GetResponse measurePatientAccess2023GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2023GetResponse.class);

		System.out.println(measurePatientAccess2023GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2023GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2023GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2023GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2024_Actions

MeasurePatientAccess2024Get /io/MeasurePatientAccess2024Get

List patients that received a CDA in the patient portal for data from 2024/01/01 (inclusive) through 2025/01/01 (exclusive) and/or a one year increment.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2024Get

List patients that received a CDA in the patient portal for data from 2024/01/01 (inclusive) through 2025/01/01 (exclusive) and/or a one year increment.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2024Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2024Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2024Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2024Get";
			MeasurePatientAccess2024GetRequest measurePatientAccess2024GetRequest = new MeasurePatientAccess2024GetRequest();

			//set up credentials
			measurePatientAccess2024GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2024GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2024GetRequest.auth.accountId = "accountId";
			measurePatientAccess2024GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2024GetRequest.startTime = 1L;
			measurePatientAccess2024GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2024GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2024Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2024GetResponse measurePatientAccess2024GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2024GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2024GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2024GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2024GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2024GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2024Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2024Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2024Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2024Get";

		MeasurePatientAccess2024GetRequest measurePatientAccess2024GetRequest = new MeasurePatientAccess2024GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2024GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2024GetRequest.setStartTime(1L);
		measurePatientAccess2024GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2024GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2024Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2024GetResponse measurePatientAccess2024GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2024GetResponse.class);

		System.out.println(measurePatientAccess2024GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2024GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2024GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2024GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MeaningfulUse_2025_Actions

MeasurePatientAccess2025Get /io/MeasurePatientAccess2025Get

List patients that received a CDA in the patient portal for data from 2025/01/01 (inclusive) through 2026/01/01 (exclusive) and/or a one year increment.

Parameter	Type	Value	Description
startTime	Long		Start of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.
endTime	Long		End of search range, expressed as the number of milliseconds since midnight 1/1/1970 UTC.

Try it! Toggle Notes/Code Samples

MeasurePatientAccess2025Get

List patients that received a CDA in the patient portal for data from 2025/01/01 (inclusive) through 2026/01/01 (exclusive) and/or a one year increment.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Patients entered into the Updox Addressbook manually will not be represented in the numerator. To be included in the results, the patient must be synced with a partner identifier.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MeasurePatientAccess2025Get {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MeasurePatientAccess2025Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2025Get();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MeasurePatientAccess2025Get";
			MeasurePatientAccess2025GetRequest measurePatientAccess2025GetRequest = new MeasurePatientAccess2025GetRequest();

			//set up credentials
			measurePatientAccess2025GetRequest.auth.applicationId = "applicationId";
			measurePatientAccess2025GetRequest.auth.applicationPassword = "applicationPassword";
			measurePatientAccess2025GetRequest.auth.accountId = "accountId";
			measurePatientAccess2025GetRequest.auth.userId = "userId";

			//set up request specific parameters
			measurePatientAccess2025GetRequest.startTime = 1L;
			measurePatientAccess2025GetRequest.endTime = 1L;

			//create the request
			string json = Utilities.buildRequestJson(measurePatientAccess2025GetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MeasurePatientAccess2025Get", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MeasurePatientAccess2025GetResponse measurePatientAccess2025GetResponse = javascriptSerializer.Deserialize<MeasurePatientAccess2025GetResponse>(jsonResponse);

			Console.WriteLine(measurePatientAccess2025GetResponse.responseCode);
			Console.WriteLine(measurePatientAccess2025GetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MeasurePatientAccess2025GetRequest : UpdoxRequest {
			public long startTime { get; set;}
			public long endTime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MeasurePatientAccess2025GetResponse : UpdoxResponse {
			public long numerator { get; set;}
			public Collection events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MeasurePatientAccess2025Get {

	public static void main(String[] args) {
		UpdoxCodeSample_MeasurePatientAccess2025Get codeSample = new UpdoxCodeSample_MeasurePatientAccess2025Get();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MeasurePatientAccess2025Get";

		MeasurePatientAccess2025GetRequest measurePatientAccess2025GetRequest = new MeasurePatientAccess2025GetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = measurePatientAccess2025GetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		measurePatientAccess2025GetRequest.setStartTime(1L);
		measurePatientAccess2025GetRequest.setEndTime(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(measurePatientAccess2025GetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MeasurePatientAccess2025Get', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MeasurePatientAccess2025GetResponse measurePatientAccess2025GetResponse = mapper.readValue(jsonResponse, MeasurePatientAccess2025GetResponse.class);

		System.out.println(measurePatientAccess2025GetResponse.getResponseCode());
		System.out.println(measurePatientAccess2025GetResponse.getResponseMessage());
	}

	private class MeasurePatientAccess2025GetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Long startTime;
    	private Long endTime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Long getStartTime() {
			return startTime;
		}

		public void setStartTime(Long startTime) {
			this.startTime = startTime;
		}

		public Long getEndTime() {
			return endTime;
		}

		public void setEndTime(Long endTime) {
			this.endTime = endTime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MeasurePatientAccess2025GetResponse extends UpdoxResponse {
		private long numerator;
		private Collection events;


		public long getNumerator() {
			return numerator;
		}

		public void setNumerator(long numerator) {
			this.numerator = numerator;
		}

		public Collection getEvents() {
			return events;
		}

		public void setEvents(Collection events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4025`	`Date range is out of order`

MessageActions

MessageAttachRetrieve /io/MessageAttachRetrieve

Returns Base64-encoded attachment content for the provided attachment ID

Parameter	Type	Value	Description
attachmentId	Long		An attachment identifier. This is required.

Try it! Toggle Notes/Code Samples

MessageAttachRetrieve

Returns Base64-encoded attachment content for the provided attachment ID

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageAttachRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageAttachRetrieve codeSample = new UpdoxCodeSample_MessageAttachRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageAttachRetrieve";
			MessageAttachRetrieveRequest messageAttachRetrieveRequest = new MessageAttachRetrieveRequest();

			//set up credentials
			messageAttachRetrieveRequest.auth.applicationId = "applicationId";
			messageAttachRetrieveRequest.auth.applicationPassword = "applicationPassword";
			messageAttachRetrieveRequest.auth.accountId = "accountId";
			messageAttachRetrieveRequest.auth.userId = "userId";

			//set up request specific parameters
			messageAttachRetrieveRequest.attachmentId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(messageAttachRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageAttachRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageAttachRetrieveResponse messageAttachRetrieveResponse = javascriptSerializer.Deserialize<MessageAttachRetrieveResponse>(jsonResponse);

			Console.WriteLine(messageAttachRetrieveResponse.responseCode);
			Console.WriteLine(messageAttachRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageAttachRetrieveRequest : UpdoxRequest {
			public long attachmentId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageAttachRetrieveResponse : UpdoxResponse {
			public string name { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MessageAttachRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageAttachRetrieve codeSample = new UpdoxCodeSample_MessageAttachRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageAttachRetrieve";

		MessageAttachRetrieveRequest messageAttachRetrieveRequest = new MessageAttachRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageAttachRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageAttachRetrieveRequest.setAttachmentId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageAttachRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageAttachRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageAttachRetrieveResponse messageAttachRetrieveResponse = mapper.readValue(jsonResponse, MessageAttachRetrieveResponse.class);

		System.out.println(messageAttachRetrieveResponse.getResponseCode());
		System.out.println(messageAttachRetrieveResponse.getResponseMessage());
	}

	private class MessageAttachRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long attachmentId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getAttachmentId() {
			return attachmentId;
		}

		public void setAttachmentId(long attachmentId) {
			this.attachmentId = attachmentId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageAttachRetrieveResponse extends UpdoxResponse {
		private String name;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4960`	`image not found`

MessageCountForAccount /io/MessageCountForAccount

Returns a count of messages for the all of the users in a practice, filtered by provided values

Parameter	Type	Description
dateSince	Date	Returns data since provided Date. format yyyy-mm-dd.
messageIdSince	Long	Returns data since provided MessageId.
countUnreadOnly	Boolean	True to return only the count of unread messages.
location	String	Locations are I (inbox), S (sent), A (archive), and T (trash) or empty (for all four locations). Must be one of the following values: I, S, A, T.

Try it! Toggle Notes/Code Samples

MessageCountForAccount

Returns a count of messages for the all of the users in a practice, filtered by provided values

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageCountForAccount {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageCountForAccount codeSample = new UpdoxCodeSample_MessageCountForAccount();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageCountForAccount";
			MessageCountForAccountRequest messageCountForAccountRequest = new MessageCountForAccountRequest();

			//set up credentials
			messageCountForAccountRequest.auth.applicationId = "applicationId";
			messageCountForAccountRequest.auth.applicationPassword = "applicationPassword";
			messageCountForAccountRequest.auth.accountId = "accountId";

			//set up request specific parameters
			messageCountForAccountRequest.dateSince = "datesince";
			messageCountForAccountRequest.messageIdSince = 1L;
			messageCountForAccountRequest.countUnreadOnly = true;
			messageCountForAccountRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(messageCountForAccountRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageCountForAccount", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageCountForAccountResponse messageCountForAccountResponse = javascriptSerializer.Deserialize<MessageCountForAccountResponse>(jsonResponse);

			Console.WriteLine(messageCountForAccountResponse.responseCode);
			Console.WriteLine(messageCountForAccountResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageCountForAccountRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public long messageIdSince { get; set;}
			public bool countUnreadOnly { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageCount {
			public int count { get; set;}
			public string userId { get; set;}
		}

		public class MessageCountForAccountResponse : UpdoxResponse {
			public List<MessageCount> countList { get; set;}
			public int countTotal { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_MessageCountForAccount {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageCountForAccount codeSample = new UpdoxCodeSample_MessageCountForAccount();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageCountForAccount";

		MessageCountForAccountRequest messageCountForAccountRequest = new MessageCountForAccountRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageCountForAccountRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		messageCountForAccountRequest.setDateSince(new Date());
		messageCountForAccountRequest.setMessageIdSince(1L);
		messageCountForAccountRequest.setCountUnreadOnly(true);
		messageCountForAccountRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageCountForAccountRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageCountForAccount', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageCountForAccountResponse messageCountForAccountResponse = mapper.readValue(jsonResponse, MessageCountForAccountResponse.class);

		System.out.println(messageCountForAccountResponse.getResponseCode());
		System.out.println(messageCountForAccountResponse.getResponseMessage());
	}

	private class MessageCountForAccountRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private long messageIdSince;
    	private boolean countUnreadOnly;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public long getMessageIdSince() {
			return messageIdSince;
		}

		public void setMessageIdSince(long messageIdSince) {
			this.messageIdSince = messageIdSince;
		}

		public boolean isCountUnreadOnly() {
			return countUnreadOnly;
		}

		public void setCountUnreadOnly(boolean countUnreadOnly) {
			this.countUnreadOnly = countUnreadOnly;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class MessageCount {
		private int count;
		private String userId;


		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageCountForAccountResponse extends UpdoxResponse {
		private List<MessageCount> countList;
		private int countTotal;


		public List<MessageCount> getCountList() {
			return countList;
		}

		public void setCountList(List<MessageCount> countList) {
			this.countList = countList;
		}

		public int getCountTotal() {
			return countTotal;
		}

		public void setCountTotal(int countTotal) {
			this.countTotal = countTotal;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageCountSince /io/MessageCountSince

Returns a count of messages for the authenticated user, received since the supplied date

Parameter	Type	Value	Description
dateSince	Date		Format yyyy-mm-dd. If not provided, the returned count indicates the total number of messages in the inbox.
countUnreadOnly	Boolean		True to return only the count of unread messages.

Try it! Toggle Notes/Code Samples

MessageCountSince

Returns a count of messages for the authenticated user, received since the supplied date

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageCountSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageCountSince codeSample = new UpdoxCodeSample_MessageCountSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageCountSince";
			MessageCountSinceRequest messageCountSinceRequest = new MessageCountSinceRequest();

			//set up credentials
			messageCountSinceRequest.auth.applicationId = "applicationId";
			messageCountSinceRequest.auth.applicationPassword = "applicationPassword";
			messageCountSinceRequest.auth.accountId = "accountId";
			messageCountSinceRequest.auth.userId = "userId";

			//set up request specific parameters
			messageCountSinceRequest.dateSince = "datesince";
			messageCountSinceRequest.countUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(messageCountSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageCountSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageCountSinceResponse messageCountSinceResponse = javascriptSerializer.Deserialize<MessageCountSinceResponse>(jsonResponse);

			Console.WriteLine(messageCountSinceResponse.responseCode);
			Console.WriteLine(messageCountSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageCountSinceRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public bool countUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Map {
		}

		public class MessageCountSinceResponse : UpdoxResponse {
			public List<Map> records { get; set;}
			public int count { get; set;}
			public List<Map> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_MessageCountSince {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageCountSince codeSample = new UpdoxCodeSample_MessageCountSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageCountSince";

		MessageCountSinceRequest messageCountSinceRequest = new MessageCountSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageCountSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageCountSinceRequest.setDateSince(new Date());
		messageCountSinceRequest.setCountUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageCountSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageCountSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageCountSinceResponse messageCountSinceResponse = mapper.readValue(jsonResponse, MessageCountSinceResponse.class);

		System.out.println(messageCountSinceResponse.getResponseCode());
		System.out.println(messageCountSinceResponse.getResponseMessage());
	}

	private class MessageCountSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private boolean countUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public boolean isCountUnreadOnly() {
			return countUnreadOnly;
		}

		public void setCountUnreadOnly(boolean countUnreadOnly) {
			this.countUnreadOnly = countUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class Map {

	}

	private static class MessageCountSinceResponse extends UpdoxResponse {
		private List<Map> records;
		private int count;
		private List<Map> locations;


		public List<Map> getRecords() {
			return records;
		}

		public void setRecords(List<Map> records) {
			this.records = records;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public List<Map> getLocations() {
			return locations;
		}

		public void setLocations(List<Map> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageEmptyTrash /io/MessageEmptyTrash

Empty all messages in Trash for userId

Try it! Toggle Notes/Code Samples

MessageEmptyTrash

Empty all messages in Trash for userId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageEmptyTrash {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageEmptyTrash codeSample = new UpdoxCodeSample_MessageEmptyTrash();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageEmptyTrash";
			MessageEmptyTrashRequest messageEmptyTrashRequest = new MessageEmptyTrashRequest();

			//set up credentials
			messageEmptyTrashRequest.auth.applicationId = "applicationId";
			messageEmptyTrashRequest.auth.applicationPassword = "applicationPassword";
			messageEmptyTrashRequest.auth.accountId = "accountId";
			messageEmptyTrashRequest.auth.userId = "userId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(messageEmptyTrashRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageEmptyTrash", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageEmptyTrashResponse messageEmptyTrashResponse = javascriptSerializer.Deserialize<MessageEmptyTrashResponse>(jsonResponse);

			Console.WriteLine(messageEmptyTrashResponse.responseCode);
			Console.WriteLine(messageEmptyTrashResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageEmptyTrashRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class MessageEmptyTrashResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MessageEmptyTrash {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageEmptyTrash codeSample = new UpdoxCodeSample_MessageEmptyTrash();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageEmptyTrash";

		MessageEmptyTrashRequest messageEmptyTrashRequest = new MessageEmptyTrashRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageEmptyTrashRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageEmptyTrashRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageEmptyTrash', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageEmptyTrashResponse messageEmptyTrashResponse = mapper.readValue(jsonResponse, MessageEmptyTrashResponse.class);

		System.out.println(messageEmptyTrashResponse.getResponseCode());
		System.out.println(messageEmptyTrashResponse.getResponseMessage());
	}

	private class MessageEmptyTrashRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageEmptyTrashResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageFetch /io/MessageFetch

Returns list of messages ids for authorized user

Parameter	Type	Value	Description
dateSince	Date		Returns data since provided Date. format yyyy-mm-dd.
messageIdSince	Long		Returns data since provided MessageId.
countUnreadOnly	Boolean		True to return only unread messages.
location	String		Locations are I (inbox), S (sent), A (archive), and T (trash) or empty (for all four locations). Must be one of the following values: I, S, A, T.
showSharedItems	Boolean		True to include practice items (True by default).
messageTypes	List	add remove	Optional: message types to retrieve, common examples would be fax, email, upload, or print (default is all message types).

	String

Try it! Toggle Notes/Code Samples

MessageFetch

Returns list of messages ids for authorized user

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageFetch {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageFetch codeSample = new UpdoxCodeSample_MessageFetch();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageFetch";
			MessageFetchRequest messageFetchRequest = new MessageFetchRequest();

			//set up credentials
			messageFetchRequest.auth.applicationId = "applicationId";
			messageFetchRequest.auth.applicationPassword = "applicationPassword";
			messageFetchRequest.auth.accountId = "accountId";
			messageFetchRequest.auth.userId = "userId";

			//set up request specific parameters
			messageFetchRequest.dateSince = "datesince";
			messageFetchRequest.messageIdSince = 1L;
			messageFetchRequest.countUnreadOnly = true;
			messageFetchRequest.location = "location";
			messageFetchRequest.showSharedItems = true;
			List<string> messageTypes = new List<string>();
			string messageTypesString = "messageTypes";
			messageTypes.Add(messageTypesString);
			messageFetchRequest.messageTypes = messageTypes;

			//create the request
			string json = Utilities.buildRequestJson(messageFetchRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageFetch", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageFetchResponse messageFetchResponse = javascriptSerializer.Deserialize<MessageFetchResponse>(jsonResponse);

			Console.WriteLine(messageFetchResponse.responseCode);
			Console.WriteLine(messageFetchResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageFetchRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public long messageIdSince { get; set;}
			public bool countUnreadOnly { get; set;}
			public string location { get; set;}
			public bool showSharedItems { get; set;}
			public List<string> messageTypes { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageFetchResponse : UpdoxResponse {
			public string userId { get; set;}
			public List<long> fetchList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_MessageFetch {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageFetch codeSample = new UpdoxCodeSample_MessageFetch();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageFetch";

		MessageFetchRequest messageFetchRequest = new MessageFetchRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageFetchRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageFetchRequest.setDateSince(new Date());
		messageFetchRequest.setMessageIdSince(1L);
		messageFetchRequest.setCountUnreadOnly(true);
		messageFetchRequest.setLocation("location");
		messageFetchRequest.setShowSharedItems(true);
	List<String> messageTypes = new ArrayList<>();
		String messageTypesString = "messageTypes";
		messageTypes.add(messageTypesString);
		messageFetchRequest.setMessageTypes(messageTypes);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageFetchRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageFetch', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageFetchResponse messageFetchResponse = mapper.readValue(jsonResponse, MessageFetchResponse.class);

		System.out.println(messageFetchResponse.getResponseCode());
		System.out.println(messageFetchResponse.getResponseMessage());
	}

	private class MessageFetchRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private long messageIdSince;
    	private boolean countUnreadOnly;
    	private String location;
    	private boolean showSharedItems;
    	private List<String> messageTypes;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public long getMessageIdSince() {
			return messageIdSince;
		}

		public void setMessageIdSince(long messageIdSince) {
			this.messageIdSince = messageIdSince;
		}

		public boolean isCountUnreadOnly() {
			return countUnreadOnly;
		}

		public void setCountUnreadOnly(boolean countUnreadOnly) {
			this.countUnreadOnly = countUnreadOnly;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isShowSharedItems() {
			return showSharedItems;
		}

		public void setShowSharedItems(boolean showSharedItems) {
			this.showSharedItems = showSharedItems;
		}

		public List<String> getMessageTypes() {
			return messageTypes;
		}

		public void setMessageTypes(List<String> messageTypes) {
			this.messageTypes = messageTypes;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageFetchResponse extends UpdoxResponse {
		private String userId;
		private List<Long> fetchList;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public List<Long> getFetchList() {
			return fetchList;
		}

		public void setFetchList(List<Long> fetchList) {
			this.fetchList = fetchList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageFetchForAccount /io/MessageFetchForAccount

Returns list of users and messages ids for them

Parameter	Type	Value	Description
dateSince	Date		Returns data since provided Date. format yyyy-mm-dd.
messageIdSince	Long		Returns data since provided MessageId.
countUnreadOnly	Boolean		True to return only unread messages.
location	String		Locations are I (inbox), S (sent), A (archive), and T (trash) or empty (for all four locations). Must be one of the following values: I, S, A, T.
showSharedItems	Boolean		True to include practice items (True by default).
messageTypes	List	add remove	Optional: message types to retrieve, common examples would be fax, email, upload, or print (default is all message types).

	String

Try it! Toggle Notes/Code Samples

MessageFetchForAccount

Returns list of users and messages ids for them

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageFetchForAccount {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageFetchForAccount codeSample = new UpdoxCodeSample_MessageFetchForAccount();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageFetchForAccount";
			MessageFetchForAccountRequest messageFetchForAccountRequest = new MessageFetchForAccountRequest();

			//set up credentials
			messageFetchForAccountRequest.auth.applicationId = "applicationId";
			messageFetchForAccountRequest.auth.applicationPassword = "applicationPassword";
			messageFetchForAccountRequest.auth.accountId = "accountId";

			//set up request specific parameters
			messageFetchForAccountRequest.dateSince = "datesince";
			messageFetchForAccountRequest.messageIdSince = 1L;
			messageFetchForAccountRequest.countUnreadOnly = true;
			messageFetchForAccountRequest.location = "location";
			messageFetchForAccountRequest.showSharedItems = true;
			List<string> messageTypes = new List<string>();
			string messageTypesString = "messageTypes";
			messageTypes.Add(messageTypesString);
			messageFetchForAccountRequest.messageTypes = messageTypes;

			//create the request
			string json = Utilities.buildRequestJson(messageFetchForAccountRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageFetchForAccount", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageFetchForAccountResponse messageFetchForAccountResponse = javascriptSerializer.Deserialize<MessageFetchForAccountResponse>(jsonResponse);

			Console.WriteLine(messageFetchForAccountResponse.responseCode);
			Console.WriteLine(messageFetchForAccountResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageFetchForAccountRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public long messageIdSince { get; set;}
			public bool countUnreadOnly { get; set;}
			public string location { get; set;}
			public bool showSharedItems { get; set;}
			public List<string> messageTypes { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageFetch {
			public int messageCount { get; set;}
			public List<long> messageList { get; set;}
			public string userId { get; set;}
		}

		public class MessageFetchForAccountResponse : UpdoxResponse {
			public List<MessageFetch> fetchList { get; set;}
			public int countTotal { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_MessageFetchForAccount {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageFetchForAccount codeSample = new UpdoxCodeSample_MessageFetchForAccount();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageFetchForAccount";

		MessageFetchForAccountRequest messageFetchForAccountRequest = new MessageFetchForAccountRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageFetchForAccountRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		messageFetchForAccountRequest.setDateSince(new Date());
		messageFetchForAccountRequest.setMessageIdSince(1L);
		messageFetchForAccountRequest.setCountUnreadOnly(true);
		messageFetchForAccountRequest.setLocation("location");
		messageFetchForAccountRequest.setShowSharedItems(true);
	List<String> messageTypes = new ArrayList<>();
		String messageTypesString = "messageTypes";
		messageTypes.add(messageTypesString);
		messageFetchForAccountRequest.setMessageTypes(messageTypes);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageFetchForAccountRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageFetchForAccount', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageFetchForAccountResponse messageFetchForAccountResponse = mapper.readValue(jsonResponse, MessageFetchForAccountResponse.class);

		System.out.println(messageFetchForAccountResponse.getResponseCode());
		System.out.println(messageFetchForAccountResponse.getResponseMessage());
	}

	private class MessageFetchForAccountRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private long messageIdSince;
    	private boolean countUnreadOnly;
    	private String location;
    	private boolean showSharedItems;
    	private List<String> messageTypes;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public long getMessageIdSince() {
			return messageIdSince;
		}

		public void setMessageIdSince(long messageIdSince) {
			this.messageIdSince = messageIdSince;
		}

		public boolean isCountUnreadOnly() {
			return countUnreadOnly;
		}

		public void setCountUnreadOnly(boolean countUnreadOnly) {
			this.countUnreadOnly = countUnreadOnly;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isShowSharedItems() {
			return showSharedItems;
		}

		public void setShowSharedItems(boolean showSharedItems) {
			this.showSharedItems = showSharedItems;
		}

		public List<String> getMessageTypes() {
			return messageTypes;
		}

		public void setMessageTypes(List<String> messageTypes) {
			this.messageTypes = messageTypes;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class MessageFetch {
		private int messageCount;
		private List<Long> messageList;
		private String userId;


		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<Long> getMessageList() {
			return messageList;
		}

		public void setMessageList(List<Long> messageList) {
			this.messageList = messageList;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageFetchForAccountResponse extends UpdoxResponse {
		private List<MessageFetch> fetchList;
		private int countTotal;


		public List<MessageFetch> getFetchList() {
			return fetchList;
		}

		public void setFetchList(List<MessageFetch> fetchList) {
			this.fetchList = fetchList;
		}

		public int getCountTotal() {
			return countTotal;
		}

		public void setCountTotal(int countTotal) {
			this.countTotal = countTotal;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageForward /io/MessageForward

Forward messageId to supplied recipient

Parameter	Type	Value	Description
messageId	String		The ID of the message. This is required.
messageContent	String		The content of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.
recipient	String		String value for the direct address or Internal ID of recipient. Must be either in the form of an e-mail address, or in the format of [type]:[id]. Min length 2 characters. Max length 100 characters. This is required.

Try it! Toggle Notes/Code Samples

MessageForward

Forward messageId to supplied recipient

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageForward {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageForward codeSample = new UpdoxCodeSample_MessageForward();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageForward";
			MessageForwardRequest messageForwardRequest = new MessageForwardRequest();

			//set up credentials
			messageForwardRequest.auth.applicationId = "applicationId";
			messageForwardRequest.auth.applicationPassword = "applicationPassword";
			messageForwardRequest.auth.accountId = "accountId";
			messageForwardRequest.auth.userId = "userId";

			//set up request specific parameters
			messageForwardRequest.messageId = "messageId";
			messageForwardRequest.messageContent = "messageContent";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			messageForwardRequest.attachments = attachments;
			messageForwardRequest.recipient = "recipient";

			//create the request
			string json = Utilities.buildRequestJson(messageForwardRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageForward", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageForwardResponse messageForwardResponse = javascriptSerializer.Deserialize<MessageForwardResponse>(jsonResponse);

			Console.WriteLine(messageForwardResponse.responseCode);
			Console.WriteLine(messageForwardResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageForwardRequest : UpdoxRequest {
			public string messageId { get; set;}
			public string messageContent { get; set;}
			public FileAttachment[] attachments { get; set;}
			public string recipient { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class MessageForwardResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_MessageForward {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageForward codeSample = new UpdoxCodeSample_MessageForward();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageForward";

		MessageForwardRequest messageForwardRequest = new MessageForwardRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageForwardRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageForwardRequest.setMessageId("messageId");
		messageForwardRequest.setMessageContent("messageContent");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		messageForwardRequest.setAttachments(attachments);
		messageForwardRequest.setRecipient("recipient");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageForwardRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageForward', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageForwardResponse messageForwardResponse = mapper.readValue(jsonResponse, MessageForwardResponse.class);

		System.out.println(messageForwardResponse.getResponseCode());
		System.out.println(messageForwardResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class MessageForwardRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String messageId;
    	private String messageContent;
    	private FileAttachment[] attachments;
    	private String recipient;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageContent() {
			return messageContent;
		}

		public void setMessageContent(String messageContent) {
			this.messageContent = messageContent;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageForwardResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4070`	`Invalid recipient`
`4410`	`message not found`

MessageListSince /io/MessageListSince

Returns a list of messages received since the supplied date for the authenticated user

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
dateTo	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox up to and including the current date.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based ? the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). Defaults to 50 when not provided or 0 specified. The value must be between 0 and 500.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), T (trash) or empty (for all locations). Max length 1 characters. Must be one of the following values: I, S, A, T.
listUnreadOnly	Boolean	True to return only the list of unread messages.

Try it! Toggle Notes/Code Samples

MessageListSince

Returns a list of messages received since the supplied date for the authenticated user

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageListSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageListSince codeSample = new UpdoxCodeSample_MessageListSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageListSince";
			MessageListSinceRequest messageListSinceRequest = new MessageListSinceRequest();

			//set up credentials
			messageListSinceRequest.auth.applicationId = "applicationId";
			messageListSinceRequest.auth.applicationPassword = "applicationPassword";
			messageListSinceRequest.auth.accountId = "accountId";
			messageListSinceRequest.auth.userId = "userId";

			//set up request specific parameters
			messageListSinceRequest.dateSince = "datesince";
			messageListSinceRequest.dateTo = "dateto";
			messageListSinceRequest.start = 1;
			messageListSinceRequest.count = 1;
			messageListSinceRequest.location = "location";
			messageListSinceRequest.listUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(messageListSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageListSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageListSinceResponse messageListSinceResponse = javascriptSerializer.Deserialize<MessageListSinceResponse>(jsonResponse);

			Console.WriteLine(messageListSinceResponse.responseCode);
			Console.WriteLine(messageListSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageListSinceRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public String dateTo { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
			public bool listUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public bool hasAttachments { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
		}

		public class MessageListSinceResponse : UpdoxResponse {
			public int start { get; set;}
			public int totalCount { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageListSince {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageListSince codeSample = new UpdoxCodeSample_MessageListSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageListSince";

		MessageListSinceRequest messageListSinceRequest = new MessageListSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageListSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageListSinceRequest.setDateSince(new Date());
		messageListSinceRequest.setDateTo(new Date());
		messageListSinceRequest.setStart(1);
		messageListSinceRequest.setCount(1);
		messageListSinceRequest.setLocation("location");
		messageListSinceRequest.setListUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageListSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageListSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageListSinceResponse messageListSinceResponse = mapper.readValue(jsonResponse, MessageListSinceResponse.class);

		System.out.println(messageListSinceResponse.getResponseCode());
		System.out.println(messageListSinceResponse.getResponseMessage());
	}

	private class MessageListSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private Date dateTo;
    	private int start;
    	private int count;
    	private String location;
    	private boolean listUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public Date getDateTo() {
			return dateTo;
		}

		public void setDateTo(Date dateTo) {
			this.dateTo = dateTo;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isListUnreadOnly() {
			return listUnreadOnly;
		}

		public void setListUnreadOnly(boolean listUnreadOnly) {
			this.listUnreadOnly = listUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private boolean hasAttachments;
		private String location;
		private boolean isRead;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public boolean isHasAttachments() {
			return hasAttachments;
		}

		public void setHasAttachments(boolean hasAttachments) {
			this.hasAttachments = hasAttachments;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}
	}

	private static class MessageListSinceResponse extends UpdoxResponse {
		private int start;
		private int totalCount;
		private int messageCount;
		private List<MessageObject> messages;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getTotalCount() {
			return totalCount;
		}

		public void setTotalCount(int totalCount) {
			this.totalCount = totalCount;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageListSince/1.1 /io/MessageListSince/1.1

Returns a list of messages received since the supplied date for the authenticated user

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
dateTo	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox up to and including the current date.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based ? the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). Defaults to 50 when not provided or 0 specified. The value must be between 0 and 500.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), T (trash) or empty (for all locations). Max length 1 characters. Must be one of the following values: I, S, A, T.
listUnreadOnly	Boolean	True to return only the list of unread messages.

Try it! Toggle Notes/Code Samples

MessageListSince/1.1

Returns a list of messages received since the supplied date for the authenticated user

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageListSince1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageListSince1_1 codeSample = new UpdoxCodeSample_MessageListSince1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageListSince1_1";
			MessageListSince1_1Request messageListSince1_1Request = new MessageListSince1_1Request();

			//set up credentials
			messageListSince1_1Request.auth.applicationId = "applicationId";
			messageListSince1_1Request.auth.applicationPassword = "applicationPassword";
			messageListSince1_1Request.auth.accountId = "accountId";
			messageListSince1_1Request.auth.userId = "userId";

			//set up request specific parameters
			messageListSince1_1Request.dateSince = "datesince";
			messageListSince1_1Request.dateTo = "dateto";
			messageListSince1_1Request.start = 1;
			messageListSince1_1Request.count = 1;
			messageListSince1_1Request.location = "location";
			messageListSince1_1Request.listUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(messageListSince1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageListSince/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageListSince1_1Response messageListSince1_1Response = javascriptSerializer.Deserialize<MessageListSince1_1Response>(jsonResponse);

			Console.WriteLine(messageListSince1_1Response.responseCode);
			Console.WriteLine(messageListSince1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageListSince1_1Request : UpdoxRequest {
			public String dateSince { get; set;}
			public String dateTo { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
			public bool listUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public bool hasAttachments { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
		}

		public class MessageListSince1_1Response : UpdoxResponse {
			public int start { get; set;}
			public int totalCount { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageListSince1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageListSince1_1 codeSample = new UpdoxCodeSample_MessageListSince1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageListSince1_1";

		MessageListSince1_1Request messageListSince1_1Request = new MessageListSince1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageListSince1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageListSince1_1Request.setDateSince(new Date());
		messageListSince1_1Request.setDateTo(new Date());
		messageListSince1_1Request.setStart(1);
		messageListSince1_1Request.setCount(1);
		messageListSince1_1Request.setLocation("location");
		messageListSince1_1Request.setListUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageListSince1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageListSince/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageListSince1_1Response messageListSince1_1Response = mapper.readValue(jsonResponse, MessageListSince1_1Response.class);

		System.out.println(messageListSince1_1Response.getResponseCode());
		System.out.println(messageListSince1_1Response.getResponseMessage());
	}

	private class MessageListSince1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private Date dateTo;
    	private int start;
    	private int count;
    	private String location;
    	private boolean listUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public Date getDateTo() {
			return dateTo;
		}

		public void setDateTo(Date dateTo) {
			this.dateTo = dateTo;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isListUnreadOnly() {
			return listUnreadOnly;
		}

		public void setListUnreadOnly(boolean listUnreadOnly) {
			this.listUnreadOnly = listUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private boolean hasAttachments;
		private String location;
		private boolean isRead;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public boolean isHasAttachments() {
			return hasAttachments;
		}

		public void setHasAttachments(boolean hasAttachments) {
			this.hasAttachments = hasAttachments;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}
	}

	private static class MessageListSince1_1Response extends UpdoxResponse {
		private int start;
		private int totalCount;
		private int messageCount;
		private List<MessageObject> messages;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getTotalCount() {
			return totalCount;
		}

		public void setTotalCount(int totalCount) {
			this.totalCount = totalCount;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageListSince/1.2 /io/MessageListSince/1.2

Returns a list of messages received since the supplied date for the authenticated user. This version adds a flag to the response indicating whether more results are available.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
dateTo	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox up to and including the current date.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based ? the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). Defaults to 50 when not provided or 0 specified. The value must be between 0 and 500.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), T (trash) or empty (for all locations). Max length 1 characters. Must be one of the following values: I, S, A, T.
listUnreadOnly	Boolean	True to return only the list of unread messages.

Try it! Toggle Notes/Code Samples

MessageListSince/1.2

Returns a list of messages received since the supplied date for the authenticated user. This version adds a flag to the response indicating whether more results are available.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageListSince1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageListSince1_2 codeSample = new UpdoxCodeSample_MessageListSince1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageListSince1_2";
			MessageListSince1_2Request messageListSince1_2Request = new MessageListSince1_2Request();

			//set up credentials
			messageListSince1_2Request.auth.applicationId = "applicationId";
			messageListSince1_2Request.auth.applicationPassword = "applicationPassword";
			messageListSince1_2Request.auth.accountId = "accountId";
			messageListSince1_2Request.auth.userId = "userId";

			//set up request specific parameters
			messageListSince1_2Request.dateSince = "datesince";
			messageListSince1_2Request.dateTo = "dateto";
			messageListSince1_2Request.start = 1;
			messageListSince1_2Request.count = 1;
			messageListSince1_2Request.location = "location";
			messageListSince1_2Request.listUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(messageListSince1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageListSince/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageListSince1_2Response messageListSince1_2Response = javascriptSerializer.Deserialize<MessageListSince1_2Response>(jsonResponse);

			Console.WriteLine(messageListSince1_2Response.responseCode);
			Console.WriteLine(messageListSince1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageListSince1_2Request : UpdoxRequest {
			public String dateSince { get; set;}
			public String dateTo { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
			public bool listUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public bool hasAttachments { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
		}

		public class MessageListSince1_2Response : UpdoxResponse {
			public int start { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
			public bool moreResultsAvailable { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageListSince1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageListSince1_2 codeSample = new UpdoxCodeSample_MessageListSince1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageListSince1_2";

		MessageListSince1_2Request messageListSince1_2Request = new MessageListSince1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageListSince1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageListSince1_2Request.setDateSince(new Date());
		messageListSince1_2Request.setDateTo(new Date());
		messageListSince1_2Request.setStart(1);
		messageListSince1_2Request.setCount(1);
		messageListSince1_2Request.setLocation("location");
		messageListSince1_2Request.setListUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageListSince1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageListSince/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageListSince1_2Response messageListSince1_2Response = mapper.readValue(jsonResponse, MessageListSince1_2Response.class);

		System.out.println(messageListSince1_2Response.getResponseCode());
		System.out.println(messageListSince1_2Response.getResponseMessage());
	}

	private class MessageListSince1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private Date dateTo;
    	private int start;
    	private int count;
    	private String location;
    	private boolean listUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public Date getDateTo() {
			return dateTo;
		}

		public void setDateTo(Date dateTo) {
			this.dateTo = dateTo;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isListUnreadOnly() {
			return listUnreadOnly;
		}

		public void setListUnreadOnly(boolean listUnreadOnly) {
			this.listUnreadOnly = listUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private boolean hasAttachments;
		private String location;
		private boolean isRead;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public boolean isHasAttachments() {
			return hasAttachments;
		}

		public void setHasAttachments(boolean hasAttachments) {
			this.hasAttachments = hasAttachments;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}
	}

	private static class MessageListSince1_2Response extends UpdoxResponse {
		private int start;
		private int messageCount;
		private List<MessageObject> messages;
		private boolean moreResultsAvailable;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}

		public boolean isMoreResultsAvailable() {
			return moreResultsAvailable;
		}

		public void setMoreResultsAvailable(boolean moreResultsAvailable) {
			this.moreResultsAvailable = moreResultsAvailable;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageListSince/1.3 /io/MessageListSince/1.3

Returns a list of messages received since the supplied date for the authenticated user. This version replaces the hasAttachments flag with an attachments array containing metadata.

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
dateTo	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox up to and including the current date.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based ? the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). Defaults to 50 when not provided or 0 specified. The value must be between 0 and 500.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), T (trash) or empty (for all locations). Max length 1 characters. Must be one of the following values: I, S, A, T.
listUnreadOnly	Boolean	True to return only the list of unread messages.

Try it! Toggle Notes/Code Samples

MessageListSince/1.3

Returns a list of messages received since the supplied date for the authenticated user. This version replaces the hasAttachments flag with an attachments array containing metadata.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageListSince1_3 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageListSince1_3 codeSample = new UpdoxCodeSample_MessageListSince1_3();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageListSince1_3";
			MessageListSince1_3Request messageListSince1_3Request = new MessageListSince1_3Request();

			//set up credentials
			messageListSince1_3Request.auth.applicationId = "applicationId";
			messageListSince1_3Request.auth.applicationPassword = "applicationPassword";
			messageListSince1_3Request.auth.accountId = "accountId";
			messageListSince1_3Request.auth.userId = "userId";

			//set up request specific parameters
			messageListSince1_3Request.dateSince = "datesince";
			messageListSince1_3Request.dateTo = "dateto";
			messageListSince1_3Request.start = 1;
			messageListSince1_3Request.count = 1;
			messageListSince1_3Request.location = "location";
			messageListSince1_3Request.listUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(messageListSince1_3Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageListSince/1.3", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageListSince1_3Response messageListSince1_3Response = javascriptSerializer.Deserialize<MessageListSince1_3Response>(jsonResponse);

			Console.WriteLine(messageListSince1_3Response.responseCode);
			Console.WriteLine(messageListSince1_3Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageListSince1_3Request : UpdoxRequest {
			public String dateSince { get; set;}
			public String dateTo { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
			public bool listUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
			public Collection attachments { get; set;}
		}

		public class MessageListSince1_3Response : UpdoxResponse {
			public int start { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
			public bool moreResultsAvailable { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageListSince1_3 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageListSince1_3 codeSample = new UpdoxCodeSample_MessageListSince1_3();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageListSince1_3";

		MessageListSince1_3Request messageListSince1_3Request = new MessageListSince1_3Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageListSince1_3Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageListSince1_3Request.setDateSince(new Date());
		messageListSince1_3Request.setDateTo(new Date());
		messageListSince1_3Request.setStart(1);
		messageListSince1_3Request.setCount(1);
		messageListSince1_3Request.setLocation("location");
		messageListSince1_3Request.setListUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageListSince1_3Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageListSince/1.3', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageListSince1_3Response messageListSince1_3Response = mapper.readValue(jsonResponse, MessageListSince1_3Response.class);

		System.out.println(messageListSince1_3Response.getResponseCode());
		System.out.println(messageListSince1_3Response.getResponseMessage());
	}

	private class MessageListSince1_3Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private Date dateTo;
    	private int start;
    	private int count;
    	private String location;
    	private boolean listUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public Date getDateTo() {
			return dateTo;
		}

		public void setDateTo(Date dateTo) {
			this.dateTo = dateTo;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isListUnreadOnly() {
			return listUnreadOnly;
		}

		public void setListUnreadOnly(boolean listUnreadOnly) {
			this.listUnreadOnly = listUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private String location;
		private boolean isRead;
		private Collection attachments;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}

		public Collection getAttachments() {
			return attachments;
		}

		public void setAttachments(Collection attachments) {
			this.attachments = attachments;
		}
	}

	private static class MessageListSince1_3Response extends UpdoxResponse {
		private int start;
		private int messageCount;
		private List<MessageObject> messages;
		private boolean moreResultsAvailable;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}

		public boolean isMoreResultsAvailable() {
			return moreResultsAvailable;
		}

		public void setMoreResultsAvailable(boolean moreResultsAvailable) {
			this.moreResultsAvailable = moreResultsAvailable;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

MessageMark /io/MessageMark

Marks a single message with the supplied marks.

Parameter	Type	Description
ipAddress	String	Optional: sets the IP required to use this token. Max length 100 characters.
timeout	Int	Optional: sets the time to timeout this token in seconds. Max value is 3600 (1 hour). Default is 600 (10 minutes). The value must be between 0 and 3600.
metadata	String	The metadata associated with this SSO attempt. Used for vendor information only.
messageId	Long	The ID of the message to mark. This is required.
read	Boolean	True to mark the message as read, false to mark the message as unread. This is required.

Try it! Toggle Notes/Code Samples

MessageMark

Marks a single message with the supplied marks.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageMark {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageMark codeSample = new UpdoxCodeSample_MessageMark();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageMark";
			MessageMarkRequest messageMarkRequest = new MessageMarkRequest();

			//set up credentials
			messageMarkRequest.auth.applicationId = "applicationId";
			messageMarkRequest.auth.applicationPassword = "applicationPassword";
			messageMarkRequest.auth.accountId = "accountId";
			messageMarkRequest.auth.userId = "userId";

			//set up request specific parameters
			messageMarkRequest.ipAddress = "ipAddress";
			messageMarkRequest.timeout = 1;
			messageMarkRequest.metadata = "metadata";
			messageMarkRequest.messageId = 1L;
			messageMarkRequest.read = true;

			//create the request
			string json = Utilities.buildRequestJson(messageMarkRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageMark", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageMarkResponse messageMarkResponse = javascriptSerializer.Deserialize<MessageMarkResponse>(jsonResponse);

			Console.WriteLine(messageMarkResponse.responseCode);
			Console.WriteLine(messageMarkResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageMarkRequest : UpdoxRequest {
			public string ipAddress { get; set;}
			public int timeout { get; set;}
			public string metadata { get; set;}
			public long messageId { get; set;}
			public bool read { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageMarkResponse : UpdoxResponse {
			public long messageId { get; set;}
			public bool read { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MessageMark {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageMark codeSample = new UpdoxCodeSample_MessageMark();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageMark";

		MessageMarkRequest messageMarkRequest = new MessageMarkRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageMarkRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageMarkRequest.setIpAddress("ipAddress");
		messageMarkRequest.setTimeout(1);
		messageMarkRequest.setMetadata("metadata");
		messageMarkRequest.setMessageId(1L);
		messageMarkRequest.setRead(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageMarkRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageMark', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageMarkResponse messageMarkResponse = mapper.readValue(jsonResponse, MessageMarkResponse.class);

		System.out.println(messageMarkResponse.getResponseCode());
		System.out.println(messageMarkResponse.getResponseMessage());
	}

	private class MessageMarkRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ipAddress;
    	private int timeout;
    	private String metadata;
    	private long messageId;
    	private boolean read;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public int getTimeout() {
			return timeout;
		}

		public void setTimeout(int timeout) {
			this.timeout = timeout;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isRead() {
			return read;
		}

		public void setRead(boolean read) {
			this.read = read;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageMarkResponse extends UpdoxResponse {
		private long messageId;
		private boolean read;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isRead() {
			return read;
		}

		public void setRead(boolean read) {
			this.read = read;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageMove /io/MessageMove

Moves a single message to the supplied location

Parameter	Type	Description
ipAddress	String	Optional: sets the IP required to use this token. Max length 100 characters.
timeout	Int	Optional: sets the time to timeout this token in seconds. Max value is 3600 (1 hour). Default is 600 (10 minutes). The value must be between 0 and 3600.
metadata	String	The metadata associated with this SSO attempt. Used for vendor information only.
messageId	Long	The ID of the message to move. This is required.
location	String	The location to move the message to. Location must be I (inbox), S (sent), A (archive), or T (trash). Max length 1 characters. Must be one of the following values: I, S, A, T. This is required.

Try it! Toggle Notes/Code Samples

MessageMove

Moves a single message to the supplied location

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageMove {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageMove codeSample = new UpdoxCodeSample_MessageMove();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageMove";
			MessageMoveRequest messageMoveRequest = new MessageMoveRequest();

			//set up credentials
			messageMoveRequest.auth.applicationId = "applicationId";
			messageMoveRequest.auth.applicationPassword = "applicationPassword";
			messageMoveRequest.auth.accountId = "accountId";
			messageMoveRequest.auth.userId = "userId";

			//set up request specific parameters
			messageMoveRequest.ipAddress = "ipAddress";
			messageMoveRequest.timeout = 1;
			messageMoveRequest.metadata = "metadata";
			messageMoveRequest.messageId = 1L;
			messageMoveRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(messageMoveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageMove", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageMoveResponse messageMoveResponse = javascriptSerializer.Deserialize<MessageMoveResponse>(jsonResponse);

			Console.WriteLine(messageMoveResponse.responseCode);
			Console.WriteLine(messageMoveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageMoveRequest : UpdoxRequest {
			public string ipAddress { get; set;}
			public int timeout { get; set;}
			public string metadata { get; set;}
			public long messageId { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageMoveResponse : UpdoxResponse {
			public long messageId { get; set;}
			public string newLocation { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_MessageMove {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageMove codeSample = new UpdoxCodeSample_MessageMove();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageMove";

		MessageMoveRequest messageMoveRequest = new MessageMoveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageMoveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageMoveRequest.setIpAddress("ipAddress");
		messageMoveRequest.setTimeout(1);
		messageMoveRequest.setMetadata("metadata");
		messageMoveRequest.setMessageId(1L);
		messageMoveRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageMoveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageMove', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageMoveResponse messageMoveResponse = mapper.readValue(jsonResponse, MessageMoveResponse.class);

		System.out.println(messageMoveResponse.getResponseCode());
		System.out.println(messageMoveResponse.getResponseMessage());
	}

	private class MessageMoveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ipAddress;
    	private int timeout;
    	private String metadata;
    	private long messageId;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public int getTimeout() {
			return timeout;
		}

		public void setTimeout(int timeout) {
			this.timeout = timeout;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageMoveResponse extends UpdoxResponse {
		private long messageId;
		private String newLocation;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getNewLocation() {
			return newLocation;
		}

		public void setNewLocation(String newLocation) {
			this.newLocation = newLocation;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageReply /io/MessageReply

Send reply to supplied messageId

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
messageId	String		The ID of the message. This is required.
messageContent	String		The content of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

MessageReply

Send reply to supplied messageId

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageReply {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageReply codeSample = new UpdoxCodeSample_MessageReply();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageReply";
			MessageReplyRequest messageReplyRequest = new MessageReplyRequest();

			//set up credentials
			messageReplyRequest.auth.applicationId = "applicationId";
			messageReplyRequest.auth.applicationPassword = "applicationPassword";
			messageReplyRequest.auth.accountId = "accountId";
			messageReplyRequest.auth.userId = "userId";

			//set up request specific parameters
			messageReplyRequest.messageId = "messageId";
			messageReplyRequest.messageContent = "messageContent";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			messageReplyRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(messageReplyRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageReply", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageReplyResponse messageReplyResponse = javascriptSerializer.Deserialize<MessageReplyResponse>(jsonResponse);

			Console.WriteLine(messageReplyResponse.responseCode);
			Console.WriteLine(messageReplyResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageReplyRequest : UpdoxRequest {
			public string messageId { get; set;}
			public string messageContent { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class MessageReplyResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_MessageReply {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageReply codeSample = new UpdoxCodeSample_MessageReply();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageReply";

		MessageReplyRequest messageReplyRequest = new MessageReplyRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageReplyRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageReplyRequest.setMessageId("messageId");
		messageReplyRequest.setMessageContent("messageContent");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		messageReplyRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageReplyRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageReply', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageReplyResponse messageReplyResponse = mapper.readValue(jsonResponse, MessageReplyResponse.class);

		System.out.println(messageReplyResponse.getResponseCode());
		System.out.println(messageReplyResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class MessageReplyRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String messageId;
    	private String messageContent;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageContent() {
			return messageContent;
		}

		public void setMessageContent(String messageContent) {
			this.messageContent = messageContent;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageReplyResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4331`	`contact does not exist`
`4070`	`Invalid recipient`
`4410`	`message not found`

MessageReply/1.1 /io/MessageReply/1.1

Send reply to supplied messageId

Parameter	Type	Value	Description
messageId	String		The ID of the message. This is required.
messageContent	String		The content of the message.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

MessageReply/1.1

Send reply to supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageReply1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageReply1_1 codeSample = new UpdoxCodeSample_MessageReply1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageReply1_1";
			MessageReply1_1Request messageReply1_1Request = new MessageReply1_1Request();

			//set up credentials
			messageReply1_1Request.auth.applicationId = "applicationId";
			messageReply1_1Request.auth.applicationPassword = "applicationPassword";
			messageReply1_1Request.auth.accountId = "accountId";
			messageReply1_1Request.auth.userId = "userId";

			//set up request specific parameters
			messageReply1_1Request.messageId = "messageId";
			messageReply1_1Request.messageContent = "messageContent";
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			messageReply1_1Request.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(messageReply1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageReply/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageReply1_1Response messageReply1_1Response = javascriptSerializer.Deserialize<MessageReply1_1Response>(jsonResponse);

			Console.WriteLine(messageReply1_1Response.responseCode);
			Console.WriteLine(messageReply1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageReply1_1Request : UpdoxRequest {
			public string messageId { get; set;}
			public string messageContent { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageReply1_1Response : UpdoxResponse {
			public long messageId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_MessageReply1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageReply1_1 codeSample = new UpdoxCodeSample_MessageReply1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageReply1_1";

		MessageReply1_1Request messageReply1_1Request = new MessageReply1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageReply1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageReply1_1Request.setMessageId("messageId");
		messageReply1_1Request.setMessageContent("messageContent");
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		messageReply1_1Request.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageReply1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageReply/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageReply1_1Response messageReply1_1Response = mapper.readValue(jsonResponse, MessageReply1_1Response.class);

		System.out.println(messageReply1_1Response.getResponseCode());
		System.out.println(messageReply1_1Response.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class MessageReply1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String messageId;
    	private String messageContent;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getMessageContent() {
			return messageContent;
		}

		public void setMessageContent(String messageContent) {
			this.messageContent = messageContent;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageReply1_1Response extends UpdoxResponse {
		private long messageId;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4331`	`contact does not exist`
`4070`	`Invalid recipient`
`4410`	`message not found`

MessageRetrieve /io/MessageRetrieve

Retrieves a single message based on the supplied messageId

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieve

Retrieves a single message based on the supplied messageId

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieve codeSample = new UpdoxCodeSample_MessageRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieve";
			MessageRetrieveRequest messageRetrieveRequest = new MessageRetrieveRequest();

			//set up credentials
			messageRetrieveRequest.auth.applicationId = "applicationId";
			messageRetrieveRequest.auth.applicationPassword = "applicationPassword";
			messageRetrieveRequest.auth.accountId = "accountId";
			messageRetrieveRequest.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieveRequest.messageId = 1L;
			messageRetrieveRequest.markRead = true;
			messageRetrieveRequest.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieveResponse messageRetrieveResponse = javascriptSerializer.Deserialize<MessageRetrieveResponse>(jsonResponse);

			Console.WriteLine(messageRetrieveResponse.responseCode);
			Console.WriteLine(messageRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieveRequest : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageRetrieveResponse : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieve codeSample = new UpdoxCodeSample_MessageRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieve";

		MessageRetrieveRequest messageRetrieveRequest = new MessageRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieveRequest.setMessageId(1L);
		messageRetrieveRequest.setMarkRead(true);
		messageRetrieveRequest.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieveResponse messageRetrieveResponse = mapper.readValue(jsonResponse, MessageRetrieveResponse.class);

		System.out.println(messageRetrieveResponse.getResponseCode());
		System.out.println(messageRetrieveResponse.getResponseMessage());
	}

	private class MessageRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class MessageRetrieveResponse extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageRetrieve/1.1 /io/MessageRetrieve/1.1

Retrieves a single message based on the supplied messageId. This differs from the original MessageRetrieve api because it returns the external id of the user as userId:# instead of member:#

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieve/1.1

Retrieves a single message based on the supplied messageId. This differs from the original MessageRetrieve api because it returns the external id of the user as userId:# instead of member:#

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieve1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieve1_1 codeSample = new UpdoxCodeSample_MessageRetrieve1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieve1_1";
			MessageRetrieve1_1Request messageRetrieve1_1Request = new MessageRetrieve1_1Request();

			//set up credentials
			messageRetrieve1_1Request.auth.applicationId = "applicationId";
			messageRetrieve1_1Request.auth.applicationPassword = "applicationPassword";
			messageRetrieve1_1Request.auth.accountId = "accountId";
			messageRetrieve1_1Request.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieve1_1Request.messageId = 1L;
			messageRetrieve1_1Request.markRead = true;
			messageRetrieve1_1Request.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieve1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieve/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieve1_1Response messageRetrieve1_1Response = javascriptSerializer.Deserialize<MessageRetrieve1_1Response>(jsonResponse);

			Console.WriteLine(messageRetrieve1_1Response.responseCode);
			Console.WriteLine(messageRetrieve1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieve1_1Request : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageRetrieve1_1Response : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieve1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieve1_1 codeSample = new UpdoxCodeSample_MessageRetrieve1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieve1_1";

		MessageRetrieve1_1Request messageRetrieve1_1Request = new MessageRetrieve1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieve1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieve1_1Request.setMessageId(1L);
		messageRetrieve1_1Request.setMarkRead(true);
		messageRetrieve1_1Request.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieve1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieve/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieve1_1Response messageRetrieve1_1Response = mapper.readValue(jsonResponse, MessageRetrieve1_1Response.class);

		System.out.println(messageRetrieve1_1Response.getResponseCode());
		System.out.println(messageRetrieve1_1Response.getResponseMessage());
	}

	private class MessageRetrieve1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class MessageRetrieve1_1Response extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageRetrieve/1.2 /io/MessageRetrieve/1.2

Retrieves a single message based on the supplied messageId. This differs from the original MessageRetrieve api because it returns the external patient ID of the patient as patientId:# instead of contactId:#. Additionally, it will also return the external id of the user as userId:# instead of member:#

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieve/1.2

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieve1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieve1_2 codeSample = new UpdoxCodeSample_MessageRetrieve1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieve1_2";
			MessageRetrieve1_2Request messageRetrieve1_2Request = new MessageRetrieve1_2Request();

			//set up credentials
			messageRetrieve1_2Request.auth.applicationId = "applicationId";
			messageRetrieve1_2Request.auth.applicationPassword = "applicationPassword";
			messageRetrieve1_2Request.auth.accountId = "accountId";
			messageRetrieve1_2Request.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieve1_2Request.messageId = 1L;
			messageRetrieve1_2Request.markRead = true;
			messageRetrieve1_2Request.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieve1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieve/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieve1_2Response messageRetrieve1_2Response = javascriptSerializer.Deserialize<MessageRetrieve1_2Response>(jsonResponse);

			Console.WriteLine(messageRetrieve1_2Response.responseCode);
			Console.WriteLine(messageRetrieve1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieve1_2Request : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageRetrieve1_2Response : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieve1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieve1_2 codeSample = new UpdoxCodeSample_MessageRetrieve1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieve1_2";

		MessageRetrieve1_2Request messageRetrieve1_2Request = new MessageRetrieve1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieve1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieve1_2Request.setMessageId(1L);
		messageRetrieve1_2Request.setMarkRead(true);
		messageRetrieve1_2Request.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieve1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieve/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieve1_2Response messageRetrieve1_2Response = mapper.readValue(jsonResponse, MessageRetrieve1_2Response.class);

		System.out.println(messageRetrieve1_2Response.getResponseCode());
		System.out.println(messageRetrieve1_2Response.getResponseMessage());
	}

	private class MessageRetrieve1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class MessageRetrieve1_2Response extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageRetrieve/1.3 /io/MessageRetrieve/1.3

Retrieves a single message based on the supplied messageId. It returns

Change from v1.0 to v1.1: The external id of the user as userId:# instead of member:#.
Change from v1.1 to v1.2: The external patient ID of the patient as patientId:# instead of contactId:#.
Change from v1.2 to v1.3: The received timestamp when the message was created instead of last modified.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieve/1.3

Retrieves a single message based on the supplied messageId. It returns

Change from v1.0 to v1.1: The external id of the user as userId:# instead of member:#.
Change from v1.1 to v1.2: The external patient ID of the patient as patientId:# instead of contactId:#.
Change from v1.2 to v1.3: The received timestamp when the message was created instead of last modified.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieve1_3 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieve1_3 codeSample = new UpdoxCodeSample_MessageRetrieve1_3();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieve1_3";
			MessageRetrieve1_3Request messageRetrieve1_3Request = new MessageRetrieve1_3Request();

			//set up credentials
			messageRetrieve1_3Request.auth.applicationId = "applicationId";
			messageRetrieve1_3Request.auth.applicationPassword = "applicationPassword";
			messageRetrieve1_3Request.auth.accountId = "accountId";
			messageRetrieve1_3Request.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieve1_3Request.messageId = 1L;
			messageRetrieve1_3Request.markRead = true;
			messageRetrieve1_3Request.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieve1_3Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieve/1.3", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieve1_3Response messageRetrieve1_3Response = javascriptSerializer.Deserialize<MessageRetrieve1_3Response>(jsonResponse);

			Console.WriteLine(messageRetrieve1_3Response.responseCode);
			Console.WriteLine(messageRetrieve1_3Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieve1_3Request : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class MessageRetrieve1_3Response : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieve1_3 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieve1_3 codeSample = new UpdoxCodeSample_MessageRetrieve1_3();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieve1_3";

		MessageRetrieve1_3Request messageRetrieve1_3Request = new MessageRetrieve1_3Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieve1_3Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieve1_3Request.setMessageId(1L);
		messageRetrieve1_3Request.setMarkRead(true);
		messageRetrieve1_3Request.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieve1_3Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieve/1.3', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieve1_3Response messageRetrieve1_3Response = mapper.readValue(jsonResponse, MessageRetrieve1_3Response.class);

		System.out.println(messageRetrieve1_3Response.getResponseCode());
		System.out.println(messageRetrieve1_3Response.getResponseMessage());
	}

	private class MessageRetrieve1_3Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class MessageRetrieve1_3Response extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageRetrieveWithAttachmentID /io/MessageRetrieveWithAttachmentID

Retrieves a single message based on the supplied messageId with the attachment id(s) instead of attachment content. Note that this API does not work with form data, e.g. when the response has a type = form. To retrieve form data, use the newest /MessageRetrieve/VERSION endpoint.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieveWithAttachmentID

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieveWithAttachmentID {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieveWithAttachmentID codeSample = new UpdoxCodeSample_MessageRetrieveWithAttachmentID();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieveWithAttachmentID";
			MessageRetrieveWithAttachmentIDRequest messageRetrieveWithAttachmentIDRequest = new MessageRetrieveWithAttachmentIDRequest();

			//set up credentials
			messageRetrieveWithAttachmentIDRequest.auth.applicationId = "applicationId";
			messageRetrieveWithAttachmentIDRequest.auth.applicationPassword = "applicationPassword";
			messageRetrieveWithAttachmentIDRequest.auth.accountId = "accountId";
			messageRetrieveWithAttachmentIDRequest.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieveWithAttachmentIDRequest.messageId = 1L;
			messageRetrieveWithAttachmentIDRequest.markRead = true;
			messageRetrieveWithAttachmentIDRequest.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieveWithAttachmentIDRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieveWithAttachmentID", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieveWithAttachmentIDResponse messageRetrieveWithAttachmentIDResponse = javascriptSerializer.Deserialize<MessageRetrieveWithAttachmentIDResponse>(jsonResponse);

			Console.WriteLine(messageRetrieveWithAttachmentIDResponse.responseCode);
			Console.WriteLine(messageRetrieveWithAttachmentIDResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieveWithAttachmentIDRequest : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public long id { get; set;}
			public string name { get; set;}
			public string mimeType { get; set;}
		}

		public class MessageRetrieveWithAttachmentIDResponse : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public bool read { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieveWithAttachmentID {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieveWithAttachmentID codeSample = new UpdoxCodeSample_MessageRetrieveWithAttachmentID();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieveWithAttachmentID";

		MessageRetrieveWithAttachmentIDRequest messageRetrieveWithAttachmentIDRequest = new MessageRetrieveWithAttachmentIDRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieveWithAttachmentIDRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieveWithAttachmentIDRequest.setMessageId(1L);
		messageRetrieveWithAttachmentIDRequest.setMarkRead(true);
		messageRetrieveWithAttachmentIDRequest.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieveWithAttachmentIDRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieveWithAttachmentID', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieveWithAttachmentIDResponse messageRetrieveWithAttachmentIDResponse = mapper.readValue(jsonResponse, MessageRetrieveWithAttachmentIDResponse.class);

		System.out.println(messageRetrieveWithAttachmentIDResponse.getResponseCode());
		System.out.println(messageRetrieveWithAttachmentIDResponse.getResponseMessage());
	}

	private class MessageRetrieveWithAttachmentIDRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private long id;
		private String name;
		private String mimeType;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}
	}

	private static class MessageRetrieveWithAttachmentIDResponse extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private boolean read;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public boolean isRead() {
			return read;
		}

		public void setRead(boolean read) {
			this.read = read;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

MessageRetrieveWithAttachmentID/1.1 /io/MessageRetrieveWithAttachmentID/1.1

Change from v1.0 to v1.1: The received timestamp when the message was created instead of last modified.

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is false.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

MessageRetrieveWithAttachmentID/1.1

Change from v1.0 to v1.1: The received timestamp when the message was created instead of last modified.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1 codeSample = new UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MessageRetrieveWithAttachmentID1_1";
			MessageRetrieveWithAttachmentID1_1Request messageRetrieveWithAttachmentID1_1Request = new MessageRetrieveWithAttachmentID1_1Request();

			//set up credentials
			messageRetrieveWithAttachmentID1_1Request.auth.applicationId = "applicationId";
			messageRetrieveWithAttachmentID1_1Request.auth.applicationPassword = "applicationPassword";
			messageRetrieveWithAttachmentID1_1Request.auth.accountId = "accountId";
			messageRetrieveWithAttachmentID1_1Request.auth.userId = "userId";

			//set up request specific parameters
			messageRetrieveWithAttachmentID1_1Request.messageId = 1L;
			messageRetrieveWithAttachmentID1_1Request.markRead = true;
			messageRetrieveWithAttachmentID1_1Request.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(messageRetrieveWithAttachmentID1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MessageRetrieveWithAttachmentID/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MessageRetrieveWithAttachmentID1_1Response messageRetrieveWithAttachmentID1_1Response = javascriptSerializer.Deserialize<MessageRetrieveWithAttachmentID1_1Response>(jsonResponse);

			Console.WriteLine(messageRetrieveWithAttachmentID1_1Response.responseCode);
			Console.WriteLine(messageRetrieveWithAttachmentID1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class MessageRetrieveWithAttachmentID1_1Request : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public long id { get; set;}
			public string name { get; set;}
			public string mimeType { get; set;}
		}

		public class MessageRetrieveWithAttachmentID1_1Response : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public bool read { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1 codeSample = new UpdoxCodeSample_MessageRetrieveWithAttachmentID1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MessageRetrieveWithAttachmentID1_1";

		MessageRetrieveWithAttachmentID1_1Request messageRetrieveWithAttachmentID1_1Request = new MessageRetrieveWithAttachmentID1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = messageRetrieveWithAttachmentID1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		messageRetrieveWithAttachmentID1_1Request.setMessageId(1L);
		messageRetrieveWithAttachmentID1_1Request.setMarkRead(true);
		messageRetrieveWithAttachmentID1_1Request.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(messageRetrieveWithAttachmentID1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MessageRetrieveWithAttachmentID/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MessageRetrieveWithAttachmentID1_1Response messageRetrieveWithAttachmentID1_1Response = mapper.readValue(jsonResponse, MessageRetrieveWithAttachmentID1_1Response.class);

		System.out.println(messageRetrieveWithAttachmentID1_1Response.getResponseCode());
		System.out.println(messageRetrieveWithAttachmentID1_1Response.getResponseMessage());
	}

	private class MessageRetrieveWithAttachmentID1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private long id;
		private String name;
		private String mimeType;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}
	}

	private static class MessageRetrieveWithAttachmentID1_1Response extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private boolean read;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public boolean isRead() {
			return read;
		}

		public void setRead(boolean read) {
			this.read = read;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4410`	`message not found`

PatientMessageCountSince /io/PatientMessageCountSince

Returns a count of messages for the supplied patient, received since the supplied date

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned count indicates the total number of messages in the inbox.
countUnreadOnly	Boolean	True to return only the count of unread messages.
patientId	String	The ID of the patient. This is required.

Try it! Toggle Notes/Code Samples

PatientMessageCountSince

Returns a count of messages for the supplied patient, received since the supplied date

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientMessageCountSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientMessageCountSince codeSample = new UpdoxCodeSample_PatientMessageCountSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientMessageCountSince";
			PatientMessageCountSinceRequest patientMessageCountSinceRequest = new PatientMessageCountSinceRequest();

			//set up credentials
			patientMessageCountSinceRequest.auth.applicationId = "applicationId";
			patientMessageCountSinceRequest.auth.applicationPassword = "applicationPassword";
			patientMessageCountSinceRequest.auth.accountId = "accountId";

			//set up request specific parameters
			patientMessageCountSinceRequest.dateSince = "datesince";
			patientMessageCountSinceRequest.countUnreadOnly = true;
			patientMessageCountSinceRequest.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(patientMessageCountSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientMessageCountSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientMessageCountSinceResponse patientMessageCountSinceResponse = javascriptSerializer.Deserialize<PatientMessageCountSinceResponse>(jsonResponse);

			Console.WriteLine(patientMessageCountSinceResponse.responseCode);
			Console.WriteLine(patientMessageCountSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PatientMessageCountSinceRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public bool countUnreadOnly { get; set;}
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Map {
		}

		public class PatientMessageCountSinceResponse : UpdoxResponse {
			public List<Map> records { get; set;}
			public int count { get; set;}
			public List<Map> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_PatientMessageCountSince {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientMessageCountSince codeSample = new UpdoxCodeSample_PatientMessageCountSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientMessageCountSince";

		PatientMessageCountSinceRequest patientMessageCountSinceRequest = new PatientMessageCountSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientMessageCountSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		patientMessageCountSinceRequest.setDateSince(new Date());
		patientMessageCountSinceRequest.setCountUnreadOnly(true);
		patientMessageCountSinceRequest.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientMessageCountSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientMessageCountSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientMessageCountSinceResponse patientMessageCountSinceResponse = mapper.readValue(jsonResponse, PatientMessageCountSinceResponse.class);

		System.out.println(patientMessageCountSinceResponse.getResponseCode());
		System.out.println(patientMessageCountSinceResponse.getResponseMessage());
	}

	private class PatientMessageCountSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private boolean countUnreadOnly;
    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public boolean isCountUnreadOnly() {
			return countUnreadOnly;
		}

		public void setCountUnreadOnly(boolean countUnreadOnly) {
			this.countUnreadOnly = countUnreadOnly;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Map {

	}

	private static class PatientMessageCountSinceResponse extends UpdoxResponse {
		private List<Map> records;
		private int count;
		private List<Map> locations;


		public List<Map> getRecords() {
			return records;
		}

		public void setRecords(List<Map> records) {
			this.records = records;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public List<Map> getLocations() {
			return locations;
		}

		public void setLocations(List<Map> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PatientMessageListSince /io/PatientMessageListSince

Returns a list of messages for the supplied patient id, received since the supplied date

Parameter	Type	Description
patientId	String	The ID of the patient. Max length 40 characters. This is required.
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based: the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). The value must be between 1 and 500. This is required.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), or T (trash) or empty (for all locations). Must be one of the following values: I, S, A, T.

Try it! Toggle Notes/Code Samples

PatientMessageListSince

Returns a list of messages for the supplied patient id, received since the supplied date

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientMessageListSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientMessageListSince codeSample = new UpdoxCodeSample_PatientMessageListSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientMessageListSince";
			PatientMessageListSinceRequest patientMessageListSinceRequest = new PatientMessageListSinceRequest();

			//set up credentials
			patientMessageListSinceRequest.auth.applicationId = "applicationId";
			patientMessageListSinceRequest.auth.applicationPassword = "applicationPassword";
			patientMessageListSinceRequest.auth.accountId = "accountId";

			//set up request specific parameters
			patientMessageListSinceRequest.patientId = "patientId";
			patientMessageListSinceRequest.dateSince = "datesince";
			patientMessageListSinceRequest.start = 1;
			patientMessageListSinceRequest.count = 1;
			patientMessageListSinceRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(patientMessageListSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientMessageListSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientMessageListSinceResponse patientMessageListSinceResponse = javascriptSerializer.Deserialize<PatientMessageListSinceResponse>(jsonResponse);

			Console.WriteLine(patientMessageListSinceResponse.responseCode);
			Console.WriteLine(patientMessageListSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PatientMessageListSinceRequest : UpdoxRequest {
			public string patientId { get; set;}
			public String dateSince { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public bool hasAttachments { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
		}

		public class PatientMessageListSinceResponse : UpdoxResponse {
			public int start { get; set;}
			public int totalCount { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_PatientMessageListSince {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientMessageListSince codeSample = new UpdoxCodeSample_PatientMessageListSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientMessageListSince";

		PatientMessageListSinceRequest patientMessageListSinceRequest = new PatientMessageListSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientMessageListSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		patientMessageListSinceRequest.setPatientId("patientId");
		patientMessageListSinceRequest.setDateSince(new Date());
		patientMessageListSinceRequest.setStart(1);
		patientMessageListSinceRequest.setCount(1);
		patientMessageListSinceRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientMessageListSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientMessageListSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientMessageListSinceResponse patientMessageListSinceResponse = mapper.readValue(jsonResponse, PatientMessageListSinceResponse.class);

		System.out.println(patientMessageListSinceResponse.getResponseCode());
		System.out.println(patientMessageListSinceResponse.getResponseMessage());
	}

	private class PatientMessageListSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private Date dateSince;
    	private int start;
    	private int count;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private boolean hasAttachments;
		private String location;
		private boolean isRead;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public boolean isHasAttachments() {
			return hasAttachments;
		}

		public void setHasAttachments(boolean hasAttachments) {
			this.hasAttachments = hasAttachments;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}
	}

	private static class PatientMessageListSinceResponse extends UpdoxResponse {
		private int start;
		private int totalCount;
		private int messageCount;
		private List<MessageObject> messages;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getTotalCount() {
			return totalCount;
		}

		public void setTotalCount(int totalCount) {
			this.totalCount = totalCount;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PatientMessageRetrieve /io/PatientMessageRetrieve

Retrieves a single message based on the supplied messageId

Parameter	Type	Description
messageId	Long	The ID of the message to retrieve. There must be at least 1 value(s). This is required.
markRead	Boolean	Optional boolean flag indicating if the message should be marked retrieved upon successful retrieval. Default value is true.
includeLoA	Boolean	Optional boolean flag indicating whether the sender and recipient's Level of Assurance should be included in the response.

Try it! Toggle Notes/Code Samples

PatientMessageRetrieve

Retrieves a single message based on the supplied messageId

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PatientMessageRetrieve {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PatientMessageRetrieve codeSample = new UpdoxCodeSample_PatientMessageRetrieve();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PatientMessageRetrieve";
			PatientMessageRetrieveRequest patientMessageRetrieveRequest = new PatientMessageRetrieveRequest();

			//set up credentials
			patientMessageRetrieveRequest.auth.applicationId = "applicationId";
			patientMessageRetrieveRequest.auth.applicationPassword = "applicationPassword";
			patientMessageRetrieveRequest.auth.accountId = "accountId";
			patientMessageRetrieveRequest.auth.userId = "userId";

			//set up request specific parameters
			patientMessageRetrieveRequest.messageId = 1L;
			patientMessageRetrieveRequest.markRead = true;
			patientMessageRetrieveRequest.includeLoA = true;

			//create the request
			string json = Utilities.buildRequestJson(patientMessageRetrieveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PatientMessageRetrieve", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PatientMessageRetrieveResponse patientMessageRetrieveResponse = javascriptSerializer.Deserialize<PatientMessageRetrieveResponse>(jsonResponse);

			Console.WriteLine(patientMessageRetrieveResponse.responseCode);
			Console.WriteLine(patientMessageRetrieveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PatientMessageRetrieveRequest : UpdoxRequest {
			public long messageId { get; set;}
			public bool markRead { get; set;}
			public bool includeLoA { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class AttachmentObject {
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class PatientMessageRetrieveResponse : UpdoxResponse {
			public long messageId { get; set;}
			public string type { get; set;}
			public string subject { get; set;}
			public string textMessage { get; set;}
			public string htmlMessage { get; set;}
			public string location { get; set;}
			public String received { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public List<AttachmentObject> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.sql.Timestamp;

public class UpdoxCodeSample_PatientMessageRetrieve {

	public static void main(String[] args) {
		UpdoxCodeSample_PatientMessageRetrieve codeSample = new UpdoxCodeSample_PatientMessageRetrieve();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PatientMessageRetrieve";

		PatientMessageRetrieveRequest patientMessageRetrieveRequest = new PatientMessageRetrieveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = patientMessageRetrieveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		patientMessageRetrieveRequest.setMessageId(1L);
		patientMessageRetrieveRequest.setMarkRead(true);
		patientMessageRetrieveRequest.setIncludeLoA(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(patientMessageRetrieveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PatientMessageRetrieve', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PatientMessageRetrieveResponse patientMessageRetrieveResponse = mapper.readValue(jsonResponse, PatientMessageRetrieveResponse.class);

		System.out.println(patientMessageRetrieveResponse.getResponseCode());
		System.out.println(patientMessageRetrieveResponse.getResponseMessage());
	}

	private class PatientMessageRetrieveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long messageId;
    	private boolean markRead;
    	private boolean includeLoA;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public boolean isMarkRead() {
			return markRead;
		}

		public void setMarkRead(boolean markRead) {
			this.markRead = markRead;
		}

		public boolean isIncludeLoA() {
			return includeLoA;
		}

		public void setIncludeLoA(boolean includeLoA) {
			this.includeLoA = includeLoA;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class AttachmentObject {
		private String fileName;
		private String mimeType;
		private String content;


		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private static class PatientMessageRetrieveResponse extends UpdoxResponse {
		private long messageId;
		private String type;
		private String subject;
		private String textMessage;
		private String htmlMessage;
		private String location;
		private Timestamp received;
		private RecipientObject from;
		private RecipientObject to;
		private List<AttachmentObject> attachments;


		public long getMessageId() {
			return messageId;
		}

		public void setMessageId(long messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getTextMessage() {
			return textMessage;
		}

		public void setTextMessage(String textMessage) {
			this.textMessage = textMessage;
		}

		public String getHtmlMessage() {
			return htmlMessage;
		}

		public void setHtmlMessage(String htmlMessage) {
			this.htmlMessage = htmlMessage;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public List<AttachmentObject> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<AttachmentObject> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`
`4410`	`message not found`

UserMessageListSince /io/UserMessageListSince

Returns a list of messages received since the supplied date for the authenticated user, excluding practice items.

Parameter	Type	Description
dateSince	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
dateTo	Date	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox up to and including the current date.
start	Int	Used for paging. The starting index of the message to be returned. Zero-based ? the first item is 0, the second is 1, etc. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of messages to return (the page size). Defaults to 50 when not provided or 0 specified. The value must be between 0 and 500.
location	String	The location of the message. Location must be I (inbox), S (sent), A (archive), T (trash) or empty (for all locations). Max length 1 characters. Must be one of the following values: I, S, A, T.
listUnreadOnly	Boolean	True to return only the list of unread messages.

Try it! Toggle Notes/Code Samples

UserMessageListSince

Returns a list of messages received since the supplied date for the authenticated user, excluding practice items.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserMessageListSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserMessageListSince codeSample = new UpdoxCodeSample_UserMessageListSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserMessageListSince";
			UserMessageListSinceRequest userMessageListSinceRequest = new UserMessageListSinceRequest();

			//set up credentials
			userMessageListSinceRequest.auth.applicationId = "applicationId";
			userMessageListSinceRequest.auth.applicationPassword = "applicationPassword";
			userMessageListSinceRequest.auth.accountId = "accountId";
			userMessageListSinceRequest.auth.userId = "userId";

			//set up request specific parameters
			userMessageListSinceRequest.dateSince = "datesince";
			userMessageListSinceRequest.dateTo = "dateto";
			userMessageListSinceRequest.start = 1;
			userMessageListSinceRequest.count = 1;
			userMessageListSinceRequest.location = "location";
			userMessageListSinceRequest.listUnreadOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(userMessageListSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserMessageListSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserMessageListSinceResponse userMessageListSinceResponse = javascriptSerializer.Deserialize<UserMessageListSinceResponse>(jsonResponse);

			Console.WriteLine(userMessageListSinceResponse.responseCode);
			Console.WriteLine(userMessageListSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserMessageListSinceRequest : UpdoxRequest {
			public String dateSince { get; set;}
			public String dateTo { get; set;}
			public int start { get; set;}
			public int count { get; set;}
			public string location { get; set;}
			public bool listUnreadOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RecipientObject {
			public string recipient { get; set;}
			public string name { get; set;}
			public string directAddress { get; set;}
			public string faxNumber { get; set;}
			public string practice { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
		}

		public class MessageObject {
			public string messageId { get; set;}
			public string type { get; set;}
			public RecipientObject from { get; set;}
			public RecipientObject to { get; set;}
			public string subject { get; set;}
			public String received { get; set;}
			public bool hasAttachments { get; set;}
			public string location { get; set;}
			public bool isRead { get; set;}
		}

		public class UserMessageListSinceResponse : UpdoxResponse {
			public int start { get; set;}
			public int totalCount { get; set;}
			public int messageCount { get; set;}
			public List<MessageObject> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.sql.Timestamp;

public class UpdoxCodeSample_UserMessageListSince {

	public static void main(String[] args) {
		UpdoxCodeSample_UserMessageListSince codeSample = new UpdoxCodeSample_UserMessageListSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserMessageListSince";

		UserMessageListSinceRequest userMessageListSinceRequest = new UserMessageListSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userMessageListSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		userMessageListSinceRequest.setDateSince(new Date());
		userMessageListSinceRequest.setDateTo(new Date());
		userMessageListSinceRequest.setStart(1);
		userMessageListSinceRequest.setCount(1);
		userMessageListSinceRequest.setLocation("location");
		userMessageListSinceRequest.setListUnreadOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userMessageListSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserMessageListSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserMessageListSinceResponse userMessageListSinceResponse = mapper.readValue(jsonResponse, UserMessageListSinceResponse.class);

		System.out.println(userMessageListSinceResponse.getResponseCode());
		System.out.println(userMessageListSinceResponse.getResponseMessage());
	}

	private class UserMessageListSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private Date dateSince;
    	private Date dateTo;
    	private int start;
    	private int count;
    	private String location;
    	private boolean listUnreadOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public Date getDateSince() {
			return dateSince;
		}

		public void setDateSince(Date dateSince) {
			this.dateSince = dateSince;
		}

		public Date getDateTo() {
			return dateTo;
		}

		public void setDateTo(Date dateTo) {
			this.dateTo = dateTo;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isListUnreadOnly() {
			return listUnreadOnly;
		}

		public void setListUnreadOnly(boolean listUnreadOnly) {
			this.listUnreadOnly = listUnreadOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RecipientObject {
		private String recipient;
		private String name;
		private String directAddress;
		private String faxNumber;
		private String practice;
		private String city;
		private String state;
		private String zip;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public String getPractice() {
			return practice;
		}

		public void setPractice(String practice) {
			this.practice = practice;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}
	}

	private static class MessageObject {
		private String messageId;
		private String type;
		private RecipientObject from;
		private RecipientObject to;
		private String subject;
		private Timestamp received;
		private boolean hasAttachments;
		private String location;
		private boolean isRead;


		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}

		public RecipientObject getFrom() {
			return from;
		}

		public void setFrom(RecipientObject from) {
			this.from = from;
		}

		public RecipientObject getTo() {
			return to;
		}

		public void setTo(RecipientObject to) {
			this.to = to;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public Timestamp getReceived() {
			return received;
		}

		public void setReceived(Timestamp received) {
			this.received = received;
		}

		public boolean isHasAttachments() {
			return hasAttachments;
		}

		public void setHasAttachments(boolean hasAttachments) {
			this.hasAttachments = hasAttachments;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}

		public boolean isIsRead() {
			return isRead;
		}

		public void setIsRead(boolean isRead) {
			this.isRead = isRead;
		}
	}

	private static class UserMessageListSinceResponse extends UpdoxResponse {
		private int start;
		private int totalCount;
		private int messageCount;
		private List<MessageObject> messages;


		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getTotalCount() {
			return totalCount;
		}

		public void setTotalCount(int totalCount) {
			this.totalCount = totalCount;
		}

		public int getMessageCount() {
			return messageCount;
		}

		public void setMessageCount(int messageCount) {
			this.messageCount = messageCount;
		}

		public List<MessageObject> getMessages() {
			return messages;
		}

		public void setMessages(List<MessageObject> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ModuleActions

PracticeModuleSave /io/PracticeModuleSave

Save the activation status of a module for the practice.

Parameter	Type	Value	Description
moduleId	Long		The identifier of the module to be set. This is required.
activate	Boolean		The activation status flag of the module to be set. Default is true.

Try it! Toggle Notes/Code Samples

PracticeModuleSave

Save the activation status of a module for the practice.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeModuleSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeModuleSave codeSample = new UpdoxCodeSample_PracticeModuleSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeModuleSave";
			PracticeModuleSaveRequest practiceModuleSaveRequest = new PracticeModuleSaveRequest();

			//set up credentials
			practiceModuleSaveRequest.auth.applicationId = "applicationId";
			practiceModuleSaveRequest.auth.applicationPassword = "applicationPassword";
			practiceModuleSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			practiceModuleSaveRequest.moduleId = 1L;
			practiceModuleSaveRequest.activate = true;

			//create the request
			string json = Utilities.buildRequestJson(practiceModuleSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeModuleSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeModuleSaveResponse practiceModuleSaveResponse = javascriptSerializer.Deserialize<PracticeModuleSaveResponse>(jsonResponse);

			Console.WriteLine(practiceModuleSaveResponse.responseCode);
			Console.WriteLine(practiceModuleSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeModuleSaveRequest : UpdoxRequest {
			public long moduleId { get; set;}
			public bool activate { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PracticeModuleSaveResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeModuleSave {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeModuleSave codeSample = new UpdoxCodeSample_PracticeModuleSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeModuleSave";

		PracticeModuleSaveRequest practiceModuleSaveRequest = new PracticeModuleSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceModuleSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		practiceModuleSaveRequest.setModuleId(1L);
		practiceModuleSaveRequest.setActivate(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceModuleSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeModuleSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeModuleSaveResponse practiceModuleSaveResponse = mapper.readValue(jsonResponse, PracticeModuleSaveResponse.class);

		System.out.println(practiceModuleSaveResponse.getResponseCode());
		System.out.println(practiceModuleSaveResponse.getResponseMessage());
	}

	private class PracticeModuleSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long moduleId;
    	private Boolean activate;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getModuleId() {
			return moduleId;
		}

		public void setModuleId(long moduleId) {
			this.moduleId = moduleId;
		}

		public Boolean isActivate() {
			return activate;
		}

		public void setActivate(Boolean activate) {
			this.activate = activate;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PracticeModuleSaveResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeModulesList /io/PracticeModulesList

Get a list of modules that are active for the practice.

Try it! Toggle Notes/Code Samples

PracticeModulesList

Get a list of modules that are active for the practice.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeModulesList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeModulesList codeSample = new UpdoxCodeSample_PracticeModulesList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeModulesList";
			PracticeModulesListRequest practiceModulesListRequest = new PracticeModulesListRequest();

			//set up credentials
			practiceModulesListRequest.auth.applicationId = "applicationId";
			practiceModulesListRequest.auth.applicationPassword = "applicationPassword";
			practiceModulesListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceModulesListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeModulesList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeModulesListResponse practiceModulesListResponse = javascriptSerializer.Deserialize<PracticeModulesListResponse>(jsonResponse);

			Console.WriteLine(practiceModulesListResponse.responseCode);
			Console.WriteLine(practiceModulesListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeModulesListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ModuleLimited {
			public long id { get; set;}
			public string name { get; set;}
		}

		public class PracticeModulesListResponse : UpdoxResponse {
			public List<ModuleLimited> modules { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeModulesList {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeModulesList codeSample = new UpdoxCodeSample_PracticeModulesList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeModulesList";

		PracticeModulesListRequest practiceModulesListRequest = new PracticeModulesListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceModulesListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceModulesListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeModulesList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeModulesListResponse practiceModulesListResponse = mapper.readValue(jsonResponse, PracticeModulesListResponse.class);

		System.out.println(practiceModulesListResponse.getResponseCode());
		System.out.println(practiceModulesListResponse.getResponseMessage());
	}

	private class PracticeModulesListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ModuleLimited {
		private long id;
		private String name;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}
	}

	private static class PracticeModulesListResponse extends UpdoxResponse {
		private List<ModuleLimited> modules;


		public List<ModuleLimited> getModules() {
			return modules;
		}

		public void setModules(List<ModuleLimited> modules) {
			this.modules = modules;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

VendorModulesList /io/VendorModulesList

Lists vendor's available modules.

Try it! Toggle Notes/Code Samples

VendorModulesList

Lists vendor's available modules.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VendorModulesList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VendorModulesList codeSample = new UpdoxCodeSample_VendorModulesList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VendorModulesList";
			VendorModulesListRequest vendorModulesListRequest = new VendorModulesListRequest();

			//set up credentials
			vendorModulesListRequest.auth.applicationId = "applicationId";
			vendorModulesListRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(vendorModulesListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "VendorModulesList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VendorModulesListResponse vendorModulesListResponse = javascriptSerializer.Deserialize<VendorModulesListResponse>(jsonResponse);

			Console.WriteLine(vendorModulesListResponse.responseCode);
			Console.WriteLine(vendorModulesListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VendorModulesListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ModuleLimited {
			public long id { get; set;}
			public string name { get; set;}
		}

		public class VendorModulesListResponse : UpdoxResponse {
			public List<ModuleLimited> modules { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VendorModulesList {

	public static void main(String[] args) {
		UpdoxCodeSample_VendorModulesList codeSample = new UpdoxCodeSample_VendorModulesList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VendorModulesList";

		VendorModulesListRequest vendorModulesListRequest = new VendorModulesListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = vendorModulesListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(vendorModulesListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'VendorModulesList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VendorModulesListResponse vendorModulesListResponse = mapper.readValue(jsonResponse, VendorModulesListResponse.class);

		System.out.println(vendorModulesListResponse.getResponseCode());
		System.out.println(vendorModulesListResponse.getResponseMessage());
	}

	private class VendorModulesListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ModuleLimited {
		private long id;
		private String name;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}
	}

	private static class VendorModulesListResponse extends UpdoxResponse {
		private List<ModuleLimited> modules;


		public List<ModuleLimited> getModules() {
			return modules;
		}

		public void setModules(List<ModuleLimited> modules) {
			this.modules = modules;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalActions

PortalAccountCreate /io/PortalAccountCreate

Creates a patient portal account for the patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountCreate

Creates a patient portal account for the patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountCreate codeSample = new UpdoxCodeSample_PortalAccountCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountCreate";
			PortalAccountCreateRequest portalAccountCreateRequest = new PortalAccountCreateRequest();

			//set up credentials
			portalAccountCreateRequest.auth.applicationId = "applicationId";
			portalAccountCreateRequest.auth.applicationPassword = "applicationPassword";
			portalAccountCreateRequest.auth.accountId = "accountId";
			portalAccountCreateRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountCreateRequest.patientId = "patientId";
			portalAccountCreateRequest.patientFirstName = "patientFirstName";
			portalAccountCreateRequest.patientMiddleName = "patientMiddleName";
			portalAccountCreateRequest.patientLastName = "patientLastName";
			portalAccountCreateRequest.suffix = "suffix";
			portalAccountCreateRequest.patientEmail = "test@test.com";
			portalAccountCreateRequest.patientDob = "patientDob";
			portalAccountCreateRequest.patientGender = "patientGender";
			portalAccountCreateRequest.password = "password";
			portalAccountCreateRequest.patientChartNumber = "patientChartNumber";
			portalAccountCreateRequest.address1 = "address1";
			portalAccountCreateRequest.address2 = "address2";
			portalAccountCreateRequest.city = "Dublin";
			portalAccountCreateRequest.state = "OH";
			portalAccountCreateRequest.zip = "43017";
			portalAccountCreateRequest.homeNbr = "homeNbr";
			portalAccountCreateRequest.cellNbr = "cellNbr";
			portalAccountCreateRequest.faxNbr = "faxNbr";
			portalAccountCreateRequest.workNbr = "workNbr";
			portalAccountCreateRequest.workNbrExt = "workNbrExt";
			portalAccountCreateRequest.reminderMethodId = 1;
			portalAccountCreateRequest.maritalStatus = "M";
			portalAccountCreateRequest.prefProviderName = "prefProviderName";
			portalAccountCreateRequest.language = "language";
			portalAccountCreateRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountCreateResponse portalAccountCreateResponse = javascriptSerializer.Deserialize<PortalAccountCreateResponse>(jsonResponse);

			Console.WriteLine(portalAccountCreateResponse.responseCode);
			Console.WriteLine(portalAccountCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountCreateRequest : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountCreateResponse : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountCreate codeSample = new UpdoxCodeSample_PortalAccountCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountCreate";

		PortalAccountCreateRequest portalAccountCreateRequest = new PortalAccountCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountCreateRequest.setPatientId("patientId");
		portalAccountCreateRequest.setPatientFirstName("patientFirstName");
		portalAccountCreateRequest.setPatientMiddleName("patientMiddleName");
		portalAccountCreateRequest.setPatientLastName("patientLastName");
		portalAccountCreateRequest.setSuffix("suffix");
		portalAccountCreateRequest.setPatientEmail("test@test.com");
		portalAccountCreateRequest.setPatientDob("patientDob");
		portalAccountCreateRequest.setPatientGender("patientGender");
		portalAccountCreateRequest.setPassword("password");
		portalAccountCreateRequest.setPatientChartNumber("patientChartNumber");
		portalAccountCreateRequest.setAddress1("address1");
		portalAccountCreateRequest.setAddress2("address2");
		portalAccountCreateRequest.setCity("Dublin");
		portalAccountCreateRequest.setState("OH");
		portalAccountCreateRequest.setZip("43017");
		portalAccountCreateRequest.setHomeNbr("homeNbr");
		portalAccountCreateRequest.setCellNbr("cellNbr");
		portalAccountCreateRequest.setFaxNbr("faxNbr");
		portalAccountCreateRequest.setWorkNbr("workNbr");
		portalAccountCreateRequest.setWorkNbrExt("workNbrExt");
		portalAccountCreateRequest.setReminderMethodId(1);
		portalAccountCreateRequest.setMaritalStatus("M");
		portalAccountCreateRequest.setPrefProviderName("prefProviderName");
		portalAccountCreateRequest.setLanguage("language");
		portalAccountCreateRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountCreateResponse portalAccountCreateResponse = mapper.readValue(jsonResponse, PortalAccountCreateResponse.class);

		System.out.println(portalAccountCreateResponse.getResponseCode());
		System.out.println(portalAccountCreateResponse.getResponseMessage());
	}

	private class PortalAccountCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountCreateResponse extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4830`	`portal account already exists`

PortalAccountCreate/1.1 /io/PortalAccountCreate/1.1

Creates a patient portal account for the patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountCreate/1.1

Creates a patient portal account for the patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountCreate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountCreate1_1 codeSample = new UpdoxCodeSample_PortalAccountCreate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountCreate1_1";
			PortalAccountCreate1_1Request portalAccountCreate1_1Request = new PortalAccountCreate1_1Request();

			//set up credentials
			portalAccountCreate1_1Request.auth.applicationId = "applicationId";
			portalAccountCreate1_1Request.auth.applicationPassword = "applicationPassword";
			portalAccountCreate1_1Request.auth.accountId = "accountId";
			portalAccountCreate1_1Request.auth.userId = "userId";

			//set up request specific parameters
			portalAccountCreate1_1Request.patientId = "patientId";
			portalAccountCreate1_1Request.patientFirstName = "patientFirstName";
			portalAccountCreate1_1Request.patientMiddleName = "patientMiddleName";
			portalAccountCreate1_1Request.patientLastName = "patientLastName";
			portalAccountCreate1_1Request.suffix = "suffix";
			portalAccountCreate1_1Request.patientEmail = "test@test.com";
			portalAccountCreate1_1Request.patientDob = "patientDob";
			portalAccountCreate1_1Request.patientGender = "patientGender";
			portalAccountCreate1_1Request.password = "password";
			portalAccountCreate1_1Request.patientChartNumber = "patientChartNumber";
			portalAccountCreate1_1Request.address1 = "address1";
			portalAccountCreate1_1Request.address2 = "address2";
			portalAccountCreate1_1Request.city = "Dublin";
			portalAccountCreate1_1Request.state = "OH";
			portalAccountCreate1_1Request.zip = "43017";
			portalAccountCreate1_1Request.homeNbr = "homeNbr";
			portalAccountCreate1_1Request.cellNbr = "cellNbr";
			portalAccountCreate1_1Request.faxNbr = "faxNbr";
			portalAccountCreate1_1Request.workNbr = "workNbr";
			portalAccountCreate1_1Request.workNbrExt = "workNbrExt";
			portalAccountCreate1_1Request.reminderMethodId = 1;
			portalAccountCreate1_1Request.maritalStatus = "M";
			portalAccountCreate1_1Request.prefProviderName = "prefProviderName";
			portalAccountCreate1_1Request.language = "language";
			portalAccountCreate1_1Request.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountCreate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountCreate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountCreate1_1Response portalAccountCreate1_1Response = javascriptSerializer.Deserialize<PortalAccountCreate1_1Response>(jsonResponse);

			Console.WriteLine(portalAccountCreate1_1Response.responseCode);
			Console.WriteLine(portalAccountCreate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountCreate1_1Request : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountCreate1_1Response : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountCreate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountCreate1_1 codeSample = new UpdoxCodeSample_PortalAccountCreate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountCreate1_1";

		PortalAccountCreate1_1Request portalAccountCreate1_1Request = new PortalAccountCreate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountCreate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountCreate1_1Request.setPatientId("patientId");
		portalAccountCreate1_1Request.setPatientFirstName("patientFirstName");
		portalAccountCreate1_1Request.setPatientMiddleName("patientMiddleName");
		portalAccountCreate1_1Request.setPatientLastName("patientLastName");
		portalAccountCreate1_1Request.setSuffix("suffix");
		portalAccountCreate1_1Request.setPatientEmail("test@test.com");
		portalAccountCreate1_1Request.setPatientDob("patientDob");
		portalAccountCreate1_1Request.setPatientGender("patientGender");
		portalAccountCreate1_1Request.setPassword("password");
		portalAccountCreate1_1Request.setPatientChartNumber("patientChartNumber");
		portalAccountCreate1_1Request.setAddress1("address1");
		portalAccountCreate1_1Request.setAddress2("address2");
		portalAccountCreate1_1Request.setCity("Dublin");
		portalAccountCreate1_1Request.setState("OH");
		portalAccountCreate1_1Request.setZip("43017");
		portalAccountCreate1_1Request.setHomeNbr("homeNbr");
		portalAccountCreate1_1Request.setCellNbr("cellNbr");
		portalAccountCreate1_1Request.setFaxNbr("faxNbr");
		portalAccountCreate1_1Request.setWorkNbr("workNbr");
		portalAccountCreate1_1Request.setWorkNbrExt("workNbrExt");
		portalAccountCreate1_1Request.setReminderMethodId(1);
		portalAccountCreate1_1Request.setMaritalStatus("M");
		portalAccountCreate1_1Request.setPrefProviderName("prefProviderName");
		portalAccountCreate1_1Request.setLanguage("language");
		portalAccountCreate1_1Request.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountCreate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountCreate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountCreate1_1Response portalAccountCreate1_1Response = mapper.readValue(jsonResponse, PortalAccountCreate1_1Response.class);

		System.out.println(portalAccountCreate1_1Response.getResponseCode());
		System.out.println(portalAccountCreate1_1Response.getResponseMessage());
	}

	private class PortalAccountCreate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountCreate1_1Response extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PortalAccountGet /io/PortalAccountGet

Gets the portal account associated with supplied patientId, inside the authorized account.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet

Gets the portal account associated with supplied patientId, inside the authorized account.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet codeSample = new UpdoxCodeSample_PortalAccountGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet";
			PortalAccountGetRequest portalAccountGetRequest = new PortalAccountGetRequest();

			//set up credentials
			portalAccountGetRequest.auth.applicationId = "applicationId";
			portalAccountGetRequest.auth.applicationPassword = "applicationPassword";
			portalAccountGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGetRequest.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGetResponse portalAccountGetResponse = javascriptSerializer.Deserialize<PortalAccountGetResponse>(jsonResponse);

			Console.WriteLine(portalAccountGetResponse.responseCode);
			Console.WriteLine(portalAccountGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGetRequest : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGetResponse : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet codeSample = new UpdoxCodeSample_PortalAccountGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet";

		PortalAccountGetRequest portalAccountGetRequest = new PortalAccountGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGetRequest.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGetResponse portalAccountGetResponse = mapper.readValue(jsonResponse, PortalAccountGetResponse.class);

		System.out.println(portalAccountGetResponse.getResponseCode());
		System.out.println(portalAccountGetResponse.getResponseMessage());
	}

	private class PortalAccountGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGetResponse extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountGet/1.1 /io/PortalAccountGet/1.1

Gets the portal account associated with supplied patientId, inside the authorized account. Changes from v1.0 to v1.1: improved "dates of birth" and "last login time".

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet/1.1

Gets the portal account associated with supplied patientId, inside the authorized account. Changes from v1.0 to v1.1: improved "dates of birth" and "last login time".

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet1_1 codeSample = new UpdoxCodeSample_PortalAccountGet1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet1_1";
			PortalAccountGet1_1Request portalAccountGet1_1Request = new PortalAccountGet1_1Request();

			//set up credentials
			portalAccountGet1_1Request.auth.applicationId = "applicationId";
			portalAccountGet1_1Request.auth.applicationPassword = "applicationPassword";
			portalAccountGet1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGet1_1Request.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGet1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGet1_1Response portalAccountGet1_1Response = javascriptSerializer.Deserialize<PortalAccountGet1_1Response>(jsonResponse);

			Console.WriteLine(portalAccountGet1_1Response.responseCode);
			Console.WriteLine(portalAccountGet1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGet1_1Request : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGet1_1Response : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet1_1 codeSample = new UpdoxCodeSample_PortalAccountGet1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet1_1";

		PortalAccountGet1_1Request portalAccountGet1_1Request = new PortalAccountGet1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGet1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGet1_1Request.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGet1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGet1_1Response portalAccountGet1_1Response = mapper.readValue(jsonResponse, PortalAccountGet1_1Response.class);

		System.out.println(portalAccountGet1_1Response.getResponseCode());
		System.out.println(portalAccountGet1_1Response.getResponseMessage());
	}

	private class PortalAccountGet1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGet1_1Response extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountGet/1.2 /io/PortalAccountGet/1.2

Gets the portal account associated with supplied patientId with both patient email and patient notify email, inside the authorized account. Changes from v1.1 to v1.2: added notifyEmail to each portal account's response details.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet/1.2

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet1_2 codeSample = new UpdoxCodeSample_PortalAccountGet1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet1_2";
			PortalAccountGet1_2Request portalAccountGet1_2Request = new PortalAccountGet1_2Request();

			//set up credentials
			portalAccountGet1_2Request.auth.applicationId = "applicationId";
			portalAccountGet1_2Request.auth.applicationPassword = "applicationPassword";
			portalAccountGet1_2Request.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGet1_2Request.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGet1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGet1_2Response portalAccountGet1_2Response = javascriptSerializer.Deserialize<PortalAccountGet1_2Response>(jsonResponse);

			Console.WriteLine(portalAccountGet1_2Response.responseCode);
			Console.WriteLine(portalAccountGet1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGet1_2Request : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGet1_2Response : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet1_2 codeSample = new UpdoxCodeSample_PortalAccountGet1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet1_2";

		PortalAccountGet1_2Request portalAccountGet1_2Request = new PortalAccountGet1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGet1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGet1_2Request.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGet1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGet1_2Response portalAccountGet1_2Response = mapper.readValue(jsonResponse, PortalAccountGet1_2Response.class);

		System.out.println(portalAccountGet1_2Response.getResponseCode());
		System.out.println(portalAccountGet1_2Response.getResponseMessage());
	}

	private class PortalAccountGet1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGet1_2Response extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountGet/1.3 /io/PortalAccountGet/1.3

Gets the portal account associated with supplied patientId with both patient email and patient notify email, inside the authorized account. Changes from v1.2 to v1.3: added patientCellNbr and patientHomeNbrto each portal account's response details.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet/1.3

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet1_3 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet1_3 codeSample = new UpdoxCodeSample_PortalAccountGet1_3();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet1_3";
			PortalAccountGet1_3Request portalAccountGet1_3Request = new PortalAccountGet1_3Request();

			//set up credentials
			portalAccountGet1_3Request.auth.applicationId = "applicationId";
			portalAccountGet1_3Request.auth.applicationPassword = "applicationPassword";
			portalAccountGet1_3Request.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGet1_3Request.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGet1_3Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet/1.3", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGet1_3Response portalAccountGet1_3Response = javascriptSerializer.Deserialize<PortalAccountGet1_3Response>(jsonResponse);

			Console.WriteLine(portalAccountGet1_3Response.responseCode);
			Console.WriteLine(portalAccountGet1_3Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGet1_3Request : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGet1_3Response : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet1_3 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet1_3 codeSample = new UpdoxCodeSample_PortalAccountGet1_3();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet1_3";

		PortalAccountGet1_3Request portalAccountGet1_3Request = new PortalAccountGet1_3Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGet1_3Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGet1_3Request.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGet1_3Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet/1.3', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGet1_3Response portalAccountGet1_3Response = mapper.readValue(jsonResponse, PortalAccountGet1_3Response.class);

		System.out.println(portalAccountGet1_3Response.getResponseCode());
		System.out.println(portalAccountGet1_3Response.getResponseMessage());
	}

	private class PortalAccountGet1_3Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGet1_3Response extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountGet/1.4 /io/PortalAccountGet/1.4

Gets the portal account associated with supplied patientId along with the corresponding patient's demographics.

Changes from v1.3 to v1.4:

Individual authentication is disabled
patientHomeNbr - Renamed in response object to homeNbr
patientCellNbr - Renamed in response object to cellNbr
Added the following fields to each portal account's response details:

suffix - The suffix of the patient's name
address1 - The street address of the patient's address
address2 - The address 2 of the patient's address
city - The city of the patient's address
state - The 2 character state/province code of the patient's address
postal - The postal code of the patient's address:
- If US - Supported formats:
- If CA - The Canadian postal code with the space (ex: \"H0H 0H0\")
- If other - Treated as a US postal code
country - The ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the patient's address
faxNbr - The fax number of the patient
workNbr - The work number of the patient
workNbrExt - The extension of the patient's work number
maritalStatus - The marital status of the patient
reminderMethodId - The reminder communication preference of the patient:
- 0 - Practice Preference
- 1 - Email
- 2 - Home Phone
- 3 - Cell
- 4 - Text
- 5 - No Reminders
prefProviderName - The name of the provider preferred by the patient
language - The language preferred by the patient
location - The external id of the location preferred by the patient

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet/1.4

Gets the portal account associated with supplied patientId along with the corresponding patient's demographics.

Changes from v1.3 to v1.4:

Individual authentication is disabled
patientHomeNbr - Renamed in response object to homeNbr
patientCellNbr - Renamed in response object to cellNbr
Added the following fields to each portal account's response details:

suffix - The suffix of the patient's name
address1 - The street address of the patient's address
address2 - The address 2 of the patient's address
city - The city of the patient's address
state - The 2 character state/province code of the patient's address
postal - The postal code of the patient's address:
- If US - Supported formats:
- If CA - The Canadian postal code with the space (ex: \"H0H 0H0\")
- If other - Treated as a US postal code
country - The ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the patient's address
faxNbr - The fax number of the patient
workNbr - The work number of the patient
workNbrExt - The extension of the patient's work number
maritalStatus - The marital status of the patient
reminderMethodId - The reminder communication preference of the patient:
- 0 - Practice Preference
- 1 - Email
- 2 - Home Phone
- 3 - Cell
- 4 - Text
- 5 - No Reminders
prefProviderName - The name of the provider preferred by the patient
language - The language preferred by the patient
location - The external id of the location preferred by the patient

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet1_4 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet1_4 codeSample = new UpdoxCodeSample_PortalAccountGet1_4();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet1_4";
			PortalAccountGet1_4Request portalAccountGet1_4Request = new PortalAccountGet1_4Request();

			//set up credentials
			portalAccountGet1_4Request.auth.applicationId = "applicationId";
			portalAccountGet1_4Request.auth.applicationPassword = "applicationPassword";
			portalAccountGet1_4Request.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGet1_4Request.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGet1_4Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet/1.4", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGet1_4Response portalAccountGet1_4Response = javascriptSerializer.Deserialize<PortalAccountGet1_4Response>(jsonResponse);

			Console.WriteLine(portalAccountGet1_4Response.responseCode);
			Console.WriteLine(portalAccountGet1_4Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGet1_4Request : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGet1_4Response : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet1_4 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet1_4 codeSample = new UpdoxCodeSample_PortalAccountGet1_4();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet1_4";

		PortalAccountGet1_4Request portalAccountGet1_4Request = new PortalAccountGet1_4Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGet1_4Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGet1_4Request.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGet1_4Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet/1.4', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGet1_4Response portalAccountGet1_4Response = mapper.readValue(jsonResponse, PortalAccountGet1_4Response.class);

		System.out.println(portalAccountGet1_4Response.getResponseCode());
		System.out.println(portalAccountGet1_4Response.getResponseMessage());
	}

	private class PortalAccountGet1_4Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGet1_4Response extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountGet/1.5 /io/PortalAccountGet/1.5

Gets the portal account associated with supplied patientId along with the corresponding patient's demographics.

Changes from v1.4 to v1.5:

verified - Field is added to store the patient's current portal verification status

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountGet/1.5

Gets the portal account associated with supplied patientId along with the corresponding patient's demographics.

Changes from v1.4 to v1.5:

verified - Field is added to store the patient's current portal verification status

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountGet1_5 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountGet1_5 codeSample = new UpdoxCodeSample_PortalAccountGet1_5();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountGet1_5";
			PortalAccountGet1_5Request portalAccountGet1_5Request = new PortalAccountGet1_5Request();

			//set up credentials
			portalAccountGet1_5Request.auth.applicationId = "applicationId";
			portalAccountGet1_5Request.auth.applicationPassword = "applicationPassword";
			portalAccountGet1_5Request.auth.accountId = "accountId";

			//set up request specific parameters
			portalAccountGet1_5Request.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountGet1_5Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountGet/1.5", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountGet1_5Response portalAccountGet1_5Response = javascriptSerializer.Deserialize<PortalAccountGet1_5Response>(jsonResponse);

			Console.WriteLine(portalAccountGet1_5Response.responseCode);
			Console.WriteLine(portalAccountGet1_5Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountGet1_5Request : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountInfoLimited {
		}

		public class PortalAccountGet1_5Response : UpdoxResponse {
			public PortalAccountInfoLimited portalAccount { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountGet1_5 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountGet1_5 codeSample = new UpdoxCodeSample_PortalAccountGet1_5();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountGet1_5";

		PortalAccountGet1_5Request portalAccountGet1_5Request = new PortalAccountGet1_5Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountGet1_5Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalAccountGet1_5Request.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountGet1_5Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountGet/1.5', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountGet1_5Response portalAccountGet1_5Response = mapper.readValue(jsonResponse, PortalAccountGet1_5Response.class);

		System.out.println(portalAccountGet1_5Response.getResponseCode());
		System.out.println(portalAccountGet1_5Response.getResponseMessage());
	}

	private class PortalAccountGet1_5Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalAccountInfoLimited {

	}

	private static class PortalAccountGet1_5Response extends UpdoxResponse {
		private PortalAccountInfoLimited portalAccount;


		public PortalAccountInfoLimited getPortalAccount() {
			return portalAccount;
		}

		public void setPortalAccount(PortalAccountInfoLimited portalAccount) {
			this.portalAccount = portalAccount;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountRemove /io/PortalAccountRemove

Inactivates the portal account associated with supplied patientId.

Parameter	Type	Value	Description
patientId	String		The ID of the patient to get. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountRemove

Inactivates the portal account associated with supplied patientId.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountRemove {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountRemove codeSample = new UpdoxCodeSample_PortalAccountRemove();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountRemove";
			PortalAccountRemoveRequest portalAccountRemoveRequest = new PortalAccountRemoveRequest();

			//set up credentials
			portalAccountRemoveRequest.auth.applicationId = "applicationId";
			portalAccountRemoveRequest.auth.applicationPassword = "applicationPassword";
			portalAccountRemoveRequest.auth.accountId = "accountId";
			portalAccountRemoveRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountRemoveRequest.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountRemoveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountRemove", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountRemoveResponse portalAccountRemoveResponse = javascriptSerializer.Deserialize<PortalAccountRemoveResponse>(jsonResponse);

			Console.WriteLine(portalAccountRemoveResponse.responseCode);
			Console.WriteLine(portalAccountRemoveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountRemoveRequest : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PortalAccountRemoveResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountRemove {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountRemove codeSample = new UpdoxCodeSample_PortalAccountRemove();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountRemove";

		PortalAccountRemoveRequest portalAccountRemoveRequest = new PortalAccountRemoveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountRemoveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountRemoveRequest.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountRemoveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountRemove', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountRemoveResponse portalAccountRemoveResponse = mapper.readValue(jsonResponse, PortalAccountRemoveResponse.class);

		System.out.println(portalAccountRemoveResponse.getResponseCode());
		System.out.println(portalAccountRemoveResponse.getResponseMessage());
	}

	private class PortalAccountRemoveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountRemoveResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountReset /io/PortalAccountReset

Reset portal account password

Parameter	Type	Value	Description
patientId	String		The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountReset

Reset portal account password

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountReset {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountReset codeSample = new UpdoxCodeSample_PortalAccountReset();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountReset";
			PortalAccountResetRequest portalAccountResetRequest = new PortalAccountResetRequest();

			//set up credentials
			portalAccountResetRequest.auth.applicationId = "applicationId";
			portalAccountResetRequest.auth.applicationPassword = "applicationPassword";
			portalAccountResetRequest.auth.accountId = "accountId";
			portalAccountResetRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountResetRequest.patientId = "patientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountResetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountReset", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountResetResponse portalAccountResetResponse = javascriptSerializer.Deserialize<PortalAccountResetResponse>(jsonResponse);

			Console.WriteLine(portalAccountResetResponse.responseCode);
			Console.WriteLine(portalAccountResetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountResetRequest : UpdoxRequest {
			public string patientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountResetResponse : UpdoxResponse {
			public string password { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountReset {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountReset codeSample = new UpdoxCodeSample_PortalAccountReset();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountReset";

		PortalAccountResetRequest portalAccountResetRequest = new PortalAccountResetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountResetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountResetRequest.setPatientId("patientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountResetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountReset', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountResetResponse portalAccountResetResponse = mapper.readValue(jsonResponse, PortalAccountResetResponse.class);

		System.out.println(portalAccountResetResponse.getResponseCode());
		System.out.println(portalAccountResetResponse.getResponseMessage());
	}

	private class PortalAccountResetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountResetResponse extends UpdoxResponse {
		private String password;


		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`
`4830`	`portal account already exists`

PortalAccountSave /io/PortalAccountSave

Creates or updates a patient portal account for the patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountSave

Creates or updates a patient portal account for the patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountSave codeSample = new UpdoxCodeSample_PortalAccountSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountSave";
			PortalAccountSaveRequest portalAccountSaveRequest = new PortalAccountSaveRequest();

			//set up credentials
			portalAccountSaveRequest.auth.applicationId = "applicationId";
			portalAccountSaveRequest.auth.applicationPassword = "applicationPassword";
			portalAccountSaveRequest.auth.accountId = "accountId";
			portalAccountSaveRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountSaveRequest.patientId = "patientId";
			portalAccountSaveRequest.patientFirstName = "patientFirstName";
			portalAccountSaveRequest.patientMiddleName = "patientMiddleName";
			portalAccountSaveRequest.patientLastName = "patientLastName";
			portalAccountSaveRequest.suffix = "suffix";
			portalAccountSaveRequest.patientEmail = "test@test.com";
			portalAccountSaveRequest.patientDob = "patientDob";
			portalAccountSaveRequest.patientGender = "patientGender";
			portalAccountSaveRequest.password = "password";
			portalAccountSaveRequest.patientChartNumber = "patientChartNumber";
			portalAccountSaveRequest.address1 = "address1";
			portalAccountSaveRequest.address2 = "address2";
			portalAccountSaveRequest.city = "Dublin";
			portalAccountSaveRequest.state = "OH";
			portalAccountSaveRequest.zip = "43017";
			portalAccountSaveRequest.homeNbr = "homeNbr";
			portalAccountSaveRequest.cellNbr = "cellNbr";
			portalAccountSaveRequest.faxNbr = "faxNbr";
			portalAccountSaveRequest.workNbr = "workNbr";
			portalAccountSaveRequest.workNbrExt = "workNbrExt";
			portalAccountSaveRequest.reminderMethodId = 1;
			portalAccountSaveRequest.maritalStatus = "M";
			portalAccountSaveRequest.prefProviderName = "prefProviderName";
			portalAccountSaveRequest.language = "language";
			portalAccountSaveRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountSaveResponse portalAccountSaveResponse = javascriptSerializer.Deserialize<PortalAccountSaveResponse>(jsonResponse);

			Console.WriteLine(portalAccountSaveResponse.responseCode);
			Console.WriteLine(portalAccountSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountSaveRequest : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountSaveResponse : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountSave {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountSave codeSample = new UpdoxCodeSample_PortalAccountSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountSave";

		PortalAccountSaveRequest portalAccountSaveRequest = new PortalAccountSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountSaveRequest.setPatientId("patientId");
		portalAccountSaveRequest.setPatientFirstName("patientFirstName");
		portalAccountSaveRequest.setPatientMiddleName("patientMiddleName");
		portalAccountSaveRequest.setPatientLastName("patientLastName");
		portalAccountSaveRequest.setSuffix("suffix");
		portalAccountSaveRequest.setPatientEmail("test@test.com");
		portalAccountSaveRequest.setPatientDob("patientDob");
		portalAccountSaveRequest.setPatientGender("patientGender");
		portalAccountSaveRequest.setPassword("password");
		portalAccountSaveRequest.setPatientChartNumber("patientChartNumber");
		portalAccountSaveRequest.setAddress1("address1");
		portalAccountSaveRequest.setAddress2("address2");
		portalAccountSaveRequest.setCity("Dublin");
		portalAccountSaveRequest.setState("OH");
		portalAccountSaveRequest.setZip("43017");
		portalAccountSaveRequest.setHomeNbr("homeNbr");
		portalAccountSaveRequest.setCellNbr("cellNbr");
		portalAccountSaveRequest.setFaxNbr("faxNbr");
		portalAccountSaveRequest.setWorkNbr("workNbr");
		portalAccountSaveRequest.setWorkNbrExt("workNbrExt");
		portalAccountSaveRequest.setReminderMethodId(1);
		portalAccountSaveRequest.setMaritalStatus("M");
		portalAccountSaveRequest.setPrefProviderName("prefProviderName");
		portalAccountSaveRequest.setLanguage("language");
		portalAccountSaveRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountSaveResponse portalAccountSaveResponse = mapper.readValue(jsonResponse, PortalAccountSaveResponse.class);

		System.out.println(portalAccountSaveResponse.getResponseCode());
		System.out.println(portalAccountSaveResponse.getResponseMessage());
	}

	private class PortalAccountSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountSaveResponse extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalAccountSave/1.1 /io/PortalAccountSave/1.1

Creates or updates a patient portal account for the patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountSave/1.1

Creates or updates a patient portal account for the patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountSave1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountSave1_1 codeSample = new UpdoxCodeSample_PortalAccountSave1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountSave1_1";
			PortalAccountSave1_1Request portalAccountSave1_1Request = new PortalAccountSave1_1Request();

			//set up credentials
			portalAccountSave1_1Request.auth.applicationId = "applicationId";
			portalAccountSave1_1Request.auth.applicationPassword = "applicationPassword";
			portalAccountSave1_1Request.auth.accountId = "accountId";
			portalAccountSave1_1Request.auth.userId = "userId";

			//set up request specific parameters
			portalAccountSave1_1Request.patientId = "patientId";
			portalAccountSave1_1Request.patientFirstName = "patientFirstName";
			portalAccountSave1_1Request.patientMiddleName = "patientMiddleName";
			portalAccountSave1_1Request.patientLastName = "patientLastName";
			portalAccountSave1_1Request.suffix = "suffix";
			portalAccountSave1_1Request.patientEmail = "test@test.com";
			portalAccountSave1_1Request.patientDob = "patientDob";
			portalAccountSave1_1Request.patientGender = "patientGender";
			portalAccountSave1_1Request.password = "password";
			portalAccountSave1_1Request.patientChartNumber = "patientChartNumber";
			portalAccountSave1_1Request.address1 = "address1";
			portalAccountSave1_1Request.address2 = "address2";
			portalAccountSave1_1Request.city = "Dublin";
			portalAccountSave1_1Request.state = "OH";
			portalAccountSave1_1Request.zip = "43017";
			portalAccountSave1_1Request.homeNbr = "homeNbr";
			portalAccountSave1_1Request.cellNbr = "cellNbr";
			portalAccountSave1_1Request.faxNbr = "faxNbr";
			portalAccountSave1_1Request.workNbr = "workNbr";
			portalAccountSave1_1Request.workNbrExt = "workNbrExt";
			portalAccountSave1_1Request.reminderMethodId = 1;
			portalAccountSave1_1Request.maritalStatus = "M";
			portalAccountSave1_1Request.prefProviderName = "prefProviderName";
			portalAccountSave1_1Request.language = "language";
			portalAccountSave1_1Request.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountSave1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountSave/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountSave1_1Response portalAccountSave1_1Response = javascriptSerializer.Deserialize<PortalAccountSave1_1Response>(jsonResponse);

			Console.WriteLine(portalAccountSave1_1Response.responseCode);
			Console.WriteLine(portalAccountSave1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountSave1_1Request : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountSave1_1Response : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountSave1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountSave1_1 codeSample = new UpdoxCodeSample_PortalAccountSave1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountSave1_1";

		PortalAccountSave1_1Request portalAccountSave1_1Request = new PortalAccountSave1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountSave1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountSave1_1Request.setPatientId("patientId");
		portalAccountSave1_1Request.setPatientFirstName("patientFirstName");
		portalAccountSave1_1Request.setPatientMiddleName("patientMiddleName");
		portalAccountSave1_1Request.setPatientLastName("patientLastName");
		portalAccountSave1_1Request.setSuffix("suffix");
		portalAccountSave1_1Request.setPatientEmail("test@test.com");
		portalAccountSave1_1Request.setPatientDob("patientDob");
		portalAccountSave1_1Request.setPatientGender("patientGender");
		portalAccountSave1_1Request.setPassword("password");
		portalAccountSave1_1Request.setPatientChartNumber("patientChartNumber");
		portalAccountSave1_1Request.setAddress1("address1");
		portalAccountSave1_1Request.setAddress2("address2");
		portalAccountSave1_1Request.setCity("Dublin");
		portalAccountSave1_1Request.setState("OH");
		portalAccountSave1_1Request.setZip("43017");
		portalAccountSave1_1Request.setHomeNbr("homeNbr");
		portalAccountSave1_1Request.setCellNbr("cellNbr");
		portalAccountSave1_1Request.setFaxNbr("faxNbr");
		portalAccountSave1_1Request.setWorkNbr("workNbr");
		portalAccountSave1_1Request.setWorkNbrExt("workNbrExt");
		portalAccountSave1_1Request.setReminderMethodId(1);
		portalAccountSave1_1Request.setMaritalStatus("M");
		portalAccountSave1_1Request.setPrefProviderName("prefProviderName");
		portalAccountSave1_1Request.setLanguage("language");
		portalAccountSave1_1Request.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountSave1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountSave/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountSave1_1Response portalAccountSave1_1Response = mapper.readValue(jsonResponse, PortalAccountSave1_1Response.class);

		System.out.println(portalAccountSave1_1Response.getResponseCode());
		System.out.println(portalAccountSave1_1Response.getResponseMessage());
	}

	private class PortalAccountSave1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountSave1_1Response extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PortalAccountSave/1.2 /io/PortalAccountSave/1.2

Creates or updates a patient portal account for the patient with the given patientId.

Changes from v1.1 to v1.2:

zip - renamed in request object to postal for better international address support
country - Added optional field which collects the country code for the account's address

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	The account's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The account's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". . The value must contain exactly 2 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountSave/1.2

Creates or updates a patient portal account for the patient with the given patientId.

Changes from v1.1 to v1.2:

zip - renamed in request object to postal for better international address support
country - Added optional field which collects the country code for the account's address

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountSave1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountSave1_2 codeSample = new UpdoxCodeSample_PortalAccountSave1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountSave1_2";
			PortalAccountSave1_2Request portalAccountSave1_2Request = new PortalAccountSave1_2Request();

			//set up credentials
			portalAccountSave1_2Request.auth.applicationId = "applicationId";
			portalAccountSave1_2Request.auth.applicationPassword = "applicationPassword";
			portalAccountSave1_2Request.auth.accountId = "accountId";
			portalAccountSave1_2Request.auth.userId = "userId";

			//set up request specific parameters
			portalAccountSave1_2Request.patientId = "patientId";
			portalAccountSave1_2Request.patientFirstName = "patientFirstName";
			portalAccountSave1_2Request.patientMiddleName = "patientMiddleName";
			portalAccountSave1_2Request.patientLastName = "patientLastName";
			portalAccountSave1_2Request.suffix = "suffix";
			portalAccountSave1_2Request.patientEmail = "test@test.com";
			portalAccountSave1_2Request.patientDob = "patientDob";
			portalAccountSave1_2Request.patientGender = "patientGender";
			portalAccountSave1_2Request.password = "password";
			portalAccountSave1_2Request.patientChartNumber = "patientChartNumber";
			portalAccountSave1_2Request.address1 = "address1";
			portalAccountSave1_2Request.address2 = "address2";
			portalAccountSave1_2Request.city = "Dublin";
			portalAccountSave1_2Request.state = "OH";
			portalAccountSave1_2Request.postal = "postal";
			portalAccountSave1_2Request.country = "country";
			portalAccountSave1_2Request.homeNbr = "homeNbr";
			portalAccountSave1_2Request.cellNbr = "cellNbr";
			portalAccountSave1_2Request.faxNbr = "faxNbr";
			portalAccountSave1_2Request.workNbr = "workNbr";
			portalAccountSave1_2Request.workNbrExt = "workNbrExt";
			portalAccountSave1_2Request.reminderMethodId = 1;
			portalAccountSave1_2Request.maritalStatus = "M";
			portalAccountSave1_2Request.prefProviderName = "prefProviderName";
			portalAccountSave1_2Request.language = "language";
			portalAccountSave1_2Request.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountSave1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountSave/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountSave1_2Response portalAccountSave1_2Response = javascriptSerializer.Deserialize<PortalAccountSave1_2Response>(jsonResponse);

			Console.WriteLine(portalAccountSave1_2Response.responseCode);
			Console.WriteLine(portalAccountSave1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountSave1_2Request : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountSave1_2Response : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountSave1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountSave1_2 codeSample = new UpdoxCodeSample_PortalAccountSave1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountSave1_2";

		PortalAccountSave1_2Request portalAccountSave1_2Request = new PortalAccountSave1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountSave1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountSave1_2Request.setPatientId("patientId");
		portalAccountSave1_2Request.setPatientFirstName("patientFirstName");
		portalAccountSave1_2Request.setPatientMiddleName("patientMiddleName");
		portalAccountSave1_2Request.setPatientLastName("patientLastName");
		portalAccountSave1_2Request.setSuffix("suffix");
		portalAccountSave1_2Request.setPatientEmail("test@test.com");
		portalAccountSave1_2Request.setPatientDob("patientDob");
		portalAccountSave1_2Request.setPatientGender("patientGender");
		portalAccountSave1_2Request.setPassword("password");
		portalAccountSave1_2Request.setPatientChartNumber("patientChartNumber");
		portalAccountSave1_2Request.setAddress1("address1");
		portalAccountSave1_2Request.setAddress2("address2");
		portalAccountSave1_2Request.setCity("Dublin");
		portalAccountSave1_2Request.setState("OH");
		portalAccountSave1_2Request.setPostal("postal");
		portalAccountSave1_2Request.setCountry("country");
		portalAccountSave1_2Request.setHomeNbr("homeNbr");
		portalAccountSave1_2Request.setCellNbr("cellNbr");
		portalAccountSave1_2Request.setFaxNbr("faxNbr");
		portalAccountSave1_2Request.setWorkNbr("workNbr");
		portalAccountSave1_2Request.setWorkNbrExt("workNbrExt");
		portalAccountSave1_2Request.setReminderMethodId(1);
		portalAccountSave1_2Request.setMaritalStatus("M");
		portalAccountSave1_2Request.setPrefProviderName("prefProviderName");
		portalAccountSave1_2Request.setLanguage("language");
		portalAccountSave1_2Request.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountSave1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountSave/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountSave1_2Response portalAccountSave1_2Response = mapper.readValue(jsonResponse, PortalAccountSave1_2Response.class);

		System.out.println(portalAccountSave1_2Response.getResponseCode());
		System.out.println(portalAccountSave1_2Response.getResponseMessage());
	}

	private class PortalAccountSave1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountSave1_2Response extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PortalAccountUpdate /io/PortalAccountUpdate

Updates a patient portal account for a patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountUpdate

Updates a patient portal account for a patient with the given patientId.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountUpdate codeSample = new UpdoxCodeSample_PortalAccountUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountUpdate";
			PortalAccountUpdateRequest portalAccountUpdateRequest = new PortalAccountUpdateRequest();

			//set up credentials
			portalAccountUpdateRequest.auth.applicationId = "applicationId";
			portalAccountUpdateRequest.auth.applicationPassword = "applicationPassword";
			portalAccountUpdateRequest.auth.accountId = "accountId";
			portalAccountUpdateRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountUpdateRequest.patientId = "patientId";
			portalAccountUpdateRequest.patientFirstName = "patientFirstName";
			portalAccountUpdateRequest.patientMiddleName = "patientMiddleName";
			portalAccountUpdateRequest.patientLastName = "patientLastName";
			portalAccountUpdateRequest.suffix = "suffix";
			portalAccountUpdateRequest.patientEmail = "test@test.com";
			portalAccountUpdateRequest.patientDob = "patientDob";
			portalAccountUpdateRequest.patientGender = "patientGender";
			portalAccountUpdateRequest.password = "password";
			portalAccountUpdateRequest.patientChartNumber = "patientChartNumber";
			portalAccountUpdateRequest.address1 = "address1";
			portalAccountUpdateRequest.address2 = "address2";
			portalAccountUpdateRequest.city = "Dublin";
			portalAccountUpdateRequest.state = "OH";
			portalAccountUpdateRequest.zip = "43017";
			portalAccountUpdateRequest.homeNbr = "homeNbr";
			portalAccountUpdateRequest.cellNbr = "cellNbr";
			portalAccountUpdateRequest.faxNbr = "faxNbr";
			portalAccountUpdateRequest.workNbr = "workNbr";
			portalAccountUpdateRequest.workNbrExt = "workNbrExt";
			portalAccountUpdateRequest.reminderMethodId = 1;
			portalAccountUpdateRequest.maritalStatus = "M";
			portalAccountUpdateRequest.prefProviderName = "prefProviderName";
			portalAccountUpdateRequest.language = "language";
			portalAccountUpdateRequest.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountUpdateResponse portalAccountUpdateResponse = javascriptSerializer.Deserialize<PortalAccountUpdateResponse>(jsonResponse);

			Console.WriteLine(portalAccountUpdateResponse.responseCode);
			Console.WriteLine(portalAccountUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountUpdateRequest : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountUpdateResponse : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountUpdate codeSample = new UpdoxCodeSample_PortalAccountUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountUpdate";

		PortalAccountUpdateRequest portalAccountUpdateRequest = new PortalAccountUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountUpdateRequest.setPatientId("patientId");
		portalAccountUpdateRequest.setPatientFirstName("patientFirstName");
		portalAccountUpdateRequest.setPatientMiddleName("patientMiddleName");
		portalAccountUpdateRequest.setPatientLastName("patientLastName");
		portalAccountUpdateRequest.setSuffix("suffix");
		portalAccountUpdateRequest.setPatientEmail("test@test.com");
		portalAccountUpdateRequest.setPatientDob("patientDob");
		portalAccountUpdateRequest.setPatientGender("patientGender");
		portalAccountUpdateRequest.setPassword("password");
		portalAccountUpdateRequest.setPatientChartNumber("patientChartNumber");
		portalAccountUpdateRequest.setAddress1("address1");
		portalAccountUpdateRequest.setAddress2("address2");
		portalAccountUpdateRequest.setCity("Dublin");
		portalAccountUpdateRequest.setState("OH");
		portalAccountUpdateRequest.setZip("43017");
		portalAccountUpdateRequest.setHomeNbr("homeNbr");
		portalAccountUpdateRequest.setCellNbr("cellNbr");
		portalAccountUpdateRequest.setFaxNbr("faxNbr");
		portalAccountUpdateRequest.setWorkNbr("workNbr");
		portalAccountUpdateRequest.setWorkNbrExt("workNbrExt");
		portalAccountUpdateRequest.setReminderMethodId(1);
		portalAccountUpdateRequest.setMaritalStatus("M");
		portalAccountUpdateRequest.setPrefProviderName("prefProviderName");
		portalAccountUpdateRequest.setLanguage("language");
		portalAccountUpdateRequest.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountUpdateResponse portalAccountUpdateResponse = mapper.readValue(jsonResponse, PortalAccountUpdateResponse.class);

		System.out.println(portalAccountUpdateResponse.getResponseCode());
		System.out.println(portalAccountUpdateResponse.getResponseMessage());
	}

	private class PortalAccountUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountUpdateResponse extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`

PortalAccountUpdate/1.1 /io/PortalAccountUpdate/1.1

Updates a patient portal account for a patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	Min length 2 characters. Max length 5 characters.
zip	String	The value must contain exactly 5 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountUpdate/1.1

Updates a patient portal account for a patient with the given patientId. Changes from v1.0 to v1.1: improved error handling when a patient is not found for the given patientId.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountUpdate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountUpdate1_1 codeSample = new UpdoxCodeSample_PortalAccountUpdate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountUpdate1_1";
			PortalAccountUpdate1_1Request portalAccountUpdate1_1Request = new PortalAccountUpdate1_1Request();

			//set up credentials
			portalAccountUpdate1_1Request.auth.applicationId = "applicationId";
			portalAccountUpdate1_1Request.auth.applicationPassword = "applicationPassword";
			portalAccountUpdate1_1Request.auth.accountId = "accountId";
			portalAccountUpdate1_1Request.auth.userId = "userId";

			//set up request specific parameters
			portalAccountUpdate1_1Request.patientId = "patientId";
			portalAccountUpdate1_1Request.patientFirstName = "patientFirstName";
			portalAccountUpdate1_1Request.patientMiddleName = "patientMiddleName";
			portalAccountUpdate1_1Request.patientLastName = "patientLastName";
			portalAccountUpdate1_1Request.suffix = "suffix";
			portalAccountUpdate1_1Request.patientEmail = "test@test.com";
			portalAccountUpdate1_1Request.patientDob = "patientDob";
			portalAccountUpdate1_1Request.patientGender = "patientGender";
			portalAccountUpdate1_1Request.password = "password";
			portalAccountUpdate1_1Request.patientChartNumber = "patientChartNumber";
			portalAccountUpdate1_1Request.address1 = "address1";
			portalAccountUpdate1_1Request.address2 = "address2";
			portalAccountUpdate1_1Request.city = "Dublin";
			portalAccountUpdate1_1Request.state = "OH";
			portalAccountUpdate1_1Request.zip = "43017";
			portalAccountUpdate1_1Request.homeNbr = "homeNbr";
			portalAccountUpdate1_1Request.cellNbr = "cellNbr";
			portalAccountUpdate1_1Request.faxNbr = "faxNbr";
			portalAccountUpdate1_1Request.workNbr = "workNbr";
			portalAccountUpdate1_1Request.workNbrExt = "workNbrExt";
			portalAccountUpdate1_1Request.reminderMethodId = 1;
			portalAccountUpdate1_1Request.maritalStatus = "M";
			portalAccountUpdate1_1Request.prefProviderName = "prefProviderName";
			portalAccountUpdate1_1Request.language = "language";
			portalAccountUpdate1_1Request.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountUpdate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountUpdate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountUpdate1_1Response portalAccountUpdate1_1Response = javascriptSerializer.Deserialize<PortalAccountUpdate1_1Response>(jsonResponse);

			Console.WriteLine(portalAccountUpdate1_1Response.responseCode);
			Console.WriteLine(portalAccountUpdate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountUpdate1_1Request : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string zip { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountUpdate1_1Response : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountUpdate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountUpdate1_1 codeSample = new UpdoxCodeSample_PortalAccountUpdate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountUpdate1_1";

		PortalAccountUpdate1_1Request portalAccountUpdate1_1Request = new PortalAccountUpdate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountUpdate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountUpdate1_1Request.setPatientId("patientId");
		portalAccountUpdate1_1Request.setPatientFirstName("patientFirstName");
		portalAccountUpdate1_1Request.setPatientMiddleName("patientMiddleName");
		portalAccountUpdate1_1Request.setPatientLastName("patientLastName");
		portalAccountUpdate1_1Request.setSuffix("suffix");
		portalAccountUpdate1_1Request.setPatientEmail("test@test.com");
		portalAccountUpdate1_1Request.setPatientDob("patientDob");
		portalAccountUpdate1_1Request.setPatientGender("patientGender");
		portalAccountUpdate1_1Request.setPassword("password");
		portalAccountUpdate1_1Request.setPatientChartNumber("patientChartNumber");
		portalAccountUpdate1_1Request.setAddress1("address1");
		portalAccountUpdate1_1Request.setAddress2("address2");
		portalAccountUpdate1_1Request.setCity("Dublin");
		portalAccountUpdate1_1Request.setState("OH");
		portalAccountUpdate1_1Request.setZip("43017");
		portalAccountUpdate1_1Request.setHomeNbr("homeNbr");
		portalAccountUpdate1_1Request.setCellNbr("cellNbr");
		portalAccountUpdate1_1Request.setFaxNbr("faxNbr");
		portalAccountUpdate1_1Request.setWorkNbr("workNbr");
		portalAccountUpdate1_1Request.setWorkNbrExt("workNbrExt");
		portalAccountUpdate1_1Request.setReminderMethodId(1);
		portalAccountUpdate1_1Request.setMaritalStatus("M");
		portalAccountUpdate1_1Request.setPrefProviderName("prefProviderName");
		portalAccountUpdate1_1Request.setLanguage("language");
		portalAccountUpdate1_1Request.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountUpdate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountUpdate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountUpdate1_1Response portalAccountUpdate1_1Response = mapper.readValue(jsonResponse, PortalAccountUpdate1_1Response.class);

		System.out.println(portalAccountUpdate1_1Response.getResponseCode());
		System.out.println(portalAccountUpdate1_1Response.getResponseMessage());
	}

	private class PortalAccountUpdate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String zip;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getZip() {
			return zip;
		}

		public void setZip(String zip) {
			this.zip = zip;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountUpdate1_1Response extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PortalAccountUpdate/1.2 /io/PortalAccountUpdate/1.2

Updates a patient portal account for a patient with the given patientId.

Changes from v1.1 to v1.2:

zip - renamed in request object to postal for better international address support
country - Added optional field which collects the country code for the account's address

Parameter	Type	Description
patientId	String	The ID of the new or existing patient. Min length 1 characters. Max length 40 characters. This is required.
patientFirstName	String	Max length 50 characters. This is required.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters. This is required.
suffix	String	Min length 1 characters. Max length 10 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. If not provided, the returned list will include all messages in the inbox.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters. This is required.
password	String	Max length 100 characters.
patientChartNumber	String	Min length 1 characters. Max length 64 characters.
address1	String	Min length 1 characters. Max length 100 characters.
address2	String	Min length 1 characters. Max length 100 characters.
city	String	Min length 1 characters. Max length 50 characters.
state	String	The account's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The account's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". . The value must contain exactly 2 characters.
homeNbr	String	Numbers only. The value must contain exactly 10 characters.
cellNbr	String	Numbers only. The value must contain exactly 10 characters.
faxNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbr	String	Numbers only. The value must contain exactly 10 characters.
workNbrExt	String	Numbers only. Min length 1 characters. Max length 8 characters.
reminderMethodId	Int	Reminder communication preference. 0=Practice Preference, 1=Email, 2=Home Phone, 3=Cell, 4=Text, 5=No reminders. Default is 0. The value must be between 0 and 5.
maritalStatus	String	single, married, divorced, widowed, other. Max length 8 characters.
prefProviderName	String	Preferred provider name. Max length 100 characters.
language	String	Language preference. Use one of the codes below: "ara" - Arabic "zho" - Chinese "eng" - English "fra" - French "cpf" - French Creole "deu" - German "ita" - Italian "kor" - Korean "cmn" - Mandarin "por" - Portuguese "rus" - Russian "som" - Somali "esp" - Spanish "tgl" - Tagalog "vie" - Vietnamese . Min length 1 characters. Max length 32 characters.
location	String	A location must be synced to Updox or created in the UI prior to setting this value for the portal account. Use the location code of the location. Min length 1 characters. Max length 100 characters.

Try it! Toggle Notes/Code Samples

PortalAccountUpdate/1.2

Updates a patient portal account for a patient with the given patientId.

Changes from v1.1 to v1.2:

zip - renamed in request object to postal for better international address support
country - Added optional field which collects the country code for the account's address

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountUpdate1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountUpdate1_2 codeSample = new UpdoxCodeSample_PortalAccountUpdate1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountUpdate1_2";
			PortalAccountUpdate1_2Request portalAccountUpdate1_2Request = new PortalAccountUpdate1_2Request();

			//set up credentials
			portalAccountUpdate1_2Request.auth.applicationId = "applicationId";
			portalAccountUpdate1_2Request.auth.applicationPassword = "applicationPassword";
			portalAccountUpdate1_2Request.auth.accountId = "accountId";
			portalAccountUpdate1_2Request.auth.userId = "userId";

			//set up request specific parameters
			portalAccountUpdate1_2Request.patientId = "patientId";
			portalAccountUpdate1_2Request.patientFirstName = "patientFirstName";
			portalAccountUpdate1_2Request.patientMiddleName = "patientMiddleName";
			portalAccountUpdate1_2Request.patientLastName = "patientLastName";
			portalAccountUpdate1_2Request.suffix = "suffix";
			portalAccountUpdate1_2Request.patientEmail = "test@test.com";
			portalAccountUpdate1_2Request.patientDob = "patientDob";
			portalAccountUpdate1_2Request.patientGender = "patientGender";
			portalAccountUpdate1_2Request.password = "password";
			portalAccountUpdate1_2Request.patientChartNumber = "patientChartNumber";
			portalAccountUpdate1_2Request.address1 = "address1";
			portalAccountUpdate1_2Request.address2 = "address2";
			portalAccountUpdate1_2Request.city = "Dublin";
			portalAccountUpdate1_2Request.state = "OH";
			portalAccountUpdate1_2Request.postal = "postal";
			portalAccountUpdate1_2Request.country = "country";
			portalAccountUpdate1_2Request.homeNbr = "homeNbr";
			portalAccountUpdate1_2Request.cellNbr = "cellNbr";
			portalAccountUpdate1_2Request.faxNbr = "faxNbr";
			portalAccountUpdate1_2Request.workNbr = "workNbr";
			portalAccountUpdate1_2Request.workNbrExt = "workNbrExt";
			portalAccountUpdate1_2Request.reminderMethodId = 1;
			portalAccountUpdate1_2Request.maritalStatus = "M";
			portalAccountUpdate1_2Request.prefProviderName = "prefProviderName";
			portalAccountUpdate1_2Request.language = "language";
			portalAccountUpdate1_2Request.location = "location";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountUpdate1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountUpdate/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountUpdate1_2Response portalAccountUpdate1_2Response = javascriptSerializer.Deserialize<PortalAccountUpdate1_2Response>(jsonResponse);

			Console.WriteLine(portalAccountUpdate1_2Response.responseCode);
			Console.WriteLine(portalAccountUpdate1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountUpdate1_2Request : UpdoxRequest {
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string suffix { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string password { get; set;}
			public string patientChartNumber { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string homeNbr { get; set;}
			public string cellNbr { get; set;}
			public string faxNbr { get; set;}
			public string workNbr { get; set;}
			public string workNbrExt { get; set;}
			public int reminderMethodId { get; set;}
			public string maritalStatus { get; set;}
			public string prefProviderName { get; set;}
			public string language { get; set;}
			public string location { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountUpdate1_2Response : UpdoxResponse {
			public string patientId { get; set;}
			public string action { get; set;}
			public string portalAddress { get; set;}
			public string username { get; set;}
			public string password { get; set;}
			public string verifyCode { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountUpdate1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountUpdate1_2 codeSample = new UpdoxCodeSample_PortalAccountUpdate1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountUpdate1_2";

		PortalAccountUpdate1_2Request portalAccountUpdate1_2Request = new PortalAccountUpdate1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountUpdate1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountUpdate1_2Request.setPatientId("patientId");
		portalAccountUpdate1_2Request.setPatientFirstName("patientFirstName");
		portalAccountUpdate1_2Request.setPatientMiddleName("patientMiddleName");
		portalAccountUpdate1_2Request.setPatientLastName("patientLastName");
		portalAccountUpdate1_2Request.setSuffix("suffix");
		portalAccountUpdate1_2Request.setPatientEmail("test@test.com");
		portalAccountUpdate1_2Request.setPatientDob("patientDob");
		portalAccountUpdate1_2Request.setPatientGender("patientGender");
		portalAccountUpdate1_2Request.setPassword("password");
		portalAccountUpdate1_2Request.setPatientChartNumber("patientChartNumber");
		portalAccountUpdate1_2Request.setAddress1("address1");
		portalAccountUpdate1_2Request.setAddress2("address2");
		portalAccountUpdate1_2Request.setCity("Dublin");
		portalAccountUpdate1_2Request.setState("OH");
		portalAccountUpdate1_2Request.setPostal("postal");
		portalAccountUpdate1_2Request.setCountry("country");
		portalAccountUpdate1_2Request.setHomeNbr("homeNbr");
		portalAccountUpdate1_2Request.setCellNbr("cellNbr");
		portalAccountUpdate1_2Request.setFaxNbr("faxNbr");
		portalAccountUpdate1_2Request.setWorkNbr("workNbr");
		portalAccountUpdate1_2Request.setWorkNbrExt("workNbrExt");
		portalAccountUpdate1_2Request.setReminderMethodId(1);
		portalAccountUpdate1_2Request.setMaritalStatus("M");
		portalAccountUpdate1_2Request.setPrefProviderName("prefProviderName");
		portalAccountUpdate1_2Request.setLanguage("language");
		portalAccountUpdate1_2Request.setLocation("location");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountUpdate1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountUpdate/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountUpdate1_2Response portalAccountUpdate1_2Response = mapper.readValue(jsonResponse, PortalAccountUpdate1_2Response.class);

		System.out.println(portalAccountUpdate1_2Response.getResponseCode());
		System.out.println(portalAccountUpdate1_2Response.getResponseMessage());
	}

	private class PortalAccountUpdate1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String suffix;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String password;
    	private String patientChartNumber;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String homeNbr;
    	private String cellNbr;
    	private String faxNbr;
    	private String workNbr;
    	private String workNbrExt;
    	private int reminderMethodId;
    	private String maritalStatus;
    	private String prefProviderName;
    	private String language;
    	private String location;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getSuffix() {
			return suffix;
		}

		public void setSuffix(String suffix) {
			this.suffix = suffix;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getHomeNbr() {
			return homeNbr;
		}

		public void setHomeNbr(String homeNbr) {
			this.homeNbr = homeNbr;
		}

		public String getCellNbr() {
			return cellNbr;
		}

		public void setCellNbr(String cellNbr) {
			this.cellNbr = cellNbr;
		}

		public String getFaxNbr() {
			return faxNbr;
		}

		public void setFaxNbr(String faxNbr) {
			this.faxNbr = faxNbr;
		}

		public String getWorkNbr() {
			return workNbr;
		}

		public void setWorkNbr(String workNbr) {
			this.workNbr = workNbr;
		}

		public String getWorkNbrExt() {
			return workNbrExt;
		}

		public void setWorkNbrExt(String workNbrExt) {
			this.workNbrExt = workNbrExt;
		}

		public int getReminderMethodId() {
			return reminderMethodId;
		}

		public void setReminderMethodId(int reminderMethodId) {
			this.reminderMethodId = reminderMethodId;
		}

		public String getMaritalStatus() {
			return maritalStatus;
		}

		public void setMaritalStatus(String maritalStatus) {
			this.maritalStatus = maritalStatus;
		}

		public String getPrefProviderName() {
			return prefProviderName;
		}

		public void setPrefProviderName(String prefProviderName) {
			this.prefProviderName = prefProviderName;
		}

		public String getLanguage() {
			return language;
		}

		public void setLanguage(String language) {
			this.language = language;
		}

		public String getLocation() {
			return location;
		}

		public void setLocation(String location) {
			this.location = location;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountUpdate1_2Response extends UpdoxResponse {
		private String patientId;
		private String action;
		private String portalAddress;
		private String username;
		private String password;
		private String verifyCode;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public String getPortalAddress() {
			return portalAddress;
		}

		public void setPortalAddress(String portalAddress) {
			this.portalAddress = portalAddress;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public String getVerifyCode() {
			return verifyCode;
		}

		public void setVerifyCode(String verifyCode) {
			this.verifyCode = verifyCode;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`

PortalAccountUpdateId /io/PortalAccountUpdateId

Changes the ID of the patient portal account with currentPatientId to newPatientId.

Parameter	Type	Value	Description
currentPatientId	String		The current ID of an existing patient. Min length 1 characters. Max length 40 characters. This is required.
newPatientId	String		The new ID to replace the current ID with for the existing patient. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalAccountUpdateId

Changes the ID of the patient portal account with currentPatientId to newPatientId.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalAccountUpdateId {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalAccountUpdateId codeSample = new UpdoxCodeSample_PortalAccountUpdateId();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalAccountUpdateId";
			PortalAccountUpdateIdRequest portalAccountUpdateIdRequest = new PortalAccountUpdateIdRequest();

			//set up credentials
			portalAccountUpdateIdRequest.auth.applicationId = "applicationId";
			portalAccountUpdateIdRequest.auth.applicationPassword = "applicationPassword";
			portalAccountUpdateIdRequest.auth.accountId = "accountId";
			portalAccountUpdateIdRequest.auth.userId = "userId";

			//set up request specific parameters
			portalAccountUpdateIdRequest.currentPatientId = "currentPatientId";
			portalAccountUpdateIdRequest.newPatientId = "newPatientId";

			//create the request
			string json = Utilities.buildRequestJson(portalAccountUpdateIdRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalAccountUpdateId", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalAccountUpdateIdResponse portalAccountUpdateIdResponse = javascriptSerializer.Deserialize<PortalAccountUpdateIdResponse>(jsonResponse);

			Console.WriteLine(portalAccountUpdateIdResponse.responseCode);
			Console.WriteLine(portalAccountUpdateIdResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalAccountUpdateIdRequest : UpdoxRequest {
			public string currentPatientId { get; set;}
			public string newPatientId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalAccountUpdateIdResponse : UpdoxResponse {
			public string patientId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalAccountUpdateId {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalAccountUpdateId codeSample = new UpdoxCodeSample_PortalAccountUpdateId();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalAccountUpdateId";

		PortalAccountUpdateIdRequest portalAccountUpdateIdRequest = new PortalAccountUpdateIdRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalAccountUpdateIdRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalAccountUpdateIdRequest.setCurrentPatientId("currentPatientId");
		portalAccountUpdateIdRequest.setNewPatientId("newPatientId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalAccountUpdateIdRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalAccountUpdateId', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalAccountUpdateIdResponse portalAccountUpdateIdResponse = mapper.readValue(jsonResponse, PortalAccountUpdateIdResponse.class);

		System.out.println(portalAccountUpdateIdResponse.getResponseCode());
		System.out.println(portalAccountUpdateIdResponse.getResponseMessage());
	}

	private class PortalAccountUpdateIdRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String currentPatientId;
    	private String newPatientId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getCurrentPatientId() {
			return currentPatientId;
		}

		public void setCurrentPatientId(String currentPatientId) {
			this.currentPatientId = currentPatientId;
		}

		public String getNewPatientId() {
			return newPatientId;
		}

		public void setNewPatientId(String newPatientId) {
			this.newPatientId = newPatientId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalAccountUpdateIdResponse extends UpdoxResponse {
		private String patientId;


		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4831`	`portal account does not exist`
`4830`	`portal account already exists`

PortalConfigure /io/PortalConfigure

Configure account portal settings

Parameter	Type	Description
enablePracticePortal	Boolean	Practice portal is enabled.
readNotifications	Boolean	Read notifications by patients on portal are sent back to practice.
createNewMessages	Boolean	Patients have the ability to send messages from portal to practice.
replyToMessages	Boolean	Patients have the ability to reply to messages on portal back to the practice.
fillOutForms	Boolean	Patients have the ability to fill out forms on the portal.
viewRecords	Boolean	Patients are able to view CCD records on the portal.
showContactInfo	Boolean	Show practice contact information on Home page of portal.
headerNameDisplayed	String	Show practice name at top of page. Max length 100 characters.
workNumber	String	Practice office number. The value must contain exactly 10 characters.
showWorkNumber	Boolean	Show practice work number on home page of portal.
faxNumber	String	Practice fax number. The value must contain exactly 10 characters.
showFaxNumber	Boolean	Show practice fax number on home page of portal.
emailAddress	String	Practice email address. Max length 100 characters. Must be a valid email address.
showEmail	Boolean	Show practice email address on home page of portal.
aboutUsText	String	Practice about us information.
addAboutUs	Boolean	Show practice about us information on home page of portal.
newAccountText	String	Additional text to add to the new account e-mail sent to a patient when a new account is created.
addNewAccountText	Boolean	Add additional new account e-mail text.
addNewMessageText	Boolean	Additional text to add to the new message e-mail sent to a patient when a new message arrives in their portal inbox.
newMessageText	String	Add the additional new message e-mail text.
showHours	Boolean	Show hours of operation on portal home page.
mondayHours	String	Hours of operation for Monday. Max length 10 characters.
tuesdayHours	String	Hours of operation for Tuesday. Max length 10 characters.
wednesdayHours	String	Hours of operation for Wednesday. Max length 10 characters.
thursdayHours	String	Hours of operation for Thursday. Max length 10 characters.
fridayHours	String	Hours of operation for Friday. Max length 10 characters.
saturdayHours	String	Hours of operation for Saturday. Max length 10 characters.
sundayHours	String	Hours of operation for Sunday. Max length 10 characters.

Try it! Toggle Notes/Code Samples

PortalConfigure

Configure account portal settings

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalConfigure {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalConfigure codeSample = new UpdoxCodeSample_PortalConfigure();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalConfigure";
			PortalConfigureRequest portalConfigureRequest = new PortalConfigureRequest();

			//set up credentials
			portalConfigureRequest.auth.applicationId = "applicationId";
			portalConfigureRequest.auth.applicationPassword = "applicationPassword";
			portalConfigureRequest.auth.accountId = "accountId";

			//set up request specific parameters
			portalConfigureRequest.enablePracticePortal = true;
			portalConfigureRequest.readNotifications = true;
			portalConfigureRequest.createNewMessages = true;
			portalConfigureRequest.replyToMessages = true;
			portalConfigureRequest.fillOutForms = true;
			portalConfigureRequest.viewRecords = true;
			portalConfigureRequest.showContactInfo = true;
			portalConfigureRequest.headerNameDisplayed = "headerNameDisplayed";
			portalConfigureRequest.workNumber = "workNumber";
			portalConfigureRequest.showWorkNumber = true;
			portalConfigureRequest.faxNumber = "faxNumber";
			portalConfigureRequest.showFaxNumber = true;
			portalConfigureRequest.emailAddress = "test@test.com";
			portalConfigureRequest.showEmail = true;
			portalConfigureRequest.aboutUsText = "aboutUsText";
			portalConfigureRequest.addAboutUs = true;
			portalConfigureRequest.newAccountText = "newAccountText";
			portalConfigureRequest.addNewAccountText = true;
			portalConfigureRequest.addNewMessageText = true;
			portalConfigureRequest.newMessageText = "newMessageText";
			portalConfigureRequest.showHours = true;
			portalConfigureRequest.mondayHours = "mondayHours";
			portalConfigureRequest.tuesdayHours = "tuesdayHours";
			portalConfigureRequest.wednesdayHours = "wednesdayHours";
			portalConfigureRequest.thursdayHours = "thursdayHours";
			portalConfigureRequest.fridayHours = "fridayHours";
			portalConfigureRequest.saturdayHours = "saturdayHours";
			portalConfigureRequest.sundayHours = "sundayHours";

			//create the request
			string json = Utilities.buildRequestJson(portalConfigureRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalConfigure", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalConfigureResponse portalConfigureResponse = javascriptSerializer.Deserialize<PortalConfigureResponse>(jsonResponse);

			Console.WriteLine(portalConfigureResponse.responseCode);
			Console.WriteLine(portalConfigureResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalConfigureRequest : UpdoxRequest {
			public bool enablePracticePortal { get; set;}
			public bool readNotifications { get; set;}
			public bool createNewMessages { get; set;}
			public bool replyToMessages { get; set;}
			public bool fillOutForms { get; set;}
			public bool viewRecords { get; set;}
			public bool showContactInfo { get; set;}
			public string headerNameDisplayed { get; set;}
			public string workNumber { get; set;}
			public bool showWorkNumber { get; set;}
			public string faxNumber { get; set;}
			public bool showFaxNumber { get; set;}
			public string emailAddress { get; set;}
			public bool showEmail { get; set;}
			public string aboutUsText { get; set;}
			public bool addAboutUs { get; set;}
			public string newAccountText { get; set;}
			public bool addNewAccountText { get; set;}
			public bool addNewMessageText { get; set;}
			public string newMessageText { get; set;}
			public bool showHours { get; set;}
			public string mondayHours { get; set;}
			public string tuesdayHours { get; set;}
			public string wednesdayHours { get; set;}
			public string thursdayHours { get; set;}
			public string fridayHours { get; set;}
			public string saturdayHours { get; set;}
			public string sundayHours { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalConfigureResponse : UpdoxResponse {
			public bool enablePracticePortal { get; set;}
			public bool readNotifications { get; set;}
			public bool createNewMessages { get; set;}
			public bool replyToMessages { get; set;}
			public bool fillOutForms { get; set;}
			public bool viewRecords { get; set;}
			public bool showContactInfo { get; set;}
			public string headerNameDisplayed { get; set;}
			public string workNumber { get; set;}
			public bool showWorkNumber { get; set;}
			public string faxNumber { get; set;}
			public bool showFaxNumber { get; set;}
			public string emailAddress { get; set;}
			public bool showEmail { get; set;}
			public bool addAboutUsText { get; set;}
			public string aboutUsText { get; set;}
			public bool addNewAccountText { get; set;}
			public string newAccountText { get; set;}
			public bool addNewMessageText { get; set;}
			public string newMessageText { get; set;}
			public bool showHours { get; set;}
			public string mondayHours { get; set;}
			public string tuesdayHours { get; set;}
			public string wednesdayHours { get; set;}
			public string thursdayHours { get; set;}
			public string fridayHours { get; set;}
			public string saturdayHours { get; set;}
			public string sundayHours { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalConfigure {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalConfigure codeSample = new UpdoxCodeSample_PortalConfigure();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalConfigure";

		PortalConfigureRequest portalConfigureRequest = new PortalConfigureRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalConfigureRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalConfigureRequest.setEnablePracticePortal(true);
		portalConfigureRequest.setReadNotifications(true);
		portalConfigureRequest.setCreateNewMessages(true);
		portalConfigureRequest.setReplyToMessages(true);
		portalConfigureRequest.setFillOutForms(true);
		portalConfigureRequest.setViewRecords(true);
		portalConfigureRequest.setShowContactInfo(true);
		portalConfigureRequest.setHeaderNameDisplayed("headerNameDisplayed");
		portalConfigureRequest.setWorkNumber("workNumber");
		portalConfigureRequest.setShowWorkNumber(true);
		portalConfigureRequest.setFaxNumber("faxNumber");
		portalConfigureRequest.setShowFaxNumber(true);
		portalConfigureRequest.setEmailAddress("test@test.com");
		portalConfigureRequest.setShowEmail(true);
		portalConfigureRequest.setAboutUsText("aboutUsText");
		portalConfigureRequest.setAddAboutUs(true);
		portalConfigureRequest.setNewAccountText("newAccountText");
		portalConfigureRequest.setAddNewAccountText(true);
		portalConfigureRequest.setAddNewMessageText(true);
		portalConfigureRequest.setNewMessageText("newMessageText");
		portalConfigureRequest.setShowHours(true);
		portalConfigureRequest.setMondayHours("mondayHours");
		portalConfigureRequest.setTuesdayHours("tuesdayHours");
		portalConfigureRequest.setWednesdayHours("wednesdayHours");
		portalConfigureRequest.setThursdayHours("thursdayHours");
		portalConfigureRequest.setFridayHours("fridayHours");
		portalConfigureRequest.setSaturdayHours("saturdayHours");
		portalConfigureRequest.setSundayHours("sundayHours");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalConfigureRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalConfigure', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalConfigureResponse portalConfigureResponse = mapper.readValue(jsonResponse, PortalConfigureResponse.class);

		System.out.println(portalConfigureResponse.getResponseCode());
		System.out.println(portalConfigureResponse.getResponseMessage());
	}

	private class PortalConfigureRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private boolean enablePracticePortal;
    	private boolean readNotifications;
    	private boolean createNewMessages;
    	private boolean replyToMessages;
    	private boolean fillOutForms;
    	private boolean viewRecords;
    	private boolean showContactInfo;
    	private String headerNameDisplayed;
    	private String workNumber;
    	private boolean showWorkNumber;
    	private String faxNumber;
    	private boolean showFaxNumber;
    	private String emailAddress;
    	private boolean showEmail;
    	private String aboutUsText;
    	private boolean addAboutUs;
    	private String newAccountText;
    	private boolean addNewAccountText;
    	private boolean addNewMessageText;
    	private String newMessageText;
    	private boolean showHours;
    	private String mondayHours;
    	private String tuesdayHours;
    	private String wednesdayHours;
    	private String thursdayHours;
    	private String fridayHours;
    	private String saturdayHours;
    	private String sundayHours;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public boolean isEnablePracticePortal() {
			return enablePracticePortal;
		}

		public void setEnablePracticePortal(boolean enablePracticePortal) {
			this.enablePracticePortal = enablePracticePortal;
		}

		public boolean isReadNotifications() {
			return readNotifications;
		}

		public void setReadNotifications(boolean readNotifications) {
			this.readNotifications = readNotifications;
		}

		public boolean isCreateNewMessages() {
			return createNewMessages;
		}

		public void setCreateNewMessages(boolean createNewMessages) {
			this.createNewMessages = createNewMessages;
		}

		public boolean isReplyToMessages() {
			return replyToMessages;
		}

		public void setReplyToMessages(boolean replyToMessages) {
			this.replyToMessages = replyToMessages;
		}

		public boolean isFillOutForms() {
			return fillOutForms;
		}

		public void setFillOutForms(boolean fillOutForms) {
			this.fillOutForms = fillOutForms;
		}

		public boolean isViewRecords() {
			return viewRecords;
		}

		public void setViewRecords(boolean viewRecords) {
			this.viewRecords = viewRecords;
		}

		public boolean isShowContactInfo() {
			return showContactInfo;
		}

		public void setShowContactInfo(boolean showContactInfo) {
			this.showContactInfo = showContactInfo;
		}

		public String getHeaderNameDisplayed() {
			return headerNameDisplayed;
		}

		public void setHeaderNameDisplayed(String headerNameDisplayed) {
			this.headerNameDisplayed = headerNameDisplayed;
		}

		public String getWorkNumber() {
			return workNumber;
		}

		public void setWorkNumber(String workNumber) {
			this.workNumber = workNumber;
		}

		public boolean isShowWorkNumber() {
			return showWorkNumber;
		}

		public void setShowWorkNumber(boolean showWorkNumber) {
			this.showWorkNumber = showWorkNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public boolean isShowFaxNumber() {
			return showFaxNumber;
		}

		public void setShowFaxNumber(boolean showFaxNumber) {
			this.showFaxNumber = showFaxNumber;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isShowEmail() {
			return showEmail;
		}

		public void setShowEmail(boolean showEmail) {
			this.showEmail = showEmail;
		}

		public String getAboutUsText() {
			return aboutUsText;
		}

		public void setAboutUsText(String aboutUsText) {
			this.aboutUsText = aboutUsText;
		}

		public boolean isAddAboutUs() {
			return addAboutUs;
		}

		public void setAddAboutUs(boolean addAboutUs) {
			this.addAboutUs = addAboutUs;
		}

		public String getNewAccountText() {
			return newAccountText;
		}

		public void setNewAccountText(String newAccountText) {
			this.newAccountText = newAccountText;
		}

		public boolean isAddNewAccountText() {
			return addNewAccountText;
		}

		public void setAddNewAccountText(boolean addNewAccountText) {
			this.addNewAccountText = addNewAccountText;
		}

		public boolean isAddNewMessageText() {
			return addNewMessageText;
		}

		public void setAddNewMessageText(boolean addNewMessageText) {
			this.addNewMessageText = addNewMessageText;
		}

		public String getNewMessageText() {
			return newMessageText;
		}

		public void setNewMessageText(String newMessageText) {
			this.newMessageText = newMessageText;
		}

		public boolean isShowHours() {
			return showHours;
		}

		public void setShowHours(boolean showHours) {
			this.showHours = showHours;
		}

		public String getMondayHours() {
			return mondayHours;
		}

		public void setMondayHours(String mondayHours) {
			this.mondayHours = mondayHours;
		}

		public String getTuesdayHours() {
			return tuesdayHours;
		}

		public void setTuesdayHours(String tuesdayHours) {
			this.tuesdayHours = tuesdayHours;
		}

		public String getWednesdayHours() {
			return wednesdayHours;
		}

		public void setWednesdayHours(String wednesdayHours) {
			this.wednesdayHours = wednesdayHours;
		}

		public String getThursdayHours() {
			return thursdayHours;
		}

		public void setThursdayHours(String thursdayHours) {
			this.thursdayHours = thursdayHours;
		}

		public String getFridayHours() {
			return fridayHours;
		}

		public void setFridayHours(String fridayHours) {
			this.fridayHours = fridayHours;
		}

		public String getSaturdayHours() {
			return saturdayHours;
		}

		public void setSaturdayHours(String saturdayHours) {
			this.saturdayHours = saturdayHours;
		}

		public String getSundayHours() {
			return sundayHours;
		}

		public void setSundayHours(String sundayHours) {
			this.sundayHours = sundayHours;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalConfigureResponse extends UpdoxResponse {
		private boolean enablePracticePortal;
		private boolean readNotifications;
		private boolean createNewMessages;
		private boolean replyToMessages;
		private boolean fillOutForms;
		private boolean viewRecords;
		private boolean showContactInfo;
		private String headerNameDisplayed;
		private String workNumber;
		private boolean showWorkNumber;
		private String faxNumber;
		private boolean showFaxNumber;
		private String emailAddress;
		private boolean showEmail;
		private boolean addAboutUsText;
		private String aboutUsText;
		private boolean addNewAccountText;
		private String newAccountText;
		private boolean addNewMessageText;
		private String newMessageText;
		private boolean showHours;
		private String mondayHours;
		private String tuesdayHours;
		private String wednesdayHours;
		private String thursdayHours;
		private String fridayHours;
		private String saturdayHours;
		private String sundayHours;


		public boolean isEnablePracticePortal() {
			return enablePracticePortal;
		}

		public void setEnablePracticePortal(boolean enablePracticePortal) {
			this.enablePracticePortal = enablePracticePortal;
		}

		public boolean isReadNotifications() {
			return readNotifications;
		}

		public void setReadNotifications(boolean readNotifications) {
			this.readNotifications = readNotifications;
		}

		public boolean isCreateNewMessages() {
			return createNewMessages;
		}

		public void setCreateNewMessages(boolean createNewMessages) {
			this.createNewMessages = createNewMessages;
		}

		public boolean isReplyToMessages() {
			return replyToMessages;
		}

		public void setReplyToMessages(boolean replyToMessages) {
			this.replyToMessages = replyToMessages;
		}

		public boolean isFillOutForms() {
			return fillOutForms;
		}

		public void setFillOutForms(boolean fillOutForms) {
			this.fillOutForms = fillOutForms;
		}

		public boolean isViewRecords() {
			return viewRecords;
		}

		public void setViewRecords(boolean viewRecords) {
			this.viewRecords = viewRecords;
		}

		public boolean isShowContactInfo() {
			return showContactInfo;
		}

		public void setShowContactInfo(boolean showContactInfo) {
			this.showContactInfo = showContactInfo;
		}

		public String getHeaderNameDisplayed() {
			return headerNameDisplayed;
		}

		public void setHeaderNameDisplayed(String headerNameDisplayed) {
			this.headerNameDisplayed = headerNameDisplayed;
		}

		public String getWorkNumber() {
			return workNumber;
		}

		public void setWorkNumber(String workNumber) {
			this.workNumber = workNumber;
		}

		public boolean isShowWorkNumber() {
			return showWorkNumber;
		}

		public void setShowWorkNumber(boolean showWorkNumber) {
			this.showWorkNumber = showWorkNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public boolean isShowFaxNumber() {
			return showFaxNumber;
		}

		public void setShowFaxNumber(boolean showFaxNumber) {
			this.showFaxNumber = showFaxNumber;
		}

		public String getEmailAddress() {
			return emailAddress;
		}

		public void setEmailAddress(String emailAddress) {
			this.emailAddress = emailAddress;
		}

		public boolean isShowEmail() {
			return showEmail;
		}

		public void setShowEmail(boolean showEmail) {
			this.showEmail = showEmail;
		}

		public boolean isAddAboutUsText() {
			return addAboutUsText;
		}

		public void setAddAboutUsText(boolean addAboutUsText) {
			this.addAboutUsText = addAboutUsText;
		}

		public String getAboutUsText() {
			return aboutUsText;
		}

		public void setAboutUsText(String aboutUsText) {
			this.aboutUsText = aboutUsText;
		}

		public boolean isAddNewAccountText() {
			return addNewAccountText;
		}

		public void setAddNewAccountText(boolean addNewAccountText) {
			this.addNewAccountText = addNewAccountText;
		}

		public String getNewAccountText() {
			return newAccountText;
		}

		public void setNewAccountText(String newAccountText) {
			this.newAccountText = newAccountText;
		}

		public boolean isAddNewMessageText() {
			return addNewMessageText;
		}

		public void setAddNewMessageText(boolean addNewMessageText) {
			this.addNewMessageText = addNewMessageText;
		}

		public String getNewMessageText() {
			return newMessageText;
		}

		public void setNewMessageText(String newMessageText) {
			this.newMessageText = newMessageText;
		}

		public boolean isShowHours() {
			return showHours;
		}

		public void setShowHours(boolean showHours) {
			this.showHours = showHours;
		}

		public String getMondayHours() {
			return mondayHours;
		}

		public void setMondayHours(String mondayHours) {
			this.mondayHours = mondayHours;
		}

		public String getTuesdayHours() {
			return tuesdayHours;
		}

		public void setTuesdayHours(String tuesdayHours) {
			this.tuesdayHours = tuesdayHours;
		}

		public String getWednesdayHours() {
			return wednesdayHours;
		}

		public void setWednesdayHours(String wednesdayHours) {
			this.wednesdayHours = wednesdayHours;
		}

		public String getThursdayHours() {
			return thursdayHours;
		}

		public void setThursdayHours(String thursdayHours) {
			this.thursdayHours = thursdayHours;
		}

		public String getFridayHours() {
			return fridayHours;
		}

		public void setFridayHours(String fridayHours) {
			this.fridayHours = fridayHours;
		}

		public String getSaturdayHours() {
			return saturdayHours;
		}

		public void setSaturdayHours(String saturdayHours) {
			this.saturdayHours = saturdayHours;
		}

		public String getSundayHours() {
			return sundayHours;
		}

		public void setSundayHours(String sundayHours) {
			this.sundayHours = sundayHours;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalLocationList /io/PortalLocationList

Get list of locations for practice

Outdated: A newer version of this endpoint is available.

Try it! Toggle Notes/Code Samples

PortalLocationList

Get list of locations for practice

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalLocationList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalLocationList codeSample = new UpdoxCodeSample_PortalLocationList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalLocationList";
			PortalLocationListRequest portalLocationListRequest = new PortalLocationListRequest();

			//set up credentials
			portalLocationListRequest.auth.applicationId = "applicationId";
			portalLocationListRequest.auth.applicationPassword = "applicationPassword";
			portalLocationListRequest.auth.accountId = "accountId";
			portalLocationListRequest.auth.userId = "userId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(portalLocationListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalLocationList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalLocationListResponse portalLocationListResponse = javascriptSerializer.Deserialize<PortalLocationListResponse>(jsonResponse);

			Console.WriteLine(portalLocationListResponse.responseCode);
			Console.WriteLine(portalLocationListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalLocationListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalPracticeLocationLimited1_0 {
			public long id { get; set;}
			public string code { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string dayPhone { get; set;}
			public string evePhone { get; set;}
			public string faxPhone { get; set;}
			public string email { get; set;}
		}

		public class PortalLocationListResponse : UpdoxResponse {
			public List<PortalPracticeLocationLimited1_0> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PortalLocationList {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalLocationList codeSample = new UpdoxCodeSample_PortalLocationList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalLocationList";

		PortalLocationListRequest portalLocationListRequest = new PortalLocationListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalLocationListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalLocationListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalLocationList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalLocationListResponse portalLocationListResponse = mapper.readValue(jsonResponse, PortalLocationListResponse.class);

		System.out.println(portalLocationListResponse.getResponseCode());
		System.out.println(portalLocationListResponse.getResponseMessage());
	}

	private class PortalLocationListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalPracticeLocationLimited1_0 {
		private long id;
		private String code;
		private String name;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String dayPhone;
		private String evePhone;
		private String faxPhone;
		private String email;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getDayPhone() {
			return dayPhone;
		}

		public void setDayPhone(String dayPhone) {
			this.dayPhone = dayPhone;
		}

		public String getEvePhone() {
			return evePhone;
		}

		public void setEvePhone(String evePhone) {
			this.evePhone = evePhone;
		}

		public String getFaxPhone() {
			return faxPhone;
		}

		public void setFaxPhone(String faxPhone) {
			this.faxPhone = faxPhone;
		}

		public String getEmail() {
			return email;
		}

		public void setEmail(String email) {
			this.email = email;
		}
	}

	private static class PortalLocationListResponse extends UpdoxResponse {
		private List<PortalPracticeLocationLimited1_0> locations;


		public List<PortalPracticeLocationLimited1_0> getLocations() {
			return locations;
		}

		public void setLocations(List<PortalPracticeLocationLimited1_0> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalLocationList/1.1 /io/PortalLocationList/1.1

Get list of locations for practice.

Changes from v1.0 to v1.1:

Individual authentication is disabled
Requires account-level authentication instead of full authentication
practices - Renamed in response object to locations
zip - Renamed in response object to postal for better international address support
country - Added field to response object that specifies the ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the location
active - Added field to response object to indicate whether the location is active or inactive
showInPortal - Added field to response object to indicate whether the location will be shown in the patient portal or not

Try it! Toggle Notes/Code Samples

PortalLocationList/1.1

Get list of locations for practice.

Changes from v1.0 to v1.1:

Individual authentication is disabled
Requires account-level authentication instead of full authentication
practices - Renamed in response object to locations
zip - Renamed in response object to postal for better international address support
country - Added field to response object that specifies the ISO 3166 Part 1, 2nd Edition, Alpha-2 country code of the location
active - Added field to response object to indicate whether the location is active or inactive
showInPortal - Added field to response object to indicate whether the location will be shown in the patient portal or not

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalLocationList1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalLocationList1_1 codeSample = new UpdoxCodeSample_PortalLocationList1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalLocationList1_1";
			PortalLocationList1_1Request portalLocationList1_1Request = new PortalLocationList1_1Request();

			//set up credentials
			portalLocationList1_1Request.auth.applicationId = "applicationId";
			portalLocationList1_1Request.auth.applicationPassword = "applicationPassword";
			portalLocationList1_1Request.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(portalLocationList1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalLocationList/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalLocationList1_1Response portalLocationList1_1Response = javascriptSerializer.Deserialize<PortalLocationList1_1Response>(jsonResponse);

			Console.WriteLine(portalLocationList1_1Response.responseCode);
			Console.WriteLine(portalLocationList1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PortalLocationList1_1Request : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalPracticeLocationLimited1_1 {
			public long id { get; set;}
			public string code { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string country { get; set;}
			public string dayPhone { get; set;}
			public string evePhone { get; set;}
			public string faxPhone { get; set;}
			public string email { get; set;}
			public bool active { get; set;}
			public bool showInPortal { get; set;}
		}

		public class PortalLocationList1_1Response : UpdoxResponse {
			public List<PortalPracticeLocationLimited1_1> locations { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PortalLocationList1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalLocationList1_1 codeSample = new UpdoxCodeSample_PortalLocationList1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalLocationList1_1";

		PortalLocationList1_1Request portalLocationList1_1Request = new PortalLocationList1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalLocationList1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalLocationList1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalLocationList/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalLocationList1_1Response portalLocationList1_1Response = mapper.readValue(jsonResponse, PortalLocationList1_1Response.class);

		System.out.println(portalLocationList1_1Response.getResponseCode());
		System.out.println(portalLocationList1_1Response.getResponseMessage());
	}

	private class PortalLocationList1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalPracticeLocationLimited1_1 {
		private long id;
		private String code;
		private String name;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String country;
		private String dayPhone;
		private String evePhone;
		private String faxPhone;
		private String email;
		private boolean active;
		private boolean showInPortal;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getDayPhone() {
			return dayPhone;
		}

		public void setDayPhone(String dayPhone) {
			this.dayPhone = dayPhone;
		}

		public String getEvePhone() {
			return evePhone;
		}

		public void setEvePhone(String evePhone) {
			this.evePhone = evePhone;
		}

		public String getFaxPhone() {
			return faxPhone;
		}

		public void setFaxPhone(String faxPhone) {
			this.faxPhone = faxPhone;
		}

		public String getEmail() {
			return email;
		}

		public void setEmail(String email) {
			this.email = email;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isShowInPortal() {
			return showInPortal;
		}

		public void setShowInPortal(boolean showInPortal) {
			this.showInPortal = showInPortal;
		}
	}

	private static class PortalLocationList1_1Response extends UpdoxResponse {
		private List<PortalPracticeLocationLimited1_1> locations;


		public List<PortalPracticeLocationLimited1_1> getLocations() {
			return locations;
		}

		public void setLocations(List<PortalPracticeLocationLimited1_1> locations) {
			this.locations = locations;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalMessageRemove /io/PortalMessageRemove

Remove a message

Parameter	Type	Value	Description
itemId	String		The ID of the message to remove. Min length 1 characters. Max length 40 characters. This is required.

Try it! Toggle Notes/Code Samples

PortalMessageRemove

Remove a message

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalMessageRemove {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalMessageRemove codeSample = new UpdoxCodeSample_PortalMessageRemove();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalMessageRemove";
			PortalMessageRemoveRequest portalMessageRemoveRequest = new PortalMessageRemoveRequest();

			//set up credentials
			portalMessageRemoveRequest.auth.applicationId = "applicationId";
			portalMessageRemoveRequest.auth.applicationPassword = "applicationPassword";
			portalMessageRemoveRequest.auth.accountId = "accountId";
			portalMessageRemoveRequest.auth.userId = "userId";

			//set up request specific parameters
			portalMessageRemoveRequest.itemId = "itemId";

			//create the request
			string json = Utilities.buildRequestJson(portalMessageRemoveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalMessageRemove", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalMessageRemoveResponse portalMessageRemoveResponse = javascriptSerializer.Deserialize<PortalMessageRemoveResponse>(jsonResponse);

			Console.WriteLine(portalMessageRemoveResponse.responseCode);
			Console.WriteLine(portalMessageRemoveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalMessageRemoveRequest : UpdoxRequest {
			public string itemId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PortalMessageRemoveResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalMessageRemove {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalMessageRemove codeSample = new UpdoxCodeSample_PortalMessageRemove();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalMessageRemove";

		PortalMessageRemoveRequest portalMessageRemoveRequest = new PortalMessageRemoveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalMessageRemoveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalMessageRemoveRequest.setItemId("itemId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalMessageRemoveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalMessageRemove', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalMessageRemoveResponse portalMessageRemoveResponse = mapper.readValue(jsonResponse, PortalMessageRemoveResponse.class);

		System.out.println(portalMessageRemoveResponse.getResponseCode());
		System.out.println(portalMessageRemoveResponse.getResponseMessage());
	}

	private class PortalMessageRemoveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String itemId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getItemId() {
			return itemId;
		}

		public void setItemId(String itemId) {
			this.itemId = itemId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalMessageRemoveResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalMessageSave /io/PortalMessageSave

Sends a single message to the Updox portal

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Parameter	Type	Value	Description
recipient	String		String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String		The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String		Max length 50 characters.
patientMiddleName	String		Max length 50 characters.
patientLastName	String		Max length 50 characters.
patientEmail	String		Max length 255 characters. Must be a valid email address.
patientDob	String		Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String		f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String		Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean		If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String		The subject line of the message. Max length 255 characters. This is required.
message	String		The plain text body of the message. This is required.
notifyTimeout	Int		The time, in hours, until the user is sent an unread alert for this message.
sendPortalNotification	Boolean		Set whether or not the patient should receive an email notification about this Portal operation. Defaults to TRUE.
timestamp	Long		Number of milliseconds since midnight 1/1/1970. Original date of the message. This is required.
unread	Boolean		Set whether the message has a status of unread. Defaults to FALSE.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

PortalMessageSave

Sends a single message to the Updox portal

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalMessageSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalMessageSave codeSample = new UpdoxCodeSample_PortalMessageSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalMessageSave";
			PortalMessageSaveRequest portalMessageSaveRequest = new PortalMessageSaveRequest();

			//set up credentials
			portalMessageSaveRequest.auth.applicationId = "applicationId";
			portalMessageSaveRequest.auth.applicationPassword = "applicationPassword";
			portalMessageSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			portalMessageSaveRequest.recipient = "recipient";
			portalMessageSaveRequest.patientId = "patientId";
			portalMessageSaveRequest.patientFirstName = "patientFirstName";
			portalMessageSaveRequest.patientMiddleName = "patientMiddleName";
			portalMessageSaveRequest.patientLastName = "patientLastName";
			portalMessageSaveRequest.patientEmail = "test@test.com";
			portalMessageSaveRequest.patientDob = "patientDob";
			portalMessageSaveRequest.patientGender = "patientGender";
			portalMessageSaveRequest.patientChartNumber = "patientChartNumber";
			portalMessageSaveRequest.createPatientWhenNecessary = true;
			portalMessageSaveRequest.subject = "subject";
			portalMessageSaveRequest.message = "message";
			portalMessageSaveRequest.notifyTimeout = 1;
			portalMessageSaveRequest.sendPortalNotification = true;
			portalMessageSaveRequest.timestamp = 1L;
			portalMessageSaveRequest.unread = true;
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			portalMessageSaveRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(portalMessageSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalMessageSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalMessageSaveResponse portalMessageSaveResponse = javascriptSerializer.Deserialize<PortalMessageSaveResponse>(jsonResponse);

			Console.WriteLine(portalMessageSaveResponse.responseCode);
			Console.WriteLine(portalMessageSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class PortalMessageSaveRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public bool sendPortalNotification { get; set;}
			public long timestamp { get; set;}
			public bool unread { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalMessageResponse {
			public bool success { get; set;}
			public string recipientId { get; set;}
			public string messageId { get; set;}
			public long updoxMessageId { get; set;}
		}

		public class PortalMessageSaveResponse : UpdoxResponse {
			public List<PortalMessageResponse> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PortalMessageSave {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalMessageSave codeSample = new UpdoxCodeSample_PortalMessageSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalMessageSave";

		PortalMessageSaveRequest portalMessageSaveRequest = new PortalMessageSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalMessageSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalMessageSaveRequest.setRecipient("recipient");
		portalMessageSaveRequest.setPatientId("patientId");
		portalMessageSaveRequest.setPatientFirstName("patientFirstName");
		portalMessageSaveRequest.setPatientMiddleName("patientMiddleName");
		portalMessageSaveRequest.setPatientLastName("patientLastName");
		portalMessageSaveRequest.setPatientEmail("test@test.com");
		portalMessageSaveRequest.setPatientDob("patientDob");
		portalMessageSaveRequest.setPatientGender("patientGender");
		portalMessageSaveRequest.setPatientChartNumber("patientChartNumber");
		portalMessageSaveRequest.setCreatePatientWhenNecessary(true);
		portalMessageSaveRequest.setSubject("subject");
		portalMessageSaveRequest.setMessage("message");
		portalMessageSaveRequest.setNotifyTimeout(1);
		portalMessageSaveRequest.setSendPortalNotification(true);
		portalMessageSaveRequest.setTimestamp(1L);
		portalMessageSaveRequest.setUnread(true);
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		portalMessageSaveRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalMessageSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalMessageSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalMessageSaveResponse portalMessageSaveResponse = mapper.readValue(jsonResponse, PortalMessageSaveResponse.class);

		System.out.println(portalMessageSaveResponse.getResponseCode());
		System.out.println(portalMessageSaveResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class PortalMessageSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String patientChartNumber;
    	private boolean createPatientWhenNecessary;
    	private String subject;
    	private String message;
    	private int notifyTimeout;
    	private Boolean sendPortalNotification;
    	private Long timestamp;
    	private Boolean unread;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}

		public Long getTimestamp() {
			return timestamp;
		}

		public void setTimestamp(Long timestamp) {
			this.timestamp = timestamp;
		}

		public Boolean isUnread() {
			return unread;
		}

		public void setUnread(Boolean unread) {
			this.unread = unread;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalMessageResponse {
		private boolean success;
		private String recipientId;
		private String messageId;
		private long updoxMessageId;


		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getRecipientId() {
			return recipientId;
		}

		public void setRecipientId(String recipientId) {
			this.recipientId = recipientId;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public long getUpdoxMessageId() {
			return updoxMessageId;
		}

		public void setUpdoxMessageId(long updoxMessageId) {
			this.updoxMessageId = updoxMessageId;
		}
	}

	private static class PortalMessageSaveResponse extends UpdoxResponse {
		private List<PortalMessageResponse> results;


		public List<PortalMessageResponse> getResults() {
			return results;
		}

		public void setResults(List<PortalMessageResponse> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`

PortalMessageSync /io/PortalMessageSync

Sends bulk messages to the Updox portal

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Parameter	Type	Value	Description
messageList	List	add remove	The list of messages to sync.

recipient	String		String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String		The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String		Max length 50 characters.
patientMiddleName	String		Max length 50 characters.
patientLastName	String		Max length 50 characters.
patientEmail	String		Max length 255 characters. Must be a valid email address.
patientDob	String		Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String		f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String		Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean		If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String		The subject line of the message. Max length 255 characters. This is required.
message	String		The plain text body of the message. This is required.
notifyTimeout	Int		The time, in hours, until the user is sent an unread alert for this message.
sendPortalNotification	Boolean		Set whether or not the patient should receive an email notification about this Portal operation. Defaults to TRUE.
timestamp	Long		Number of milliseconds since midnight 1/1/1970. Original date of the message. This is required.
unread	Boolean		Set whether the message has a status of unread. Defaults to FALSE.
id	String		The Partner ID of the message. This is required.
userId	String		The sender's User ID. If the user cannot be found or is not provided, then we will default to the practice.

Try it! Toggle Notes/Code Samples

PortalMessageSync

Sends bulk messages to the Updox portal

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalMessageSync {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalMessageSync codeSample = new UpdoxCodeSample_PortalMessageSync();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalMessageSync";
			PortalMessageSyncRequest portalMessageSyncRequest = new PortalMessageSyncRequest();

			//set up credentials
			portalMessageSyncRequest.auth.applicationId = "applicationId";
			portalMessageSyncRequest.auth.applicationPassword = "applicationPassword";
			portalMessageSyncRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<PortalSyncMessage> messageList = new List<PortalSyncMessage>();
			PortalSyncMessage portalSyncMessage = new PortalSyncMessage();
			portalSyncMessage.recipient = "recipient";
			portalSyncMessage.patientId = "patientId";
			portalSyncMessage.patientFirstName = "patientFirstName";
			portalSyncMessage.patientMiddleName = "patientMiddleName";
			portalSyncMessage.patientLastName = "patientLastName";
			portalSyncMessage.patientEmail = "test@test.com";
			portalSyncMessage.patientDob = "patientDob";
			portalSyncMessage.patientGender = "patientGender";
			portalSyncMessage.patientChartNumber = "patientChartNumber";
			portalSyncMessage.createPatientWhenNecessary = true;
			portalSyncMessage.subject = "subject";
			portalSyncMessage.message = "message";
			portalSyncMessage.notifyTimeout = 1;
			portalSyncMessage.sendPortalNotification = true;
			portalSyncMessage.timestamp = 1L;
			portalSyncMessage.unread = true;
			portalSyncMessage.id = "id";
			portalSyncMessage.userId = "userId";
			messageList.Add(portalSyncMessage);
			portalMessageSyncRequest.messageList = messageList;

			//create the request
			string json = Utilities.buildRequestJson(portalMessageSyncRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalMessageSync", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalMessageSyncResponse portalMessageSyncResponse = javascriptSerializer.Deserialize<PortalMessageSyncResponse>(jsonResponse);

			Console.WriteLine(portalMessageSyncResponse.responseCode);
			Console.WriteLine(portalMessageSyncResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalSyncMessage {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public bool sendPortalNotification { get; set;}
			public long timestamp { get; set;}
			public bool unread { get; set;}
			public string id { get; set;}
			public string userId { get; set;}
		}

		public class PortalMessageSyncRequest : UpdoxRequest {
			public List<PortalSyncMessage> messageList { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalMessageResponse {
			public bool success { get; set;}
			public string recipientId { get; set;}
			public string messageId { get; set;}
			public long updoxMessageId { get; set;}
		}

		public class PortalMessageSyncResponse : UpdoxResponse {
			public List<PortalMessageResponse> results { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PortalMessageSync {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalMessageSync codeSample = new UpdoxCodeSample_PortalMessageSync();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalMessageSync";

		PortalMessageSyncRequest portalMessageSyncRequest = new PortalMessageSyncRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalMessageSyncRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<PortalSyncMessage> messageList = new ArrayList<>();
		PortalSyncMessage portalSyncMessage = new PortalSyncMessage();
		portalSyncMessage.setRecipient("recipient");
		portalSyncMessage.setPatientId("patientId");
		portalSyncMessage.setPatientFirstName("patientFirstName");
		portalSyncMessage.setPatientMiddleName("patientMiddleName");
		portalSyncMessage.setPatientLastName("patientLastName");
		portalSyncMessage.setPatientEmail("test@test.com");
		portalSyncMessage.setPatientDob("patientDob");
		portalSyncMessage.setPatientGender("patientGender");
		portalSyncMessage.setPatientChartNumber("patientChartNumber");
		portalSyncMessage.setCreatePatientWhenNecessary(true);
		portalSyncMessage.setSubject("subject");
		portalSyncMessage.setMessage("message");
		portalSyncMessage.setNotifyTimeout(1);
		portalSyncMessage.setSendPortalNotification(true);
		portalSyncMessage.setTimestamp(1L);
		portalSyncMessage.setUnread(true);
		portalSyncMessage.setId("id");
		portalSyncMessage.setUserId("userId");
		messageList.add(portalSyncMessage);
		portalMessageSyncRequest.setMessageList(messageList);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalMessageSyncRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalMessageSync', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalMessageSyncResponse portalMessageSyncResponse = mapper.readValue(jsonResponse, PortalMessageSyncResponse.class);

		System.out.println(portalMessageSyncResponse.getResponseCode());
		System.out.println(portalMessageSyncResponse.getResponseMessage());
	}

	private static class PortalSyncMessage {
		private String recipient;
		private String patientId;
		private String patientFirstName;
		private String patientMiddleName;
		private String patientLastName;
		private String patientEmail;
		private String patientDob;
		private String patientGender;
		private String patientChartNumber;
		private boolean createPatientWhenNecessary;
		private String subject;
		private String message;
		private int notifyTimeout;
		private Boolean sendPortalNotification;
		private Long timestamp;
		private Boolean unread;
		private String id;
		private String userId;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}

		public Long getTimestamp() {
			return timestamp;
		}

		public void setTimestamp(Long timestamp) {
			this.timestamp = timestamp;
		}

		public Boolean isUnread() {
			return unread;
		}

		public void setUnread(Boolean unread) {
			this.unread = unread;
		}

		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private class PortalMessageSyncRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<PortalSyncMessage> messageList;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<PortalSyncMessage> getMessageList() {
			return messageList;
		}

		public void setMessageList(List<PortalSyncMessage> messageList) {
			this.messageList = messageList;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalMessageResponse {
		private boolean success;
		private String recipientId;
		private String messageId;
		private long updoxMessageId;


		public boolean isSuccess() {
			return success;
		}

		public void setSuccess(boolean success) {
			this.success = success;
		}

		public String getRecipientId() {
			return recipientId;
		}

		public void setRecipientId(String recipientId) {
			this.recipientId = recipientId;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}

		public long getUpdoxMessageId() {
			return updoxMessageId;
		}

		public void setUpdoxMessageId(long updoxMessageId) {
			this.updoxMessageId = updoxMessageId;
		}
	}

	private static class PortalMessageSyncResponse extends UpdoxResponse {
		private List<PortalMessageResponse> results;


		public List<PortalMessageResponse> getResults() {
			return results;
		}

		public void setResults(List<PortalMessageResponse> results) {
			this.results = results;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`

PortalRecordSave /io/PortalRecordSave

Save a record message to the portal account of the patient with the given patientId, record must be xml format. This record will be sent from the user with the userId given in auth. If no userId given, from will be present as practice.

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Parameter	Type	Description
recipient	String	String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String	The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String	Max length 50 characters.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String	Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean	If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String	The subject line of the message. Max length 100 characters.
message	String	The plain text body of the message.
notifyTimeout	Int	The time, in hours, until the user is sent an unread alert for this message.
fileName	String	The file name of the attachment (e.g. connie_smith_ccr.xml). This is required.
file	String	The contents of the attachment base64-encoded. The attachment must be xml file. This is required.
recordType	String	The record type of the attachment. Must be one of the following values: ccr, ccd, ccda, c32. This is required.
createPortalWhenNecessary	Boolean	If true, the sending patient's portal account will be created if no portal account exists for the patient ID in `recipient` or `patientId`, or if also creating a patient in this call.
sendPortalMessage	Boolean	If true, the provided parameters will be used to send a portal message to the patient.
sendPortalNotification	Boolean	Set whether or not the patient should receive an email notification about this Portal operation. Defaults to TRUE.
unread	Boolean	If true, the portal message come with this record will be marked as unread.
datetime	String	Datetime this record is created. Format yyyy-mm-dd HH:mm:ss. If not provided, it will default to current datetime.

Try it! Toggle Notes/Code Samples

PortalRecordSave

Outdated: As of October 2024, this API is a custom implementation that Updox is not currently expanding support for.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalRecordSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalRecordSave codeSample = new UpdoxCodeSample_PortalRecordSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalRecordSave";
			PortalRecordSaveRequest portalRecordSaveRequest = new PortalRecordSaveRequest();

			//set up credentials
			portalRecordSaveRequest.auth.applicationId = "applicationId";
			portalRecordSaveRequest.auth.applicationPassword = "applicationPassword";
			portalRecordSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			portalRecordSaveRequest.recipient = "recipient";
			portalRecordSaveRequest.patientId = "patientId";
			portalRecordSaveRequest.patientFirstName = "patientFirstName";
			portalRecordSaveRequest.patientMiddleName = "patientMiddleName";
			portalRecordSaveRequest.patientLastName = "patientLastName";
			portalRecordSaveRequest.patientEmail = "test@test.com";
			portalRecordSaveRequest.patientDob = "patientDob";
			portalRecordSaveRequest.patientGender = "patientGender";
			portalRecordSaveRequest.patientChartNumber = "patientChartNumber";
			portalRecordSaveRequest.createPatientWhenNecessary = true;
			portalRecordSaveRequest.subject = "subject";
			portalRecordSaveRequest.message = "message";
			portalRecordSaveRequest.notifyTimeout = 1;
			portalRecordSaveRequest.fileName = "fileName";
			portalRecordSaveRequest.file = "file";
			portalRecordSaveRequest.recordType = "recordType";
			portalRecordSaveRequest.createPortalWhenNecessary = true;
			portalRecordSaveRequest.sendPortalMessage = true;
			portalRecordSaveRequest.sendPortalNotification = true;
			portalRecordSaveRequest.unread = true;
			portalRecordSaveRequest.datetime = "datetime";

			//create the request
			string json = Utilities.buildRequestJson(portalRecordSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalRecordSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalRecordSaveResponse portalRecordSaveResponse = javascriptSerializer.Deserialize<PortalRecordSaveResponse>(jsonResponse);

			Console.WriteLine(portalRecordSaveResponse.responseCode);
			Console.WriteLine(portalRecordSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalRecordSaveRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public string fileName { get; set;}
			public string file { get; set;}
			public string recordType { get; set;}
			public bool createPortalWhenNecessary { get; set;}
			public bool sendPortalMessage { get; set;}
			public bool sendPortalNotification { get; set;}
			public bool unread { get; set;}
			public string datetime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalRecordSaveResponse : UpdoxResponse {
			public Object results { get; set;}
			public string recipient { get; set;}
			public long actionId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalRecordSave {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalRecordSave codeSample = new UpdoxCodeSample_PortalRecordSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalRecordSave";

		PortalRecordSaveRequest portalRecordSaveRequest = new PortalRecordSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalRecordSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		portalRecordSaveRequest.setRecipient("recipient");
		portalRecordSaveRequest.setPatientId("patientId");
		portalRecordSaveRequest.setPatientFirstName("patientFirstName");
		portalRecordSaveRequest.setPatientMiddleName("patientMiddleName");
		portalRecordSaveRequest.setPatientLastName("patientLastName");
		portalRecordSaveRequest.setPatientEmail("test@test.com");
		portalRecordSaveRequest.setPatientDob("patientDob");
		portalRecordSaveRequest.setPatientGender("patientGender");
		portalRecordSaveRequest.setPatientChartNumber("patientChartNumber");
		portalRecordSaveRequest.setCreatePatientWhenNecessary(true);
		portalRecordSaveRequest.setSubject("subject");
		portalRecordSaveRequest.setMessage("message");
		portalRecordSaveRequest.setNotifyTimeout(1);
		portalRecordSaveRequest.setFileName("fileName");
		portalRecordSaveRequest.setFile("file");
		portalRecordSaveRequest.setRecordType("recordType");
		portalRecordSaveRequest.setCreatePortalWhenNecessary(true);
		portalRecordSaveRequest.setSendPortalMessage(true);
		portalRecordSaveRequest.setSendPortalNotification(true);
		portalRecordSaveRequest.setUnread(true);
		portalRecordSaveRequest.setDatetime("datetime");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalRecordSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalRecordSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalRecordSaveResponse portalRecordSaveResponse = mapper.readValue(jsonResponse, PortalRecordSaveResponse.class);

		System.out.println(portalRecordSaveResponse.getResponseCode());
		System.out.println(portalRecordSaveResponse.getResponseMessage());
	}

	private class PortalRecordSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String patientChartNumber;
    	private boolean createPatientWhenNecessary;
    	private String subject;
    	private String message;
    	private int notifyTimeout;
    	private String fileName;
    	private String file;
    	private String recordType;
    	private boolean createPortalWhenNecessary;
    	private boolean sendPortalMessage;
    	private Boolean sendPortalNotification;
    	private boolean unread;
    	private String datetime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getFile() {
			return file;
		}

		public void setFile(String file) {
			this.file = file;
		}

		public String getRecordType() {
			return recordType;
		}

		public void setRecordType(String recordType) {
			this.recordType = recordType;
		}

		public boolean isCreatePortalWhenNecessary() {
			return createPortalWhenNecessary;
		}

		public void setCreatePortalWhenNecessary(boolean createPortalWhenNecessary) {
			this.createPortalWhenNecessary = createPortalWhenNecessary;
		}

		public boolean isSendPortalMessage() {
			return sendPortalMessage;
		}

		public void setSendPortalMessage(boolean sendPortalMessage) {
			this.sendPortalMessage = sendPortalMessage;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}

		public boolean isUnread() {
			return unread;
		}

		public void setUnread(boolean unread) {
			this.unread = unread;
		}

		public String getDatetime() {
			return datetime;
		}

		public void setDatetime(String datetime) {
			this.datetime = datetime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class PortalRecordSaveResponse extends UpdoxResponse {
		private Object results;
		private String recipient;
		private long actionId;


		public Object getResults() {
			return results;
		}

		public void setResults(Object results) {
			this.results = results;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public long getActionId() {
			return actionId;
		}

		public void setActionId(long actionId) {
			this.actionId = actionId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4070`	`Invalid recipient`
`4231`	`user does not exist`
`4131`	`account does not exist`
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`
`4000`	`Bad Request`

PortalRetrieveConfig /io/PortalRetrieveConfig

Retrieve current account portal settings.

Field mapping between PortalRetrieveConfig response and PortalConfigure request:

portalEnabled = enablePracticePortal
invites.showCustomInviteMessage = addNewAccountText
invites.customInviteMessage = newAccountText
invites.showCustomOnCommunicationMessage = addNewMessageText
invites.customOnCommunicationMessageCustom = newMessageText
aboutUs.show = addAboutUs
aboutUs.text = aboutUsText
aboutUs.headerName = headerNameDisplayed
aboutUs.contactInfo.show = showContactInfo
aboutUs.contactInfo.showEmail = showEmail
aboutUs.contactInfo.email = emailAddress
aboutUs.contactInfo.showFaxNumber = showFaxNumber
aboutUs.contactInfo.faxNumber = faxNumber
aboutUs.contactInfo.showPhoneNumber = showWorkNumber
aboutUs.contactInfo.workNumber = workNumber
aboutUs.hours.shown = showHours
aboutUs.hours.monday = mondayHours
aboutUs.hours.tuesday = tuesdayHours
aboutUs.hours.wednesday = wednesdayHours
aboutUs.hours.thursday = thursdayHours
aboutUs.hours.friday = fridayHours
aboutUs.hours.saturday = saturdayHours
aboutUs.hours.sunday = sundayHours
permissions.showRecords = viewRecords
permissions.showForms = fillOutForms
permissions.showNotifications = readNotifications
permissions.showMessageCreate = createNewMessages
permissions.showMessageReply = replyToMessages

Try it! Toggle Notes/Code Samples

PortalRetrieveConfig

Retrieve current account portal settings.

Field mapping between PortalRetrieveConfig response and PortalConfigure request:

portalEnabled = enablePracticePortal
invites.showCustomInviteMessage = addNewAccountText
invites.customInviteMessage = newAccountText
invites.showCustomOnCommunicationMessage = addNewMessageText
invites.customOnCommunicationMessageCustom = newMessageText
aboutUs.show = addAboutUs
aboutUs.text = aboutUsText
aboutUs.headerName = headerNameDisplayed
aboutUs.contactInfo.show = showContactInfo
aboutUs.contactInfo.showEmail = showEmail
aboutUs.contactInfo.email = emailAddress
aboutUs.contactInfo.showFaxNumber = showFaxNumber
aboutUs.contactInfo.faxNumber = faxNumber
aboutUs.contactInfo.showPhoneNumber = showWorkNumber
aboutUs.contactInfo.workNumber = workNumber
aboutUs.hours.shown = showHours
aboutUs.hours.monday = mondayHours
aboutUs.hours.tuesday = tuesdayHours
aboutUs.hours.wednesday = wednesdayHours
aboutUs.hours.thursday = thursdayHours
aboutUs.hours.friday = fridayHours
aboutUs.hours.saturday = saturdayHours
aboutUs.hours.sunday = sundayHours
permissions.showRecords = viewRecords
permissions.showForms = fillOutForms
permissions.showNotifications = readNotifications
permissions.showMessageCreate = createNewMessages
permissions.showMessageReply = replyToMessages

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalRetrieveConfig {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalRetrieveConfig codeSample = new UpdoxCodeSample_PortalRetrieveConfig();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalRetrieveConfig";
			PortalRetrieveConfigRequest portalRetrieveConfigRequest = new PortalRetrieveConfigRequest();

			//set up credentials
			portalRetrieveConfigRequest.auth.applicationId = "applicationId";
			portalRetrieveConfigRequest.auth.applicationPassword = "applicationPassword";
			portalRetrieveConfigRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(portalRetrieveConfigRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalRetrieveConfig", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalRetrieveConfigResponse portalRetrieveConfigResponse = javascriptSerializer.Deserialize<PortalRetrieveConfigResponse>(jsonResponse);

			Console.WriteLine(portalRetrieveConfigResponse.responseCode);
			Console.WriteLine(portalRetrieveConfigResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalRetrieveConfigRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Invites {
			public bool showCustomInviteMessage { get; set;}
			public string customInviteMessage { get; set;}
			public bool showCustomOnCommunicationMessage { get; set;}
			public string customOnCommunicationMessageCustom { get; set;}
		}

		public class PortalContactInfo {
			public bool show { get; set;}
			public bool showEmail { get; set;}
			public string email { get; set;}
			public bool showFaxNumber { get; set;}
			public string faxNumber { get; set;}
			public bool showPhoneNumber { get; set;}
			public string workNumber { get; set;}
		}

		public class Hours {
			public bool shown { get; set;}
			public string monday { get; set;}
			public string tuesday { get; set;}
			public string wednesday { get; set;}
			public string thursday { get; set;}
			public string friday { get; set;}
			public string saturday { get; set;}
			public string sunday { get; set;}
		}

		public class AboutUs {
			public bool show { get; set;}
			public string text { get; set;}
			public string headerName { get; set;}
			public PortalContactInfo contactInfo { get; set;}
			public Hours hours { get; set;}
		}

		public class Permissions {
			public bool showRecords { get; set;}
			public bool showForms { get; set;}
			public bool showNotifications { get; set;}
			public bool showMessageCreate { get; set;}
			public bool showMessageReply { get; set;}
		}

		public class PortalRetrieveConfigResponse : UpdoxResponse {
			public bool portalEnabled { get; set;}
			public Invites invites { get; set;}
			public AboutUs aboutUs { get; set;}
			public Permissions permissions { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalRetrieveConfig {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalRetrieveConfig codeSample = new UpdoxCodeSample_PortalRetrieveConfig();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalRetrieveConfig";

		PortalRetrieveConfigRequest portalRetrieveConfigRequest = new PortalRetrieveConfigRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalRetrieveConfigRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalRetrieveConfigRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalRetrieveConfig', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalRetrieveConfigResponse portalRetrieveConfigResponse = mapper.readValue(jsonResponse, PortalRetrieveConfigResponse.class);

		System.out.println(portalRetrieveConfigResponse.getResponseCode());
		System.out.println(portalRetrieveConfigResponse.getResponseMessage());
	}

	private class PortalRetrieveConfigRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Invites {
		private boolean showCustomInviteMessage;
		private String customInviteMessage;
		private boolean showCustomOnCommunicationMessage;
		private String customOnCommunicationMessageCustom;


		public boolean isShowCustomInviteMessage() {
			return showCustomInviteMessage;
		}

		public void setShowCustomInviteMessage(boolean showCustomInviteMessage) {
			this.showCustomInviteMessage = showCustomInviteMessage;
		}

		public String getCustomInviteMessage() {
			return customInviteMessage;
		}

		public void setCustomInviteMessage(String customInviteMessage) {
			this.customInviteMessage = customInviteMessage;
		}

		public boolean isShowCustomOnCommunicationMessage() {
			return showCustomOnCommunicationMessage;
		}

		public void setShowCustomOnCommunicationMessage(boolean showCustomOnCommunicationMessage) {
			this.showCustomOnCommunicationMessage = showCustomOnCommunicationMessage;
		}

		public String getCustomOnCommunicationMessageCustom() {
			return customOnCommunicationMessageCustom;
		}

		public void setCustomOnCommunicationMessageCustom(String customOnCommunicationMessageCustom) {
			this.customOnCommunicationMessageCustom = customOnCommunicationMessageCustom;
		}
	}

	private static class PortalContactInfo {
		private boolean show;
		private boolean showEmail;
		private String email;
		private boolean showFaxNumber;
		private String faxNumber;
		private boolean showPhoneNumber;
		private String workNumber;


		public boolean isShow() {
			return show;
		}

		public void setShow(boolean show) {
			this.show = show;
		}

		public boolean isShowEmail() {
			return showEmail;
		}

		public void setShowEmail(boolean showEmail) {
			this.showEmail = showEmail;
		}

		public String getEmail() {
			return email;
		}

		public void setEmail(String email) {
			this.email = email;
		}

		public boolean isShowFaxNumber() {
			return showFaxNumber;
		}

		public void setShowFaxNumber(boolean showFaxNumber) {
			this.showFaxNumber = showFaxNumber;
		}

		public String getFaxNumber() {
			return faxNumber;
		}

		public void setFaxNumber(String faxNumber) {
			this.faxNumber = faxNumber;
		}

		public boolean isShowPhoneNumber() {
			return showPhoneNumber;
		}

		public void setShowPhoneNumber(boolean showPhoneNumber) {
			this.showPhoneNumber = showPhoneNumber;
		}

		public String getWorkNumber() {
			return workNumber;
		}

		public void setWorkNumber(String workNumber) {
			this.workNumber = workNumber;
		}
	}

	private static class Hours {
		private boolean shown;
		private String monday;
		private String tuesday;
		private String wednesday;
		private String thursday;
		private String friday;
		private String saturday;
		private String sunday;


		public boolean isShown() {
			return shown;
		}

		public void setShown(boolean shown) {
			this.shown = shown;
		}

		public String getMonday() {
			return monday;
		}

		public void setMonday(String monday) {
			this.monday = monday;
		}

		public String getTuesday() {
			return tuesday;
		}

		public void setTuesday(String tuesday) {
			this.tuesday = tuesday;
		}

		public String getWednesday() {
			return wednesday;
		}

		public void setWednesday(String wednesday) {
			this.wednesday = wednesday;
		}

		public String getThursday() {
			return thursday;
		}

		public void setThursday(String thursday) {
			this.thursday = thursday;
		}

		public String getFriday() {
			return friday;
		}

		public void setFriday(String friday) {
			this.friday = friday;
		}

		public String getSaturday() {
			return saturday;
		}

		public void setSaturday(String saturday) {
			this.saturday = saturday;
		}

		public String getSunday() {
			return sunday;
		}

		public void setSunday(String sunday) {
			this.sunday = sunday;
		}
	}

	private static class AboutUs {
		private boolean show;
		private String text;
		private String headerName;
		private PortalContactInfo contactInfo;
		private Hours hours;


		public boolean isShow() {
			return show;
		}

		public void setShow(boolean show) {
			this.show = show;
		}

		public String getText() {
			return text;
		}

		public void setText(String text) {
			this.text = text;
		}

		public String getHeaderName() {
			return headerName;
		}

		public void setHeaderName(String headerName) {
			this.headerName = headerName;
		}

		public PortalContactInfo getContactInfo() {
			return contactInfo;
		}

		public void setContactInfo(PortalContactInfo contactInfo) {
			this.contactInfo = contactInfo;
		}

		public Hours getHours() {
			return hours;
		}

		public void setHours(Hours hours) {
			this.hours = hours;
		}
	}

	private static class Permissions {
		private boolean showRecords;
		private boolean showForms;
		private boolean showNotifications;
		private boolean showMessageCreate;
		private boolean showMessageReply;


		public boolean isShowRecords() {
			return showRecords;
		}

		public void setShowRecords(boolean showRecords) {
			this.showRecords = showRecords;
		}

		public boolean isShowForms() {
			return showForms;
		}

		public void setShowForms(boolean showForms) {
			this.showForms = showForms;
		}

		public boolean isShowNotifications() {
			return showNotifications;
		}

		public void setShowNotifications(boolean showNotifications) {
			this.showNotifications = showNotifications;
		}

		public boolean isShowMessageCreate() {
			return showMessageCreate;
		}

		public void setShowMessageCreate(boolean showMessageCreate) {
			this.showMessageCreate = showMessageCreate;
		}

		public boolean isShowMessageReply() {
			return showMessageReply;
		}

		public void setShowMessageReply(boolean showMessageReply) {
			this.showMessageReply = showMessageReply;
		}
	}

	private static class PortalRetrieveConfigResponse extends UpdoxResponse {
		private boolean portalEnabled;
		private Invites invites;
		private AboutUs aboutUs;
		private Permissions permissions;


		public boolean isPortalEnabled() {
			return portalEnabled;
		}

		public void setPortalEnabled(boolean portalEnabled) {
			this.portalEnabled = portalEnabled;
		}

		public Invites getInvites() {
			return invites;
		}

		public void setInvites(Invites invites) {
			this.invites = invites;
		}

		public AboutUs getAboutUs() {
			return aboutUs;
		}

		public void setAboutUs(AboutUs aboutUs) {
			this.aboutUs = aboutUs;
		}

		public Permissions getPermissions() {
			return permissions;
		}

		public void setPermissions(Permissions permissions) {
			this.permissions = permissions;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PortalSendMessage /io/PortalSendMessage

Sends a message to the portal account of the patient with the given patientId, from the user with the userId given in auth

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
recipient	String		String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String		The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String		Max length 50 characters.
patientMiddleName	String		Max length 50 characters.
patientLastName	String		Max length 50 characters.
patientEmail	String		Max length 255 characters. Must be a valid email address.
patientDob	String		Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String		f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String		Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean		If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String		The subject line of the message. Max length 255 characters. This is required.
message	String		The plain text body of the message. This is required.
notifyTimeout	Int		The time, in hours, until the user is sent an unread alert for this message.
sendPortalNotification	Boolean		Set whether or not the patient should receive an email notification about this Portal operation. Defaults to TRUE.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.

Try it! Toggle Notes/Code Samples

PortalSendMessage

Sends a message to the portal account of the patient with the given patientId, from the user with the userId given in auth

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalSendMessage {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalSendMessage codeSample = new UpdoxCodeSample_PortalSendMessage();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalSendMessage";
			PortalSendMessageRequest portalSendMessageRequest = new PortalSendMessageRequest();

			//set up credentials
			portalSendMessageRequest.auth.applicationId = "applicationId";
			portalSendMessageRequest.auth.applicationPassword = "applicationPassword";
			portalSendMessageRequest.auth.accountId = "accountId";
			portalSendMessageRequest.auth.userId = "userId";

			//set up request specific parameters
			portalSendMessageRequest.recipient = "recipient";
			portalSendMessageRequest.patientId = "patientId";
			portalSendMessageRequest.patientFirstName = "patientFirstName";
			portalSendMessageRequest.patientMiddleName = "patientMiddleName";
			portalSendMessageRequest.patientLastName = "patientLastName";
			portalSendMessageRequest.patientEmail = "test@test.com";
			portalSendMessageRequest.patientDob = "patientDob";
			portalSendMessageRequest.patientGender = "patientGender";
			portalSendMessageRequest.patientChartNumber = "patientChartNumber";
			portalSendMessageRequest.createPatientWhenNecessary = true;
			portalSendMessageRequest.subject = "subject";
			portalSendMessageRequest.message = "message";
			portalSendMessageRequest.notifyTimeout = 1;
			portalSendMessageRequest.sendPortalNotification = true;
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			portalSendMessageRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(portalSendMessageRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalSendMessage", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalSendMessageResponse portalSendMessageResponse = javascriptSerializer.Deserialize<PortalSendMessageResponse>(jsonResponse);

			Console.WriteLine(portalSendMessageResponse.responseCode);
			Console.WriteLine(portalSendMessageResponse.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class PortalSendMessageRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public bool sendPortalNotification { get; set;}
			public FileAttachment[] attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalSendMessageResponse : UpdoxResponse {
			public Object results { get; set;}
			public string recipient { get; set;}
			public long actionId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_PortalSendMessage {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalSendMessage codeSample = new UpdoxCodeSample_PortalSendMessage();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalSendMessage";

		PortalSendMessageRequest portalSendMessageRequest = new PortalSendMessageRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalSendMessageRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalSendMessageRequest.setRecipient("recipient");
		portalSendMessageRequest.setPatientId("patientId");
		portalSendMessageRequest.setPatientFirstName("patientFirstName");
		portalSendMessageRequest.setPatientMiddleName("patientMiddleName");
		portalSendMessageRequest.setPatientLastName("patientLastName");
		portalSendMessageRequest.setPatientEmail("test@test.com");
		portalSendMessageRequest.setPatientDob("patientDob");
		portalSendMessageRequest.setPatientGender("patientGender");
		portalSendMessageRequest.setPatientChartNumber("patientChartNumber");
		portalSendMessageRequest.setCreatePatientWhenNecessary(true);
		portalSendMessageRequest.setSubject("subject");
		portalSendMessageRequest.setMessage("message");
		portalSendMessageRequest.setNotifyTimeout(1);
		portalSendMessageRequest.setSendPortalNotification(true);
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		portalSendMessageRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalSendMessageRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalSendMessage', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalSendMessageResponse portalSendMessageResponse = mapper.readValue(jsonResponse, PortalSendMessageResponse.class);

		System.out.println(portalSendMessageResponse.getResponseCode());
		System.out.println(portalSendMessageResponse.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class PortalSendMessageRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String patientChartNumber;
    	private boolean createPatientWhenNecessary;
    	private String subject;
    	private String message;
    	private int notifyTimeout;
    	private Boolean sendPortalNotification;
    	private FileAttachment[] attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalSendMessageResponse extends UpdoxResponse {
		private Object results;
		private String recipient;
		private long actionId;


		public Object getResults() {
			return results;
		}

		public void setResults(Object results) {
			this.results = results;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public long getActionId() {
			return actionId;
		}

		public void setActionId(long actionId) {
			this.actionId = actionId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`

PortalSendMessage/1.1 /io/PortalSendMessage/1.1

Sends a message to the portal account of the patient with the given patientId, from the user with the userId given in auth.

Changes from v1.0 to v1.1:

sendAsPractice - Added flags to choose between sending the message as the calling user or the practice
results - Removed from the response

Parameter	Type	Value	Description
recipient	String		String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String		The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String		Max length 50 characters.
patientMiddleName	String		Max length 50 characters.
patientLastName	String		Max length 50 characters.
patientEmail	String		Max length 255 characters. Must be a valid email address.
patientDob	String		Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String		f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String		Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean		If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String		The subject line of the message. Max length 255 characters. This is required.
message	String		The plain text body of the message. This is required.
notifyTimeout	Int		The time, in hours, until the user is sent an unread alert for this message.
sendPortalNotification	Boolean		Set whether or not the patient should receive an email notification about this Portal operation. Defaults to true.
attachments	Array	add remove	Optional array of attachments to send with the message.

name	String		Optional: a human-readable name for the upload (e.g. Recent Lab Results).
fileName	String		The file name of the attachment with extension (e.g. lab_results_1070.pdf).
mimeType	String		The MIME type of the attachment (e.g. application/pdf).
content	String		The contents of the attachment base64-encoded.
sendAsPractice	Boolean		Set whether this message is coming from the individual user or the practice. Defaults to false.

Try it! Toggle Notes/Code Samples

PortalSendMessage/1.1

Sends a message to the portal account of the patient with the given patientId, from the user with the userId given in auth.

Changes from v1.0 to v1.1:

sendAsPractice - Added flags to choose between sending the message as the calling user or the practice
results - Removed from the response

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalSendMessage1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalSendMessage1_1 codeSample = new UpdoxCodeSample_PortalSendMessage1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalSendMessage1_1";
			PortalSendMessage1_1Request portalSendMessage1_1Request = new PortalSendMessage1_1Request();

			//set up credentials
			portalSendMessage1_1Request.auth.applicationId = "applicationId";
			portalSendMessage1_1Request.auth.applicationPassword = "applicationPassword";
			portalSendMessage1_1Request.auth.accountId = "accountId";
			portalSendMessage1_1Request.auth.userId = "userId";

			//set up request specific parameters
			portalSendMessage1_1Request.recipient = "recipient";
			portalSendMessage1_1Request.patientId = "patientId";
			portalSendMessage1_1Request.patientFirstName = "patientFirstName";
			portalSendMessage1_1Request.patientMiddleName = "patientMiddleName";
			portalSendMessage1_1Request.patientLastName = "patientLastName";
			portalSendMessage1_1Request.patientEmail = "test@test.com";
			portalSendMessage1_1Request.patientDob = "patientDob";
			portalSendMessage1_1Request.patientGender = "patientGender";
			portalSendMessage1_1Request.patientChartNumber = "patientChartNumber";
			portalSendMessage1_1Request.createPatientWhenNecessary = true;
			portalSendMessage1_1Request.subject = "subject";
			portalSendMessage1_1Request.message = "message";
			portalSendMessage1_1Request.notifyTimeout = 1;
			portalSendMessage1_1Request.sendPortalNotification = true;
			FileAttachment attachmentsFileAttachment = new FileAttachment();
			attachmentsFileAttachment.name = "name";
			attachmentsFileAttachment.fileName = "fileName";
			attachmentsFileAttachment.mimeType = "mimeType";
			attachmentsFileAttachment.content = "content";
			FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
			portalSendMessage1_1Request.attachments = attachments;
			portalSendMessage1_1Request.sendAsPractice = true;

			//create the request
			string json = Utilities.buildRequestJson(portalSendMessage1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalSendMessage/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalSendMessage1_1Response portalSendMessage1_1Response = javascriptSerializer.Deserialize<PortalSendMessage1_1Response>(jsonResponse);

			Console.WriteLine(portalSendMessage1_1Response.responseCode);
			Console.WriteLine(portalSendMessage1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class FileAttachment {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class PortalSendMessage1_1Request : UpdoxRequest {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public bool sendPortalNotification { get; set;}
			public FileAttachment[] attachments { get; set;}
			public bool sendAsPractice { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalSendMessage1_1Response : UpdoxResponse {
			public string recipient { get; set;}
			public long actionId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.util.ArrayList;

public class UpdoxCodeSample_PortalSendMessage1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalSendMessage1_1 codeSample = new UpdoxCodeSample_PortalSendMessage1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalSendMessage1_1";

		PortalSendMessage1_1Request portalSendMessage1_1Request = new PortalSendMessage1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalSendMessage1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalSendMessage1_1Request.setRecipient("recipient");
		portalSendMessage1_1Request.setPatientId("patientId");
		portalSendMessage1_1Request.setPatientFirstName("patientFirstName");
		portalSendMessage1_1Request.setPatientMiddleName("patientMiddleName");
		portalSendMessage1_1Request.setPatientLastName("patientLastName");
		portalSendMessage1_1Request.setPatientEmail("test@test.com");
		portalSendMessage1_1Request.setPatientDob("patientDob");
		portalSendMessage1_1Request.setPatientGender("patientGender");
		portalSendMessage1_1Request.setPatientChartNumber("patientChartNumber");
		portalSendMessage1_1Request.setCreatePatientWhenNecessary(true);
		portalSendMessage1_1Request.setSubject("subject");
		portalSendMessage1_1Request.setMessage("message");
		portalSendMessage1_1Request.setNotifyTimeout(1);
		portalSendMessage1_1Request.setSendPortalNotification(true);
		FileAttachment attachmentsFileAttachment = new FileAttachment();
		attachmentsFileAttachment.setName("name");
		attachmentsFileAttachment.setFileName("fileName");
		attachmentsFileAttachment.setMimeType("mimeType");
		attachmentsFileAttachment.setContent("content");
		FileAttachment[] attachments = new FileAttachment[]{attachmentsFileAttachment};
		portalSendMessage1_1Request.setAttachments(attachments);
		portalSendMessage1_1Request.setSendAsPractice(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalSendMessage1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalSendMessage/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalSendMessage1_1Response portalSendMessage1_1Response = mapper.readValue(jsonResponse, PortalSendMessage1_1Response.class);

		System.out.println(portalSendMessage1_1Response.getResponseCode());
		System.out.println(portalSendMessage1_1Response.getResponseMessage());
	}

	private static class FileAttachment {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class PortalSendMessage1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String patientChartNumber;
    	private boolean createPatientWhenNecessary;
    	private String subject;
    	private String message;
    	private int notifyTimeout;
    	private Boolean sendPortalNotification;
    	private FileAttachment[] attachments;
    	private boolean sendAsPractice;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}

		public FileAttachment[] getAttachments() {
			return attachments;
		}

		public void setAttachments(FileAttachment[] attachments) {
			this.attachments = attachments;
		}

		public boolean isSendAsPractice() {
			return sendAsPractice;
		}

		public void setSendAsPractice(boolean sendAsPractice) {
			this.sendAsPractice = sendAsPractice;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalSendMessage1_1Response extends UpdoxResponse {
		private String recipient;
		private long actionId;


		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public long getActionId() {
			return actionId;
		}

		public void setActionId(long actionId) {
			this.actionId = actionId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`

PortalSendRecord /io/PortalSendRecord

Sends a CCDA message to the portal account of the patient with the given patientId, from the user with the userId given in auth

Parameter	Type	Description
recipient	String	String value for the Internal ID of recipient. Must be in the format of [type]:[id]. Min length 2 characters. Max length 100 characters.
patientId	String	The ID of the patient. Min length 1 characters. Max length 40 characters.
patientFirstName	String	Max length 50 characters.
patientMiddleName	String	Max length 50 characters.
patientLastName	String	Max length 50 characters.
patientEmail	String	Max length 255 characters. Must be a valid email address.
patientDob	String	Format yyyy-mm-dd. The value must contain exactly 10 characters.
patientGender	String	f=Female, m=Male, o=Other, u=Unknown. The value must contain exactly 1 characters.
patientChartNumber	String	Chart number of the patient. Min length 1 characters. Max length 64 characters.
createPatientWhenNecessary	Boolean	If true, the sending patient will be created if no patient exists for the patient ID in `recipient` or `patientId`.
subject	String	The subject line of the message. Max length 100 characters.
message	String	The plain text body of the message.
notifyTimeout	Int	The time, in hours, until the user is sent an unread alert for this message.
fileName	String	The file name of the attachment (e.g. connie_smith_ccr.xml). This is required.
file	String	The contents of the attachment base64-encoded. This is required.
fileMimeType	String	The MIME type of the attachment (ccda/xml, ccda/html, ccd/xml, ccd/html, ccr/xml, ccr/html, c32/xml, or c32/html). Must be one of the following values: ccr/html, ccr/xml, ccd/html, ccd/xml, ccda/html, ccda/xml, c32/html, c32/xml. This is required.
createPortalWhenNecessary	Boolean	If true, the sending patient's portal account will be created if no portal account exists for the patient ID in `recipient` or `patientId`, or if also creating a patient in this call.
sendPortalMessage	Boolean	If true, the provided parameters will be used to send a portal message to the patient.
sendPortalNotification	Boolean	Set whether or not the patient should receive an email notification about this Portal operation. Defaults to TRUE.

Try it! Toggle Notes/Code Samples

PortalSendRecord

Sends a CCDA message to the portal account of the patient with the given patientId, from the user with the userId given in auth

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PortalSendRecord {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PortalSendRecord codeSample = new UpdoxCodeSample_PortalSendRecord();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PortalSendRecord";
			PortalSendRecordRequest portalSendRecordRequest = new PortalSendRecordRequest();

			//set up credentials
			portalSendRecordRequest.auth.applicationId = "applicationId";
			portalSendRecordRequest.auth.applicationPassword = "applicationPassword";
			portalSendRecordRequest.auth.accountId = "accountId";
			portalSendRecordRequest.auth.userId = "userId";

			//set up request specific parameters
			portalSendRecordRequest.recipient = "recipient";
			portalSendRecordRequest.patientId = "patientId";
			portalSendRecordRequest.patientFirstName = "patientFirstName";
			portalSendRecordRequest.patientMiddleName = "patientMiddleName";
			portalSendRecordRequest.patientLastName = "patientLastName";
			portalSendRecordRequest.patientEmail = "test@test.com";
			portalSendRecordRequest.patientDob = "patientDob";
			portalSendRecordRequest.patientGender = "patientGender";
			portalSendRecordRequest.patientChartNumber = "patientChartNumber";
			portalSendRecordRequest.createPatientWhenNecessary = true;
			portalSendRecordRequest.subject = "subject";
			portalSendRecordRequest.message = "message";
			portalSendRecordRequest.notifyTimeout = 1;
			portalSendRecordRequest.fileName = "fileName";
			portalSendRecordRequest.file = "file";
			portalSendRecordRequest.fileMimeType = "fileMimeType";
			portalSendRecordRequest.createPortalWhenNecessary = true;
			portalSendRecordRequest.sendPortalMessage = true;
			portalSendRecordRequest.sendPortalNotification = true;

			//create the request
			string json = Utilities.buildRequestJson(portalSendRecordRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PortalSendRecord", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PortalSendRecordResponse portalSendRecordResponse = javascriptSerializer.Deserialize<PortalSendRecordResponse>(jsonResponse);

			Console.WriteLine(portalSendRecordResponse.responseCode);
			Console.WriteLine(portalSendRecordResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PortalSendRecordRequest : UpdoxRequest {
			public string recipient { get; set;}
			public string patientId { get; set;}
			public string patientFirstName { get; set;}
			public string patientMiddleName { get; set;}
			public string patientLastName { get; set;}
			public string patientEmail { get; set;}
			public string patientDob { get; set;}
			public string patientGender { get; set;}
			public string patientChartNumber { get; set;}
			public bool createPatientWhenNecessary { get; set;}
			public string subject { get; set;}
			public string message { get; set;}
			public int notifyTimeout { get; set;}
			public string fileName { get; set;}
			public string file { get; set;}
			public string fileMimeType { get; set;}
			public bool createPortalWhenNecessary { get; set;}
			public bool sendPortalMessage { get; set;}
			public bool sendPortalNotification { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PortalSendRecordResponse : UpdoxResponse {
			public Object results { get; set;}
			public string recipient { get; set;}
			public long actionId { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PortalSendRecord {

	public static void main(String[] args) {
		UpdoxCodeSample_PortalSendRecord codeSample = new UpdoxCodeSample_PortalSendRecord();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PortalSendRecord";

		PortalSendRecordRequest portalSendRecordRequest = new PortalSendRecordRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = portalSendRecordRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		portalSendRecordRequest.setRecipient("recipient");
		portalSendRecordRequest.setPatientId("patientId");
		portalSendRecordRequest.setPatientFirstName("patientFirstName");
		portalSendRecordRequest.setPatientMiddleName("patientMiddleName");
		portalSendRecordRequest.setPatientLastName("patientLastName");
		portalSendRecordRequest.setPatientEmail("test@test.com");
		portalSendRecordRequest.setPatientDob("patientDob");
		portalSendRecordRequest.setPatientGender("patientGender");
		portalSendRecordRequest.setPatientChartNumber("patientChartNumber");
		portalSendRecordRequest.setCreatePatientWhenNecessary(true);
		portalSendRecordRequest.setSubject("subject");
		portalSendRecordRequest.setMessage("message");
		portalSendRecordRequest.setNotifyTimeout(1);
		portalSendRecordRequest.setFileName("fileName");
		portalSendRecordRequest.setFile("file");
		portalSendRecordRequest.setFileMimeType("fileMimeType");
		portalSendRecordRequest.setCreatePortalWhenNecessary(true);
		portalSendRecordRequest.setSendPortalMessage(true);
		portalSendRecordRequest.setSendPortalNotification(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(portalSendRecordRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PortalSendRecord', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PortalSendRecordResponse portalSendRecordResponse = mapper.readValue(jsonResponse, PortalSendRecordResponse.class);

		System.out.println(portalSendRecordResponse.getResponseCode());
		System.out.println(portalSendRecordResponse.getResponseMessage());
	}

	private class PortalSendRecordRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String recipient;
    	private String patientId;
    	private String patientFirstName;
    	private String patientMiddleName;
    	private String patientLastName;
    	private String patientEmail;
    	private String patientDob;
    	private String patientGender;
    	private String patientChartNumber;
    	private boolean createPatientWhenNecessary;
    	private String subject;
    	private String message;
    	private int notifyTimeout;
    	private String fileName;
    	private String file;
    	private String fileMimeType;
    	private boolean createPortalWhenNecessary;
    	private boolean sendPortalMessage;
    	private Boolean sendPortalNotification;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public String getPatientId() {
			return patientId;
		}

		public void setPatientId(String patientId) {
			this.patientId = patientId;
		}

		public String getPatientFirstName() {
			return patientFirstName;
		}

		public void setPatientFirstName(String patientFirstName) {
			this.patientFirstName = patientFirstName;
		}

		public String getPatientMiddleName() {
			return patientMiddleName;
		}

		public void setPatientMiddleName(String patientMiddleName) {
			this.patientMiddleName = patientMiddleName;
		}

		public String getPatientLastName() {
			return patientLastName;
		}

		public void setPatientLastName(String patientLastName) {
			this.patientLastName = patientLastName;
		}

		public String getPatientEmail() {
			return patientEmail;
		}

		public void setPatientEmail(String patientEmail) {
			this.patientEmail = patientEmail;
		}

		public String getPatientDob() {
			return patientDob;
		}

		public void setPatientDob(String patientDob) {
			this.patientDob = patientDob;
		}

		public String getPatientGender() {
			return patientGender;
		}

		public void setPatientGender(String patientGender) {
			this.patientGender = patientGender;
		}

		public String getPatientChartNumber() {
			return patientChartNumber;
		}

		public void setPatientChartNumber(String patientChartNumber) {
			this.patientChartNumber = patientChartNumber;
		}

		public boolean isCreatePatientWhenNecessary() {
			return createPatientWhenNecessary;
		}

		public void setCreatePatientWhenNecessary(boolean createPatientWhenNecessary) {
			this.createPatientWhenNecessary = createPatientWhenNecessary;
		}

		public String getSubject() {
			return subject;
		}

		public void setSubject(String subject) {
			this.subject = subject;
		}

		public String getMessage() {
			return message;
		}

		public void setMessage(String message) {
			this.message = message;
		}

		public int getNotifyTimeout() {
			return notifyTimeout;
		}

		public void setNotifyTimeout(int notifyTimeout) {
			this.notifyTimeout = notifyTimeout;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getFile() {
			return file;
		}

		public void setFile(String file) {
			this.file = file;
		}

		public String getFileMimeType() {
			return fileMimeType;
		}

		public void setFileMimeType(String fileMimeType) {
			this.fileMimeType = fileMimeType;
		}

		public boolean isCreatePortalWhenNecessary() {
			return createPortalWhenNecessary;
		}

		public void setCreatePortalWhenNecessary(boolean createPortalWhenNecessary) {
			this.createPortalWhenNecessary = createPortalWhenNecessary;
		}

		public boolean isSendPortalMessage() {
			return sendPortalMessage;
		}

		public void setSendPortalMessage(boolean sendPortalMessage) {
			this.sendPortalMessage = sendPortalMessage;
		}

		public Boolean isSendPortalNotification() {
			return sendPortalNotification;
		}

		public void setSendPortalNotification(Boolean sendPortalNotification) {
			this.sendPortalNotification = sendPortalNotification;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class PortalSendRecordResponse extends UpdoxResponse {
		private Object results;
		private String recipient;
		private long actionId;


		public Object getResults() {
			return results;
		}

		public void setResults(Object results) {
			this.results = results;
		}

		public String getRecipient() {
			return recipient;
		}

		public void setRecipient(String recipient) {
			this.recipient = recipient;
		}

		public long getActionId() {
			return actionId;
		}

		public void setActionId(long actionId) {
			this.actionId = actionId;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4070`	`Invalid recipient`
`4231`	`user does not exist`
`4131`	`account does not exist`
`4832`	`patient has opted out of portal communications`
`4831`	`portal account does not exist`
`4731`	`patient account does not exist`
`4000`	`Bad Request`

PracticeActions

MuMeasuresGet /io/MuMeasuresGet

Gets numerator/denominator information for the requested MU measure(s), for the given account/user (provider).

Parameter	Type	Value	Description
measureIds	List	add remove	One or more Meaningful Use types for which to return. Each list field must match one of the following values: core:7.1, core:7.2, core:17.

	String
allUsers	Boolean		Combine results for all users if TRUE. Note that this can only apply to core:17.
beginning	Date		Number of milliseconds since midnight 1/1/1970.
ending	Date		Number of milliseconds since midnight 1/1/1970.

Try it! Toggle Notes/Code Samples

MuMeasuresGet

Gets numerator/denominator information for the requested MU measure(s), for the given account/user (provider).

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

MUMeasure Ids

core:17

- In 2014 -- Count of unique patients (or their authorized representatives) seen by the EP during the EHR reporting period that sent a secure message to a provider
- In 2015 -- The capability of patients to send and receive a secure electronic message with the EP was fully enabled during the EHR reporting period. Note: The measure is not percentage based for the year 2015; however, the value is returned as if it was
- 2016 and beyond -- Count of unique patients (or their authorized representatives) seen by the EP during the EHR reporting period that received a secure message from a provider

core:7.1

- Count of all unique patients seen by the EP during the EHR reporting period are provided timely (available to the patient within four business days after the information is available to the EP) online access to their health information, with the ability to view, download, and transmit to a third party.
- Since our system does not track visits for the patients, the most information it can return is a list of PatientIds and Timestamps when their CCDA was sent to their Portal account. It is then up to the API consumer to match visits to CCDAs within the appropriate 4-day window. Note that an entry is made in the response list for each time a CCDA was sent to the patient's portal account - this means that it is possible (even likely) that a given PatientId will be listed more than once.

core:7.2

- Count of all unique patients seen by the EP during the EHR reporting period (or their authorized representatives) view, download, or transmit to a third party their health information.
- Returns a unique list of patients within a set time-frame who have viewed, downloaded, or transmitted a CCD* document, and stores that count as a numerator.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_MuMeasuresGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_MuMeasuresGet codeSample = new UpdoxCodeSample_MuMeasuresGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "MuMeasuresGet";
			MuMeasuresGetRequest muMeasuresGetRequest = new MuMeasuresGetRequest();

			//set up credentials
			muMeasuresGetRequest.auth.applicationId = "applicationId";
			muMeasuresGetRequest.auth.applicationPassword = "applicationPassword";
			muMeasuresGetRequest.auth.accountId = "accountId";
			muMeasuresGetRequest.auth.userId = "userId";

			//set up request specific parameters
			List<string> measureIds = new List<string>();
			string measureIdsString = "measureIds";
			measureIds.Add(measureIdsString);
			muMeasuresGetRequest.measureIds = measureIds;
			muMeasuresGetRequest.allUsers = true;
			muMeasuresGetRequest.beginning = "beginning";
			muMeasuresGetRequest.ending = "ending";

			//create the request
			string json = Utilities.buildRequestJson(muMeasuresGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "MuMeasuresGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			MuMeasuresGetResponse muMeasuresGetResponse = javascriptSerializer.Deserialize<MuMeasuresGetResponse>(jsonResponse);

			Console.WriteLine(muMeasuresGetResponse.responseCode);
			Console.WriteLine(muMeasuresGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MuMeasuresGetRequest : UpdoxRequest {
			public List<string> measureIds { get; set;}
			public bool allUsers { get; set;}
			public String beginning { get; set;}
			public String ending { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MuMeasuresGetResponse : UpdoxResponse {
			public Dictionary<String, Object> measures { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;
import java.util.Map;

public class UpdoxCodeSample_MuMeasuresGet {

	public static void main(String[] args) {
		UpdoxCodeSample_MuMeasuresGet codeSample = new UpdoxCodeSample_MuMeasuresGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "MuMeasuresGet";

		MuMeasuresGetRequest muMeasuresGetRequest = new MuMeasuresGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = muMeasuresGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

	List<String> measureIds = new ArrayList<>();
		String measureIdsString = "measureIds";
		measureIds.add(measureIdsString);
		muMeasuresGetRequest.setMeasureIds(measureIds);
		muMeasuresGetRequest.setAllUsers(true);
		muMeasuresGetRequest.setBeginning(new Date());
		muMeasuresGetRequest.setEnding(new Date());

		//create the request
		String jsonRequest = Utilities.buildRequestJson(muMeasuresGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'MuMeasuresGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		MuMeasuresGetResponse muMeasuresGetResponse = mapper.readValue(jsonResponse, MuMeasuresGetResponse.class);

		System.out.println(muMeasuresGetResponse.getResponseCode());
		System.out.println(muMeasuresGetResponse.getResponseMessage());
	}

	private class MuMeasuresGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<String> measureIds;
    	private boolean allUsers;
    	private Date beginning;
    	private Date ending;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<String> getMeasureIds() {
			return measureIds;
		}

		public void setMeasureIds(List<String> measureIds) {
			this.measureIds = measureIds;
		}

		public boolean isAllUsers() {
			return allUsers;
		}

		public void setAllUsers(boolean allUsers) {
			this.allUsers = allUsers;
		}

		public Date getBeginning() {
			return beginning;
		}

		public void setBeginning(Date beginning) {
			this.beginning = beginning;
		}

		public Date getEnding() {
			return ending;
		}

		public void setEnding(Date ending) {
			this.ending = ending;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MuMeasuresGetResponse extends UpdoxResponse {
		private Map measures;


		public Map getMeasures() {
			return measures;
		}

		public void setMeasures(Map measures) {
			this.measures = measures;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeCreate /io/PracticeCreate

Creates a practice with the accountId passed into auth. The accountId cannot contain whitespace characters after February 2024.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		REQUIRED: Account Identifier must be specified here or in the Auth Header. The new account ID to be associated to this account for Application Authorization. Max length 255 characters.
name	String		The name of the practice. Max length 100 characters. This is required.
address1	String		Max length 100 characters.
address2	String		Max length 100 characters.
city	String		Max length 50 characters.
state	String		Must be a valid 2 character state code. Max length 2 characters.
postal	String		Max length 5 characters.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeCreate

Creates a practice with the accountId passed into auth. The accountId cannot contain whitespace characters after February 2024.

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeCreate codeSample = new UpdoxCodeSample_PracticeCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeCreate";
			PracticeCreateRequest practiceCreateRequest = new PracticeCreateRequest();

			//set up credentials
			practiceCreateRequest.auth.applicationId = "applicationId";
			practiceCreateRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceCreateRequest.accountId = "accountId";
			practiceCreateRequest.name = "name";
			practiceCreateRequest.address1 = "address1";
			practiceCreateRequest.address2 = "address2";
			practiceCreateRequest.city = "Dublin";
			practiceCreateRequest.state = "OH";
			practiceCreateRequest.postal = "postal";
			practiceCreateRequest.phone = "6148675309";
			practiceCreateRequest.fax = "fax";
			practiceCreateRequest.websiteAddress = "websiteAddress";
			practiceCreateRequest.timeZone = "timeZone";
			practiceCreateRequest.directDomain = "directDomain";
			practiceCreateRequest.directAddress = "directAddress";
			practiceCreateRequest.protocol = "protocol";
			practiceCreateRequest.ipAddress = "ipAddress";
			practiceCreateRequest.port = 1L;
			practiceCreateRequest.path = "path";
			practiceCreateRequest.active = true;
			practiceCreateRequest.metadata = "metadata";
			practiceCreateRequest.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceCreateRequest.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceCreateRequest.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeCreateResponse practiceCreateResponse = javascriptSerializer.Deserialize<PracticeCreateResponse>(jsonResponse);

			Console.WriteLine(practiceCreateResponse.responseCode);
			Console.WriteLine(practiceCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeCreateRequest : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeCreateResponse : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeCreate codeSample = new UpdoxCodeSample_PracticeCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeCreate";

		PracticeCreateRequest practiceCreateRequest = new PracticeCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceCreateRequest.setAccountId("accountId");
		practiceCreateRequest.setName("name");
		practiceCreateRequest.setAddress1("address1");
		practiceCreateRequest.setAddress2("address2");
		practiceCreateRequest.setCity("Dublin");
		practiceCreateRequest.setState("OH");
		practiceCreateRequest.setPostal("postal");
		practiceCreateRequest.setPhone("6148675309");
		practiceCreateRequest.setFax("fax");
		practiceCreateRequest.setWebsiteAddress("websiteAddress");
		practiceCreateRequest.setTimeZone("timeZone");
		practiceCreateRequest.setDirectDomain("directDomain");
		practiceCreateRequest.setDirectAddress("directAddress");
		practiceCreateRequest.setProtocol("protocol");
		practiceCreateRequest.setIpAddress("ipAddress");
		practiceCreateRequest.setPort(1L);
		practiceCreateRequest.setPath("path");
		practiceCreateRequest.setActive(true);
		practiceCreateRequest.setMetadata("metadata");
		practiceCreateRequest.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceCreateRequest.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceCreateRequest.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeCreateResponse practiceCreateResponse = mapper.readValue(jsonResponse, PracticeCreateResponse.class);

		System.out.println(practiceCreateResponse.getResponseCode());
		System.out.println(practiceCreateResponse.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String phone;
    	private String fax;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeCreateResponse extends UpdoxResponse {
		private String accountId;
		private String action;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4130`	`account already exists`
`4110`	`no practice ID`
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4161`	`web address is invalid`
`4066`	`This API has been deprecated and can no longer be used. Please reference the Updox Interactive API page for information regarding the current version of this API`

PracticeCreate/1.1 /io/PracticeCreate/1.1

Creates a practice with the accountId passed into auth. The accountId cannot contain whitespace characters after February 2024.

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Parameter	Type	Value	Description
accountId	String		The new account ID to be associated to this account for Application Authorization. Max length 255 characters. This is required.
name	String		The name of the practice. Max length 100 characters. This is required.
nameHIPAACompliant	String		Specify a HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications. For example, "Updox Public Health Clinic of New York City" to "Updox NYC Clinic." Null or empty value will not overwrite existing value, but blank will clear. Max length 100 characters.
ein	String		The Employer Identification Number (EIN) associated with the account. If an EIN is already on file, a new value will overwrite it. Null or empty value will not overwrite existing value, but blank will clear. Input format `XX-XXXXXXX` or `SOLE_PROPRIETOR`.
address1	String		Max length 100 characters. This is required.
address2	String		Max length 100 characters.
city	String		Max length 50 characters. This is required.
state	String		The account's 2 character state code address. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters. This is required.
postal	String		The account's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters. This is required.
country	String		The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". . This is required.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteUrl	String		Website for the practice. For example, "https://www.updox.com/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
alternativeWebsiteUrl	String		This can be either a Practice Facebook URL or WebMD Profile URL. For example, "https://www.facebook.com/updox/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters. This is required.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeCreate/1.1

Creates a practice with the accountId passed into auth. The accountId cannot contain whitespace characters after February 2024.

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Possible nonBlockingErrors Updox may return:

Failed to add module id: %d - Applicable for all integrations. Means that a module of Updox functionality was not able to be added to this practice at this time. The %d will be replaced by the module_id number that Updox was unable to add. Example: When adding module_id == 11, aka "SMS", Updox may fail to provision a phone number for the practice despite a series of attempts. Should there be an attempt to add module_id == 11 again, a new set of provisionable numbers will be utilized. Resolution: use ModuleActions PracticeModuleSave method.
Failed to add all CSV maps - Only applicable if the integration utilizes CSVs. Resolution: contact Partner Support.
Failed to update patient portal - Only applicable if the integration utilizes the Updox Patient Portal. Resolution: use PortalActions PortalConfigure method.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeCreate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeCreate1_1 codeSample = new UpdoxCodeSample_PracticeCreate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeCreate1_1";
			PracticeCreate1_1Request practiceCreate1_1Request = new PracticeCreate1_1Request();

			//set up credentials
			practiceCreate1_1Request.auth.applicationId = "applicationId";
			practiceCreate1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceCreate1_1Request.accountId = "accountId";
			practiceCreate1_1Request.name = "name";
			practiceCreate1_1Request.nameHIPAACompliant = "nameHIPAACompliant";
			practiceCreate1_1Request.ein = "ein";
			practiceCreate1_1Request.address1 = "address1";
			practiceCreate1_1Request.address2 = "address2";
			practiceCreate1_1Request.city = "Dublin";
			practiceCreate1_1Request.state = "OH";
			practiceCreate1_1Request.postal = "postal";
			practiceCreate1_1Request.country = "country";
			practiceCreate1_1Request.phone = "6148675309";
			practiceCreate1_1Request.fax = "fax";
			practiceCreate1_1Request.websiteUrl = "websiteUrl";
			practiceCreate1_1Request.alternativeWebsiteUrl = "alternativeWebsiteUrl";
			practiceCreate1_1Request.websiteAddress = "websiteAddress";
			practiceCreate1_1Request.timeZone = "timeZone";
			practiceCreate1_1Request.directDomain = "directDomain";
			practiceCreate1_1Request.directAddress = "directAddress";
			practiceCreate1_1Request.protocol = "protocol";
			practiceCreate1_1Request.ipAddress = "ipAddress";
			practiceCreate1_1Request.port = 1L;
			practiceCreate1_1Request.path = "path";
			practiceCreate1_1Request.active = true;
			practiceCreate1_1Request.metadata = "metadata";
			practiceCreate1_1Request.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceCreate1_1Request.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceCreate1_1Request.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceCreate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeCreate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeCreate1_1Response practiceCreate1_1Response = javascriptSerializer.Deserialize<PracticeCreate1_1Response>(jsonResponse);

			Console.WriteLine(practiceCreate1_1Response.responseCode);
			Console.WriteLine(practiceCreate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeCreate1_1Request : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public string ein { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeCreate1_1Response : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
			public List<string> nonBlockingErrors { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeCreate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeCreate1_1 codeSample = new UpdoxCodeSample_PracticeCreate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeCreate1_1";

		PracticeCreate1_1Request practiceCreate1_1Request = new PracticeCreate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceCreate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceCreate1_1Request.setAccountId("accountId");
		practiceCreate1_1Request.setName("name");
		practiceCreate1_1Request.setNameHIPAACompliant("nameHIPAACompliant");
		practiceCreate1_1Request.setEin("ein");
		practiceCreate1_1Request.setAddress1("address1");
		practiceCreate1_1Request.setAddress2("address2");
		practiceCreate1_1Request.setCity("Dublin");
		practiceCreate1_1Request.setState("OH");
		practiceCreate1_1Request.setPostal("postal");
		practiceCreate1_1Request.setCountry("country");
		practiceCreate1_1Request.setPhone("6148675309");
		practiceCreate1_1Request.setFax("fax");
		practiceCreate1_1Request.setWebsiteUrl("websiteUrl");
		practiceCreate1_1Request.setAlternativeWebsiteUrl("alternativeWebsiteUrl");
		practiceCreate1_1Request.setWebsiteAddress("websiteAddress");
		practiceCreate1_1Request.setTimeZone("timeZone");
		practiceCreate1_1Request.setDirectDomain("directDomain");
		practiceCreate1_1Request.setDirectAddress("directAddress");
		practiceCreate1_1Request.setProtocol("protocol");
		practiceCreate1_1Request.setIpAddress("ipAddress");
		practiceCreate1_1Request.setPort(1L);
		practiceCreate1_1Request.setPath("path");
		practiceCreate1_1Request.setActive(true);
		practiceCreate1_1Request.setMetadata("metadata");
		practiceCreate1_1Request.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceCreate1_1Request.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceCreate1_1Request.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceCreate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeCreate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeCreate1_1Response practiceCreate1_1Response = mapper.readValue(jsonResponse, PracticeCreate1_1Response.class);

		System.out.println(practiceCreate1_1Response.getResponseCode());
		System.out.println(practiceCreate1_1Response.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeCreate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String nameHIPAACompliant;
    	private String ein;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String phone;
    	private String fax;
    	private String websiteUrl;
    	private String alternativeWebsiteUrl;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public String getEin() {
			return ein;
		}

		public void setEin(String ein) {
			this.ein = ein;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeCreate1_1Response extends UpdoxResponse {
		private String accountId;
		private String action;
		private List<String> nonBlockingErrors;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public List<String> getNonBlockingErrors() {
			return nonBlockingErrors;
		}

		public void setNonBlockingErrors(List<String> nonBlockingErrors) {
			this.nonBlockingErrors = nonBlockingErrors;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4130`	`account already exists`
`4110`	`no practice ID`
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4161`	`web address is invalid`

PracticeGet /io/PracticeGet

Gets the practice associated with supplied accountId.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

PracticeGet

Gets the practice associated with supplied accountId.

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeGet codeSample = new UpdoxCodeSample_PracticeGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeGet";
			PracticeGetRequest practiceGetRequest = new PracticeGetRequest();

			//set up credentials
			practiceGetRequest.auth.applicationId = "applicationId";
			practiceGetRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceGetRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeGetResponse practiceGetResponse = javascriptSerializer.Deserialize<PracticeGetResponse>(jsonResponse);

			Console.WriteLine(practiceGetResponse.responseCode);
			Console.WriteLine(practiceGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeGetRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_0 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string metadata { get; set;}
			public string timeZone { get; set;}
			public bool isVetted { get; set;}
			public bool isActive { get; set;}
		}

		public class PracticeGetResponse : UpdoxResponse {
			public ProviderInfoLimited1_0 practice { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeGet {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeGet codeSample = new UpdoxCodeSample_PracticeGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeGet";

		PracticeGetRequest practiceGetRequest = new PracticeGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceGetRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeGetResponse practiceGetResponse = mapper.readValue(jsonResponse, PracticeGetResponse.class);

		System.out.println(practiceGetResponse.getResponseCode());
		System.out.println(practiceGetResponse.getResponseMessage());
	}

	private class PracticeGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_0 {
		private String accountId;
		private String name;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String phone;
		private String fax;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String metadata;
		private String timeZone;
		private boolean isVetted;
		private boolean isActive;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isIsVetted() {
			return isVetted;
		}

		public void setIsVetted(boolean isVetted) {
			this.isVetted = isVetted;
		}

		public boolean isIsActive() {
			return isActive;
		}

		public void setIsActive(boolean isActive) {
			this.isActive = isActive;
		}
	}

	private static class PracticeGetResponse extends UpdoxResponse {
		private ProviderInfoLimited1_0 practice;


		public ProviderInfoLimited1_0 getPractice() {
			return practice;
		}

		public void setPractice(ProviderInfoLimited1_0 practice) {
			this.practice = practice;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeGet/1.1 /io/PracticeGet/1.1

Gets the practice associated with supplied accountId.

Changes from v1.0 to v1.1:

countryCode - the ISO 3166 Country Code Alpha-2 is now returned
practiceNpi - the NPI of the practice account is now returned
practiceSpecialityCode - the Provider Taxonomy Code is now returned

Additionally, INDIVIDUAL AUTH is no longer supported.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

PracticeGet/1.1

Gets the practice associated with supplied accountId.

Changes from v1.0 to v1.1:

countryCode - the ISO 3166 Country Code Alpha-2 is now returned
practiceNpi - the NPI of the practice account is now returned
practiceSpecialityCode - the Provider Taxonomy Code is now returned

Additionally, INDIVIDUAL AUTH is no longer supported.

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeGet1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeGet1_1 codeSample = new UpdoxCodeSample_PracticeGet1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeGet1_1";
			PracticeGet1_1Request practiceGet1_1Request = new PracticeGet1_1Request();

			//set up credentials
			practiceGet1_1Request.auth.applicationId = "applicationId";
			practiceGet1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceGet1_1Request.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceGet1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeGet/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeGet1_1Response practiceGet1_1Response = javascriptSerializer.Deserialize<PracticeGet1_1Response>(jsonResponse);

			Console.WriteLine(practiceGet1_1Response.responseCode);
			Console.WriteLine(practiceGet1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeGet1_1Request : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_1 {
			public string accountId { get; set;}
			public string name { get; set;}
			public bool isActive { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string country { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public bool isVetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeGet1_1Response : UpdoxResponse {
			public ProviderInfoLimited1_1 practice { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeGet1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeGet1_1 codeSample = new UpdoxCodeSample_PracticeGet1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeGet1_1";

		PracticeGet1_1Request practiceGet1_1Request = new PracticeGet1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceGet1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceGet1_1Request.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceGet1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeGet/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeGet1_1Response practiceGet1_1Response = mapper.readValue(jsonResponse, PracticeGet1_1Response.class);

		System.out.println(practiceGet1_1Response.getResponseCode());
		System.out.println(practiceGet1_1Response.getResponseMessage());
	}

	private class PracticeGet1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_1 {
		private String accountId;
		private String name;
		private boolean isActive;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String country;
		private String phone;
		private String fax;
		private boolean isVetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public boolean isIsActive() {
			return isActive;
		}

		public void setIsActive(boolean isActive) {
			this.isActive = isActive;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public boolean isIsVetted() {
			return isVetted;
		}

		public void setIsVetted(boolean isVetted) {
			this.isVetted = isVetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeGet1_1Response extends UpdoxResponse {
		private ProviderInfoLimited1_1 practice;


		public ProviderInfoLimited1_1 getPractice() {
			return practice;
		}

		public void setPractice(ProviderInfoLimited1_1 practice) {
			this.practice = practice;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeGet/1.2 /io/PracticeGet/1.2

Gets the practice associated with supplied accountId.

Changes from v1.1 to v1.2:

Added the following fields to the response:

nameHIPAACompliant - the HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications
websiteUrl - the practice's website
alternativeWebsiteUrl - the practice's alternative website (e.g. Facebook or WebMD Profile)

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

PracticeGet/1.2

Gets the practice associated with supplied accountId.

Changes from v1.1 to v1.2:

Added the following fields to the response:

nameHIPAACompliant - the HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications
websiteUrl - the practice's website
alternativeWebsiteUrl - the practice's alternative website (e.g. Facebook or WebMD Profile)

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeGet1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeGet1_2 codeSample = new UpdoxCodeSample_PracticeGet1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeGet1_2";
			PracticeGet1_2Request practiceGet1_2Request = new PracticeGet1_2Request();

			//set up credentials
			practiceGet1_2Request.auth.applicationId = "applicationId";
			practiceGet1_2Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceGet1_2Request.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceGet1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeGet/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeGet1_2Response practiceGet1_2Response = javascriptSerializer.Deserialize<PracticeGet1_2Response>(jsonResponse);

			Console.WriteLine(practiceGet1_2Response.responseCode);
			Console.WriteLine(practiceGet1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeGet1_2Request : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_2 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public bool active { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string countryCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public bool vetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeGet1_2Response : UpdoxResponse {
			public ProviderInfoLimited1_2 practice { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeGet1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeGet1_2 codeSample = new UpdoxCodeSample_PracticeGet1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeGet1_2";

		PracticeGet1_2Request practiceGet1_2Request = new PracticeGet1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceGet1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceGet1_2Request.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceGet1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeGet/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeGet1_2Response practiceGet1_2Response = mapper.readValue(jsonResponse, PracticeGet1_2Response.class);

		System.out.println(practiceGet1_2Response.getResponseCode());
		System.out.println(practiceGet1_2Response.getResponseMessage());
	}

	private class PracticeGet1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_2 {
		private String accountId;
		private String name;
		private String nameHIPAACompliant;
		private boolean active;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String countryCode;
		private String phone;
		private String fax;
		private String websiteUrl;
		private String alternativeWebsiteUrl;
		private boolean vetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeGet1_2Response extends UpdoxResponse {
		private ProviderInfoLimited1_2 practice;


		public ProviderInfoLimited1_2 getPractice() {
			return practice;
		}

		public void setPractice(ProviderInfoLimited1_2 practice) {
			this.practice = practice;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeGet/1.3 /io/PracticeGet/1.3

Gets the practice associated with supplied accountId.

Changes from v1.2 to v1.3:

Added the following fields to the response:

ein - Added optional field for the practice Employer Identification Number (EIN) associated with the account

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

PracticeGet/1.3

Gets the practice associated with supplied accountId.

Changes from v1.2 to v1.3:

Added the following fields to the response:

ein - Added optional field for the practice Employer Identification Number (EIN) associated with the account

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeGet1_3 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeGet1_3 codeSample = new UpdoxCodeSample_PracticeGet1_3();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeGet1_3";
			PracticeGet1_3Request practiceGet1_3Request = new PracticeGet1_3Request();

			//set up credentials
			practiceGet1_3Request.auth.applicationId = "applicationId";
			practiceGet1_3Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceGet1_3Request.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceGet1_3Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeGet/1.3", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeGet1_3Response practiceGet1_3Response = javascriptSerializer.Deserialize<PracticeGet1_3Response>(jsonResponse);

			Console.WriteLine(practiceGet1_3Response.responseCode);
			Console.WriteLine(practiceGet1_3Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeGet1_3Request : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_3 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public string ein { get; set;}
			public bool active { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string countryCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public bool vetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeGet1_3Response : UpdoxResponse {
			public ProviderInfoLimited1_3 practice { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeGet1_3 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeGet1_3 codeSample = new UpdoxCodeSample_PracticeGet1_3();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeGet1_3";

		PracticeGet1_3Request practiceGet1_3Request = new PracticeGet1_3Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceGet1_3Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceGet1_3Request.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceGet1_3Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeGet/1.3', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeGet1_3Response practiceGet1_3Response = mapper.readValue(jsonResponse, PracticeGet1_3Response.class);

		System.out.println(practiceGet1_3Response.getResponseCode());
		System.out.println(practiceGet1_3Response.getResponseMessage());
	}

	private class PracticeGet1_3Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_3 {
		private String accountId;
		private String name;
		private String nameHIPAACompliant;
		private String ein;
		private boolean active;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String countryCode;
		private String phone;
		private String fax;
		private String websiteUrl;
		private String alternativeWebsiteUrl;
		private boolean vetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public String getEin() {
			return ein;
		}

		public void setEin(String ein) {
			this.ein = ein;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeGet1_3Response extends UpdoxResponse {
		private ProviderInfoLimited1_3 practice;


		public ProviderInfoLimited1_3 getPractice() {
			return practice;
		}

		public void setPractice(ProviderInfoLimited1_3 practice) {
			this.practice = practice;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeList /io/PracticeList

Gets a list of practices associated with supplied vendor identifier

Outdated: A newer version of this endpoint is available.

Try it! Toggle Notes/Code Samples

PracticeList

Gets a list of practices associated with supplied vendor identifier

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeList codeSample = new UpdoxCodeSample_PracticeList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeList";
			PracticeListRequest practiceListRequest = new PracticeListRequest();

			//set up credentials
			practiceListRequest.auth.applicationId = "applicationId";
			practiceListRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeListResponse practiceListResponse = javascriptSerializer.Deserialize<PracticeListResponse>(jsonResponse);

			Console.WriteLine(practiceListResponse.responseCode);
			Console.WriteLine(practiceListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_0 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string metadata { get; set;}
			public string timeZone { get; set;}
			public bool isVetted { get; set;}
			public bool isActive { get; set;}
		}

		public class PracticeListResponse : UpdoxResponse {
			public List<ProviderInfoLimited1_0> practiceList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeList {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeList codeSample = new UpdoxCodeSample_PracticeList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeList";

		PracticeListRequest practiceListRequest = new PracticeListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeListResponse practiceListResponse = mapper.readValue(jsonResponse, PracticeListResponse.class);

		System.out.println(practiceListResponse.getResponseCode());
		System.out.println(practiceListResponse.getResponseMessage());
	}

	private class PracticeListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_0 {
		private String accountId;
		private String name;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String phone;
		private String fax;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String metadata;
		private String timeZone;
		private boolean isVetted;
		private boolean isActive;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isIsVetted() {
			return isVetted;
		}

		public void setIsVetted(boolean isVetted) {
			this.isVetted = isVetted;
		}

		public boolean isIsActive() {
			return isActive;
		}

		public void setIsActive(boolean isActive) {
			this.isActive = isActive;
		}
	}

	private static class PracticeListResponse extends UpdoxResponse {
		private List<ProviderInfoLimited1_0> practiceList;


		public List<ProviderInfoLimited1_0> getPracticeList() {
			return practiceList;
		}

		public void setPracticeList(List<ProviderInfoLimited1_0> practiceList) {
			this.practiceList = practiceList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeList/1.1 /io/PracticeList/1.1

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.0 to v1.1:

countryCode - the ISO 3166 Country Code Alpha-2 is now returned
practiceNpi - the NPI of the practice account is now returned
practiceSpecialityCode - the Provider Taxonomy Code is now returned

Outdated: A newer version of this endpoint is available.

Try it! Toggle Notes/Code Samples

PracticeList/1.1

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.0 to v1.1:

countryCode - the ISO 3166 Country Code Alpha-2 is now returned
practiceNpi - the NPI of the practice account is now returned
practiceSpecialityCode - the Provider Taxonomy Code is now returned

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeList1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeList1_1 codeSample = new UpdoxCodeSample_PracticeList1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeList1_1";
			PracticeList1_1Request practiceList1_1Request = new PracticeList1_1Request();

			//set up credentials
			practiceList1_1Request.auth.applicationId = "applicationId";
			practiceList1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceList1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeList/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeList1_1Response practiceList1_1Response = javascriptSerializer.Deserialize<PracticeList1_1Response>(jsonResponse);

			Console.WriteLine(practiceList1_1Response.responseCode);
			Console.WriteLine(practiceList1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeList1_1Request : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_1 {
			public string accountId { get; set;}
			public string name { get; set;}
			public bool isActive { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postalCode { get; set;}
			public string country { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public bool isVetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeList1_1Response : UpdoxResponse {
			public List<ProviderInfoLimited1_1> practiceList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeList1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeList1_1 codeSample = new UpdoxCodeSample_PracticeList1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeList1_1";

		PracticeList1_1Request practiceList1_1Request = new PracticeList1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceList1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceList1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeList/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeList1_1Response practiceList1_1Response = mapper.readValue(jsonResponse, PracticeList1_1Response.class);

		System.out.println(practiceList1_1Response.getResponseCode());
		System.out.println(practiceList1_1Response.getResponseMessage());
	}

	private class PracticeList1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_1 {
		private String accountId;
		private String name;
		private boolean isActive;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postalCode;
		private String country;
		private String phone;
		private String fax;
		private boolean isVetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public boolean isIsActive() {
			return isActive;
		}

		public void setIsActive(boolean isActive) {
			this.isActive = isActive;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostalCode() {
			return postalCode;
		}

		public void setPostalCode(String postalCode) {
			this.postalCode = postalCode;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public boolean isIsVetted() {
			return isVetted;
		}

		public void setIsVetted(boolean isVetted) {
			this.isVetted = isVetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeList1_1Response extends UpdoxResponse {
		private List<ProviderInfoLimited1_1> practiceList;


		public List<ProviderInfoLimited1_1> getPracticeList() {
			return practiceList;
		}

		public void setPracticeList(List<ProviderInfoLimited1_1> practiceList) {
			this.practiceList = practiceList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeList/1.2 /io/PracticeList/1.2

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.1 to v1.2:

Added the following fields to the response:

nameHIPAACompliant - the HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications
websiteUrl - the practice's website
alternativeWebsiteUrl - the practice's alternative website (e.g. Facebook or WebMD Profile)

Outdated: A newer version of this endpoint is available.

Try it! Toggle Notes/Code Samples

PracticeList/1.2

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.1 to v1.2:

Added the following fields to the response:

nameHIPAACompliant - the HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications
websiteUrl - the practice's website
alternativeWebsiteUrl - the practice's alternative website (e.g. Facebook or WebMD Profile)

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeList1_2 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeList1_2 codeSample = new UpdoxCodeSample_PracticeList1_2();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeList1_2";
			PracticeList1_2Request practiceList1_2Request = new PracticeList1_2Request();

			//set up credentials
			practiceList1_2Request.auth.applicationId = "applicationId";
			practiceList1_2Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceList1_2Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeList/1.2", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeList1_2Response practiceList1_2Response = javascriptSerializer.Deserialize<PracticeList1_2Response>(jsonResponse);

			Console.WriteLine(practiceList1_2Response.responseCode);
			Console.WriteLine(practiceList1_2Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeList1_2Request : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_2 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public bool active { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string countryCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public bool vetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeList1_2Response : UpdoxResponse {
			public List<ProviderInfoLimited1_2> practiceList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeList1_2 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeList1_2 codeSample = new UpdoxCodeSample_PracticeList1_2();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeList1_2";

		PracticeList1_2Request practiceList1_2Request = new PracticeList1_2Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceList1_2Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceList1_2Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeList/1.2', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeList1_2Response practiceList1_2Response = mapper.readValue(jsonResponse, PracticeList1_2Response.class);

		System.out.println(practiceList1_2Response.getResponseCode());
		System.out.println(practiceList1_2Response.getResponseMessage());
	}

	private class PracticeList1_2Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_2 {
		private String accountId;
		private String name;
		private String nameHIPAACompliant;
		private boolean active;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String countryCode;
		private String phone;
		private String fax;
		private String websiteUrl;
		private String alternativeWebsiteUrl;
		private boolean vetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeList1_2Response extends UpdoxResponse {
		private List<ProviderInfoLimited1_2> practiceList;


		public List<ProviderInfoLimited1_2> getPracticeList() {
			return practiceList;
		}

		public void setPracticeList(List<ProviderInfoLimited1_2> practiceList) {
			this.practiceList = practiceList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeList/1.3 /io/PracticeList/1.3

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.2 to v1.3:

Added the following fields to the response:

ein - Added optional field for the practice Employer Identification Number (EIN) associated with the account

Try it! Toggle Notes/Code Samples

PracticeList/1.3

Gets a list of practices associated with supplied vendor identifier.

Changes from v1.2 to v1.3:

Added the following fields to the response:

ein - Added optional field for the practice Employer Identification Number (EIN) associated with the account

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeList1_3 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeList1_3 codeSample = new UpdoxCodeSample_PracticeList1_3();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeList1_3";
			PracticeList1_3Request practiceList1_3Request = new PracticeList1_3Request();

			//set up credentials
			practiceList1_3Request.auth.applicationId = "applicationId";
			practiceList1_3Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(practiceList1_3Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeList/1.3", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeList1_3Response practiceList1_3Response = javascriptSerializer.Deserialize<PracticeList1_3Response>(jsonResponse);

			Console.WriteLine(practiceList1_3Response.responseCode);
			Console.WriteLine(practiceList1_3Response.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeList1_3Request : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ProviderInfoLimited1_3 {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public string ein { get; set;}
			public bool active { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string countryCode { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public bool vetted { get; set;}
			public string directAddress { get; set;}
			public string directDomain { get; set;}
			public string websiteAddress { get; set;}
			public string practiceNpi { get; set;}
			public string practiceSpecialityCode { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
		}

		public class PracticeList1_3Response : UpdoxResponse {
			public List<ProviderInfoLimited1_3> practiceList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeList1_3 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeList1_3 codeSample = new UpdoxCodeSample_PracticeList1_3();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeList1_3";

		PracticeList1_3Request practiceList1_3Request = new PracticeList1_3Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceList1_3Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceList1_3Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeList/1.3', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeList1_3Response practiceList1_3Response = mapper.readValue(jsonResponse, PracticeList1_3Response.class);

		System.out.println(practiceList1_3Response.getResponseCode());
		System.out.println(practiceList1_3Response.getResponseMessage());
	}

	private class PracticeList1_3Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ProviderInfoLimited1_3 {
		private String accountId;
		private String name;
		private String nameHIPAACompliant;
		private String ein;
		private boolean active;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String countryCode;
		private String phone;
		private String fax;
		private String websiteUrl;
		private String alternativeWebsiteUrl;
		private boolean vetted;
		private String directAddress;
		private String directDomain;
		private String websiteAddress;
		private String practiceNpi;
		private String practiceSpecialityCode;
		private String timeZone;
		private String metadata;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public String getEin() {
			return ein;
		}

		public void setEin(String ein) {
			this.ein = ein;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountryCode() {
			return countryCode;
		}

		public void setCountryCode(String countryCode) {
			this.countryCode = countryCode;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public String getPracticeSpecialityCode() {
			return practiceSpecialityCode;
		}

		public void setPracticeSpecialityCode(String practiceSpecialityCode) {
			this.practiceSpecialityCode = practiceSpecialityCode;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private static class PracticeList1_3Response extends UpdoxResponse {
		private List<ProviderInfoLimited1_3> practiceList;


		public List<ProviderInfoLimited1_3> getPracticeList() {
			return practiceList;
		}

		public void setPracticeList(List<ProviderInfoLimited1_3> practiceList) {
			this.practiceList = practiceList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

PracticeSave /io/PracticeSave

Creates or updates the practice with the accountId passed into auth. If a practice with that ID does not exist, a practice is created, else that practice is updated. The accountId cannot contain whitespace characters after February 2024.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		REQUIRED: Account Identifier must be specified here or in the Auth Header. The new account ID to be associated to this account for Application Authorization. Max length 255 characters.
name	String		The name of the practice. Max length 100 characters. This is required.
address1	String		Max length 100 characters.
address2	String		Max length 100 characters.
city	String		Max length 50 characters.
state	String		Must be a valid 2 character state code. Max length 2 characters.
postal	String		Max length 5 characters.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeSave

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeSave codeSample = new UpdoxCodeSample_PracticeSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeSave";
			PracticeSaveRequest practiceSaveRequest = new PracticeSaveRequest();

			//set up credentials
			practiceSaveRequest.auth.applicationId = "applicationId";
			practiceSaveRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceSaveRequest.accountId = "accountId";
			practiceSaveRequest.name = "name";
			practiceSaveRequest.address1 = "address1";
			practiceSaveRequest.address2 = "address2";
			practiceSaveRequest.city = "Dublin";
			practiceSaveRequest.state = "OH";
			practiceSaveRequest.postal = "postal";
			practiceSaveRequest.phone = "6148675309";
			practiceSaveRequest.fax = "fax";
			practiceSaveRequest.websiteAddress = "websiteAddress";
			practiceSaveRequest.timeZone = "timeZone";
			practiceSaveRequest.directDomain = "directDomain";
			practiceSaveRequest.directAddress = "directAddress";
			practiceSaveRequest.protocol = "protocol";
			practiceSaveRequest.ipAddress = "ipAddress";
			practiceSaveRequest.port = 1L;
			practiceSaveRequest.path = "path";
			practiceSaveRequest.active = true;
			practiceSaveRequest.metadata = "metadata";
			practiceSaveRequest.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceSaveRequest.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceSaveRequest.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeSaveResponse practiceSaveResponse = javascriptSerializer.Deserialize<PracticeSaveResponse>(jsonResponse);

			Console.WriteLine(practiceSaveResponse.responseCode);
			Console.WriteLine(practiceSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeSaveRequest : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeSaveResponse : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeSave {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeSave codeSample = new UpdoxCodeSample_PracticeSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeSave";

		PracticeSaveRequest practiceSaveRequest = new PracticeSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceSaveRequest.setAccountId("accountId");
		practiceSaveRequest.setName("name");
		practiceSaveRequest.setAddress1("address1");
		practiceSaveRequest.setAddress2("address2");
		practiceSaveRequest.setCity("Dublin");
		practiceSaveRequest.setState("OH");
		practiceSaveRequest.setPostal("postal");
		practiceSaveRequest.setPhone("6148675309");
		practiceSaveRequest.setFax("fax");
		practiceSaveRequest.setWebsiteAddress("websiteAddress");
		practiceSaveRequest.setTimeZone("timeZone");
		practiceSaveRequest.setDirectDomain("directDomain");
		practiceSaveRequest.setDirectAddress("directAddress");
		practiceSaveRequest.setProtocol("protocol");
		practiceSaveRequest.setIpAddress("ipAddress");
		practiceSaveRequest.setPort(1L);
		practiceSaveRequest.setPath("path");
		practiceSaveRequest.setActive(true);
		practiceSaveRequest.setMetadata("metadata");
		practiceSaveRequest.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceSaveRequest.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceSaveRequest.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeSaveResponse practiceSaveResponse = mapper.readValue(jsonResponse, PracticeSaveResponse.class);

		System.out.println(practiceSaveResponse.getResponseCode());
		System.out.println(practiceSaveResponse.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String phone;
    	private String fax;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeSaveResponse extends UpdoxResponse {
		private String accountId;
		private String action;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4161`	`web address is invalid`
`4140`	`web address is already taken`
`4066`	`This API has been deprecated and can no longer be used. Please reference the Updox Interactive API page for information regarding the current version of this API`

PracticeSave/1.1 /io/PracticeSave/1.1

Creates or updates the practice with the accountId passed into auth. If a practice with that ID does not exist, a practice is created; else the practice is updated. The accountId cannot contain whitespace characters after February 2024.

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Parameter	Type	Value	Description
accountId	String		The new account ID to be associated to this account for Application Authorization. Max length 255 characters. This is required.
name	String		The name of the practice. Max length 100 characters. This is required.
nameHIPAACompliant	String		Specify a HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications. For example, "Updox Public Health Clinic of New York City" to "Updox NYC Clinic." Null or empty value will not overwrite existing value, but blank will clear. Max length 100 characters.
ein	String		The Employer Identification Number (EIN) associated with the account. If an EIN is already on file, a new value will overwrite it. Null or empty value will not overwrite existing value, but blank will clear. Input format `XX-XXXXXXX` or `SOLE_PROPRIETOR`.
address1	String		Max length 100 characters. This is required.
address2	String		Max length 100 characters.
city	String		Max length 50 characters. This is required.
state	String		The account's 2 character state code address. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters. This is required.
postal	String		The account's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters. This is required.
country	String		The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". . This is required.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteUrl	String		Website for the practice. For example, "https://www.updox.com/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
alternativeWebsiteUrl	String		This can be either a Practice Facebook URL or WebMD Profile URL. For example, "https://www.facebook.com/updox/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters. This is required.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeSave/1.1

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Possible nonBlockingErrors Updox may return:

Failed to add module id: %d - Applicable for all integrations. Means that a module of Updox functionality was not able to be added to this practice at this time. The %d will be replaced by the module_id number that Updox was unable to add. Example: When adding module_id == 11, aka "SMS", Updox may fail to provision a phone number for the practice despite a series of attempts. Should there be an attempt to add module_id == 11 again, a new set of provisionable numbers will be utilized. Resolution: use ModuleActions PracticeModuleSave method.
Failed to add all CSV maps - Only applicable if the integration utilizes CSVs. Resolution: contact Partner Support.
Failed to update patient portal - Only applicable if the integration utilizes the Updox Patient Portal. Resolution: use PortalActions PortalConfigure method.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeSave1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeSave1_1 codeSample = new UpdoxCodeSample_PracticeSave1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeSave1_1";
			PracticeSave1_1Request practiceSave1_1Request = new PracticeSave1_1Request();

			//set up credentials
			practiceSave1_1Request.auth.applicationId = "applicationId";
			practiceSave1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceSave1_1Request.accountId = "accountId";
			practiceSave1_1Request.name = "name";
			practiceSave1_1Request.nameHIPAACompliant = "nameHIPAACompliant";
			practiceSave1_1Request.ein = "ein";
			practiceSave1_1Request.address1 = "address1";
			practiceSave1_1Request.address2 = "address2";
			practiceSave1_1Request.city = "Dublin";
			practiceSave1_1Request.state = "OH";
			practiceSave1_1Request.postal = "postal";
			practiceSave1_1Request.country = "country";
			practiceSave1_1Request.phone = "6148675309";
			practiceSave1_1Request.fax = "fax";
			practiceSave1_1Request.websiteUrl = "websiteUrl";
			practiceSave1_1Request.alternativeWebsiteUrl = "alternativeWebsiteUrl";
			practiceSave1_1Request.websiteAddress = "websiteAddress";
			practiceSave1_1Request.timeZone = "timeZone";
			practiceSave1_1Request.directDomain = "directDomain";
			practiceSave1_1Request.directAddress = "directAddress";
			practiceSave1_1Request.protocol = "protocol";
			practiceSave1_1Request.ipAddress = "ipAddress";
			practiceSave1_1Request.port = 1L;
			practiceSave1_1Request.path = "path";
			practiceSave1_1Request.active = true;
			practiceSave1_1Request.metadata = "metadata";
			practiceSave1_1Request.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceSave1_1Request.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceSave1_1Request.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceSave1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeSave/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeSave1_1Response practiceSave1_1Response = javascriptSerializer.Deserialize<PracticeSave1_1Response>(jsonResponse);

			Console.WriteLine(practiceSave1_1Response.responseCode);
			Console.WriteLine(practiceSave1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeSave1_1Request : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public string ein { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeSave1_1Response : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
			public List<string> nonBlockingErrors { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeSave1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeSave1_1 codeSample = new UpdoxCodeSample_PracticeSave1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeSave1_1";

		PracticeSave1_1Request practiceSave1_1Request = new PracticeSave1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceSave1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceSave1_1Request.setAccountId("accountId");
		practiceSave1_1Request.setName("name");
		practiceSave1_1Request.setNameHIPAACompliant("nameHIPAACompliant");
		practiceSave1_1Request.setEin("ein");
		practiceSave1_1Request.setAddress1("address1");
		practiceSave1_1Request.setAddress2("address2");
		practiceSave1_1Request.setCity("Dublin");
		practiceSave1_1Request.setState("OH");
		practiceSave1_1Request.setPostal("postal");
		practiceSave1_1Request.setCountry("country");
		practiceSave1_1Request.setPhone("6148675309");
		practiceSave1_1Request.setFax("fax");
		practiceSave1_1Request.setWebsiteUrl("websiteUrl");
		practiceSave1_1Request.setAlternativeWebsiteUrl("alternativeWebsiteUrl");
		practiceSave1_1Request.setWebsiteAddress("websiteAddress");
		practiceSave1_1Request.setTimeZone("timeZone");
		practiceSave1_1Request.setDirectDomain("directDomain");
		practiceSave1_1Request.setDirectAddress("directAddress");
		practiceSave1_1Request.setProtocol("protocol");
		practiceSave1_1Request.setIpAddress("ipAddress");
		practiceSave1_1Request.setPort(1L);
		practiceSave1_1Request.setPath("path");
		practiceSave1_1Request.setActive(true);
		practiceSave1_1Request.setMetadata("metadata");
		practiceSave1_1Request.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceSave1_1Request.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceSave1_1Request.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceSave1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeSave/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeSave1_1Response practiceSave1_1Response = mapper.readValue(jsonResponse, PracticeSave1_1Response.class);

		System.out.println(practiceSave1_1Response.getResponseCode());
		System.out.println(practiceSave1_1Response.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeSave1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String nameHIPAACompliant;
    	private String ein;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String phone;
    	private String fax;
    	private String websiteUrl;
    	private String alternativeWebsiteUrl;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public String getEin() {
			return ein;
		}

		public void setEin(String ein) {
			this.ein = ein;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeSave1_1Response extends UpdoxResponse {
		private String accountId;
		private String action;
		private List<String> nonBlockingErrors;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public List<String> getNonBlockingErrors() {
			return nonBlockingErrors;
		}

		public void setNonBlockingErrors(List<String> nonBlockingErrors) {
			this.nonBlockingErrors = nonBlockingErrors;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4161`	`web address is invalid`
`4140`	`web address is already taken`
`4133`	`Account cannot be reopened since data has been purged. Open a new account instead.`

PracticeUpdate /io/PracticeUpdate

Updates the practice with the accountId passed into auth.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		REQUIRED: Account Identifier must be specified here or in the Auth Header. The new account ID to be associated to this account for Application Authorization. Max length 255 characters.
name	String		The name of the practice. Max length 100 characters. This is required.
address1	String		Max length 100 characters.
address2	String		Max length 100 characters.
city	String		Max length 50 characters.
state	String		Must be a valid 2 character state code. Max length 2 characters.
postal	String		Max length 5 characters.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeUpdate

Updates the practice with the accountId passed into auth.

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeUpdate codeSample = new UpdoxCodeSample_PracticeUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeUpdate";
			PracticeUpdateRequest practiceUpdateRequest = new PracticeUpdateRequest();

			//set up credentials
			practiceUpdateRequest.auth.applicationId = "applicationId";
			practiceUpdateRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceUpdateRequest.accountId = "accountId";
			practiceUpdateRequest.name = "name";
			practiceUpdateRequest.address1 = "address1";
			practiceUpdateRequest.address2 = "address2";
			practiceUpdateRequest.city = "Dublin";
			practiceUpdateRequest.state = "OH";
			practiceUpdateRequest.postal = "postal";
			practiceUpdateRequest.phone = "6148675309";
			practiceUpdateRequest.fax = "fax";
			practiceUpdateRequest.websiteAddress = "websiteAddress";
			practiceUpdateRequest.timeZone = "timeZone";
			practiceUpdateRequest.directDomain = "directDomain";
			practiceUpdateRequest.directAddress = "directAddress";
			practiceUpdateRequest.protocol = "protocol";
			practiceUpdateRequest.ipAddress = "ipAddress";
			practiceUpdateRequest.port = 1L;
			practiceUpdateRequest.path = "path";
			practiceUpdateRequest.active = true;
			practiceUpdateRequest.metadata = "metadata";
			practiceUpdateRequest.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceUpdateRequest.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceUpdateRequest.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeUpdateResponse practiceUpdateResponse = javascriptSerializer.Deserialize<PracticeUpdateResponse>(jsonResponse);

			Console.WriteLine(practiceUpdateResponse.responseCode);
			Console.WriteLine(practiceUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeUpdateRequest : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeUpdateResponse : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeUpdate codeSample = new UpdoxCodeSample_PracticeUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeUpdate";

		PracticeUpdateRequest practiceUpdateRequest = new PracticeUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceUpdateRequest.setAccountId("accountId");
		practiceUpdateRequest.setName("name");
		practiceUpdateRequest.setAddress1("address1");
		practiceUpdateRequest.setAddress2("address2");
		practiceUpdateRequest.setCity("Dublin");
		practiceUpdateRequest.setState("OH");
		practiceUpdateRequest.setPostal("postal");
		practiceUpdateRequest.setPhone("6148675309");
		practiceUpdateRequest.setFax("fax");
		practiceUpdateRequest.setWebsiteAddress("websiteAddress");
		practiceUpdateRequest.setTimeZone("timeZone");
		practiceUpdateRequest.setDirectDomain("directDomain");
		practiceUpdateRequest.setDirectAddress("directAddress");
		practiceUpdateRequest.setProtocol("protocol");
		practiceUpdateRequest.setIpAddress("ipAddress");
		practiceUpdateRequest.setPort(1L);
		practiceUpdateRequest.setPath("path");
		practiceUpdateRequest.setActive(true);
		practiceUpdateRequest.setMetadata("metadata");
		practiceUpdateRequest.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceUpdateRequest.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceUpdateRequest.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeUpdateResponse practiceUpdateResponse = mapper.readValue(jsonResponse, PracticeUpdateResponse.class);

		System.out.println(practiceUpdateResponse.getResponseCode());
		System.out.println(practiceUpdateResponse.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String phone;
    	private String fax;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeUpdateResponse extends UpdoxResponse {
		private String accountId;
		private String action;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4140`	`web address is already taken`
`4161`	`web address is invalid`
`4066`	`This API has been deprecated and can no longer be used. Please reference the Updox Interactive API page for information regarding the current version of this API`

PracticeUpdate/1.1 /io/PracticeUpdate/1.1

Updates the practice with the accountId passed into auth.

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Parameter	Type	Value	Description
accountId	String		The new account ID to be associated to this account for Application Authorization. Max length 255 characters. This is required.
name	String		The name of the practice. Max length 100 characters. This is required.
nameHIPAACompliant	String		Specify a HIPAA-compliant practice name that could be used in place of "Medical provider" in patient-facing communications. For example, "Updox Public Health Clinic of New York City" to "Updox NYC Clinic." Null or empty value will not overwrite existing value, but blank will clear. Max length 100 characters.
ein	String		The Employer Identification Number (EIN) associated with the account. If an EIN is already on file, a new value will overwrite it. Null or empty value will not overwrite existing value, but blank will clear. Input format `XX-XXXXXXX` or `SOLE_PROPRIETOR`.
address1	String		Max length 100 characters. This is required.
address2	String		Max length 100 characters.
city	String		Max length 50 characters. This is required.
state	String		The account's 2 character state code address. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters. This is required.
postal	String		The account's valid postal code based on the country: If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters. This is required.
country	String		The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". . This is required.
phone	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
fax	String		The value must contain exactly 10 characters. Must be a valid phone number, 10 digits only.
websiteUrl	String		Website for the practice. For example, "https://www.updox.com/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
alternativeWebsiteUrl	String		This can be either a Practice Facebook URL or WebMD Profile URL. For example, "https://www.facebook.com/updox/". Must include "https://"; will save as lowercase "https://" regardless of case (i.e. case insensitive). If update event, null or empty value will not overwrite existing value, but blank will clear. Value will be trimmed. Max length 255 characters.
websiteAddress	String		The subdomain configured for this account's portal webpage. The value passed will be substituted as https://{websiteAddress}.vendordomain.com. Max length 100 characters.
timeZone	String		Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters. This is required.
directDomain	String		The direct subdomain for the account. All users in this account will use this domain for their direct address. If null or blank, the account's direct subdomain will not be set. The `directDomain` is required for application/vendors with "domain" certificates. If populated with a value, Updox will ensure the value contains both the account's subdomain and application/vendor's domain. Updox will append the application/vendor's domain automatically if needed to create the final domain for the account. For example, if the application/vendor domain is "updox.example" and `directDomain` is "account1", then the final domain will be: "account1.updox.example". The final domain must conform to the max length. Max length 64 characters.
directAddress	String		The username for an account level direct address. The username is the value left of the @ in the full direct address. Any "@domain" content if present will be stripped off before saving this value. For example, if `directAddress` is "staff", `directDomain` is "account1", and the application/vendor domain is "updox.example"; then the full account level direct address will be "staff@account1.updox.example". Updox validates the max direct address length before removing the extraneous data. Max length 100 characters.
protocol	String		The protocol associated with this account. (HTTP or HTTPS).
ipAddress	String		The IP address associated with this account.
port	Long		The port associated with this account.
path	String		The path associated with this account.
active	Boolean		True if active. If false, this account and all users in this account will fail authorization. This is required.
metadata	String		The metadata associated with this account. Used for vendor information only. Max length 10,000,000 characters.
practiceSpecialtyCode	String		The Practice Specialty NUCC code.
practiceNpi	String		The Practice NPI.
defaultConsentMethods	List	add remove	Default communication consent preferences for automated delivery in the absence of a patient consent.

method	String		Must be one of the following values: EMAIL, TEXT, VOICE. This is required.
consent	Boolean		This is required.

Try it! Toggle Notes/Code Samples

PracticeUpdate/1.1

Updates the practice with the accountId passed into auth.

Changes from v1.0 to v1.1:

accountId - Updated parsing allowing this only to be supplied in the request body and NOT the auth header
Address information is now required
country - Added required field which collects the country code for the address
timeZone - is now required
nameHIPAACompliant - Added optional field to specify a HIPAA-compliant name for the practice in patient-facing communications
websiteUrl - Added optional field for the practice's website
alternativeWebsiteUrl - Added optional field for the practice's alternative website (e.g. Facebook or WebMD Profile)
nonBlockingErrors - An additional List of String(s) in the response which contains non-blocking errors related to processing this action (see notes for details)
Added Fail Code 4133 if an update attempt is made against a purged account
ein - Added optional field for the practice Employer Identification Number. For practices meeting the IRS designation of being a sole proprietorship, use the value SOLE_PROPRIETOR

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Possible nonBlockingErrors Updox may return:

Currently none.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeUpdate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeUpdate1_1 codeSample = new UpdoxCodeSample_PracticeUpdate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeUpdate1_1";
			PracticeUpdate1_1Request practiceUpdate1_1Request = new PracticeUpdate1_1Request();

			//set up credentials
			practiceUpdate1_1Request.auth.applicationId = "applicationId";
			practiceUpdate1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceUpdate1_1Request.accountId = "accountId";
			practiceUpdate1_1Request.name = "name";
			practiceUpdate1_1Request.nameHIPAACompliant = "nameHIPAACompliant";
			practiceUpdate1_1Request.ein = "ein";
			practiceUpdate1_1Request.address1 = "address1";
			practiceUpdate1_1Request.address2 = "address2";
			practiceUpdate1_1Request.city = "Dublin";
			practiceUpdate1_1Request.state = "OH";
			practiceUpdate1_1Request.postal = "postal";
			practiceUpdate1_1Request.country = "country";
			practiceUpdate1_1Request.phone = "6148675309";
			practiceUpdate1_1Request.fax = "fax";
			practiceUpdate1_1Request.websiteUrl = "websiteUrl";
			practiceUpdate1_1Request.alternativeWebsiteUrl = "alternativeWebsiteUrl";
			practiceUpdate1_1Request.websiteAddress = "websiteAddress";
			practiceUpdate1_1Request.timeZone = "timeZone";
			practiceUpdate1_1Request.directDomain = "directDomain";
			practiceUpdate1_1Request.directAddress = "directAddress";
			practiceUpdate1_1Request.protocol = "protocol";
			practiceUpdate1_1Request.ipAddress = "ipAddress";
			practiceUpdate1_1Request.port = 1L;
			practiceUpdate1_1Request.path = "path";
			practiceUpdate1_1Request.active = true;
			practiceUpdate1_1Request.metadata = "metadata";
			practiceUpdate1_1Request.practiceSpecialtyCode = "practiceSpecialtyCode";
			practiceUpdate1_1Request.practiceNpi = "practiceNpi";
			List<CommunicationConsentMethodRequest> defaultConsentMethods = new List<CommunicationConsentMethodRequest>();
			CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
			communicationConsentMethodRequest.method = "method";
			communicationConsentMethodRequest.consent = true;
			defaultConsentMethods.Add(communicationConsentMethodRequest);
			practiceUpdate1_1Request.defaultConsentMethods = defaultConsentMethods;

			//create the request
			string json = Utilities.buildRequestJson(practiceUpdate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeUpdate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeUpdate1_1Response practiceUpdate1_1Response = javascriptSerializer.Deserialize<PracticeUpdate1_1Response>(jsonResponse);

			Console.WriteLine(practiceUpdate1_1Response.responseCode);
			Console.WriteLine(practiceUpdate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class CommunicationConsentMethodRequest {
			public string method { get; set;}
			public bool consent { get; set;}
		}

		public class PracticeUpdate1_1Request : UpdoxRequest {
			public string accountId { get; set;}
			public string name { get; set;}
			public string nameHIPAACompliant { get; set;}
			public string ein { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string phone { get; set;}
			public string fax { get; set;}
			public string websiteUrl { get; set;}
			public string alternativeWebsiteUrl { get; set;}
			public string websiteAddress { get; set;}
			public string timeZone { get; set;}
			public string directDomain { get; set;}
			public string directAddress { get; set;}
			public string protocol { get; set;}
			public string ipAddress { get; set;}
			public long port { get; set;}
			public string path { get; set;}
			public bool active { get; set;}
			public string metadata { get; set;}
			public string practiceSpecialtyCode { get; set;}
			public string practiceNpi { get; set;}
			public List<CommunicationConsentMethodRequest> defaultConsentMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class PracticeUpdate1_1Response : UpdoxResponse {
			public string accountId { get; set;}
			public string action { get; set;}
			public List<string> nonBlockingErrors { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_PracticeUpdate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeUpdate1_1 codeSample = new UpdoxCodeSample_PracticeUpdate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeUpdate1_1";

		PracticeUpdate1_1Request practiceUpdate1_1Request = new PracticeUpdate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceUpdate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceUpdate1_1Request.setAccountId("accountId");
		practiceUpdate1_1Request.setName("name");
		practiceUpdate1_1Request.setNameHIPAACompliant("nameHIPAACompliant");
		practiceUpdate1_1Request.setEin("ein");
		practiceUpdate1_1Request.setAddress1("address1");
		practiceUpdate1_1Request.setAddress2("address2");
		practiceUpdate1_1Request.setCity("Dublin");
		practiceUpdate1_1Request.setState("OH");
		practiceUpdate1_1Request.setPostal("postal");
		practiceUpdate1_1Request.setCountry("country");
		practiceUpdate1_1Request.setPhone("6148675309");
		practiceUpdate1_1Request.setFax("fax");
		practiceUpdate1_1Request.setWebsiteUrl("websiteUrl");
		practiceUpdate1_1Request.setAlternativeWebsiteUrl("alternativeWebsiteUrl");
		practiceUpdate1_1Request.setWebsiteAddress("websiteAddress");
		practiceUpdate1_1Request.setTimeZone("timeZone");
		practiceUpdate1_1Request.setDirectDomain("directDomain");
		practiceUpdate1_1Request.setDirectAddress("directAddress");
		practiceUpdate1_1Request.setProtocol("protocol");
		practiceUpdate1_1Request.setIpAddress("ipAddress");
		practiceUpdate1_1Request.setPort(1L);
		practiceUpdate1_1Request.setPath("path");
		practiceUpdate1_1Request.setActive(true);
		practiceUpdate1_1Request.setMetadata("metadata");
		practiceUpdate1_1Request.setPracticeSpecialtyCode("practiceSpecialtyCode");
		practiceUpdate1_1Request.setPracticeNpi("practiceNpi");
	List<CommunicationConsentMethodRequest> defaultConsentMethods = new ArrayList<>();
		CommunicationConsentMethodRequest communicationConsentMethodRequest = new CommunicationConsentMethodRequest();
		communicationConsentMethodRequest.setMethod("method");
		communicationConsentMethodRequest.setConsent(true);
		defaultConsentMethods.add(communicationConsentMethodRequest);
		practiceUpdate1_1Request.setDefaultConsentMethods(defaultConsentMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceUpdate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeUpdate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeUpdate1_1Response practiceUpdate1_1Response = mapper.readValue(jsonResponse, PracticeUpdate1_1Response.class);

		System.out.println(practiceUpdate1_1Response.getResponseCode());
		System.out.println(practiceUpdate1_1Response.getResponseMessage());
	}

	private static class CommunicationConsentMethodRequest {
		private String method;
		private Boolean consent;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public Boolean isConsent() {
			return consent;
		}

		public void setConsent(Boolean consent) {
			this.consent = consent;
		}
	}

	private class PracticeUpdate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;
    	private String name;
    	private String nameHIPAACompliant;
    	private String ein;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String phone;
    	private String fax;
    	private String websiteUrl;
    	private String alternativeWebsiteUrl;
    	private String websiteAddress;
    	private String timeZone;
    	private String directDomain;
    	private String directAddress;
    	private String protocol;
    	private String ipAddress;
    	private Long port;
    	private String path;
    	private boolean active;
    	private String metadata;
    	private String practiceSpecialtyCode;
    	private String practiceNpi;
    	private List<CommunicationConsentMethodRequest> defaultConsentMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getNameHIPAACompliant() {
			return nameHIPAACompliant;
		}

		public void setNameHIPAACompliant(String nameHIPAACompliant) {
			this.nameHIPAACompliant = nameHIPAACompliant;
		}

		public String getEin() {
			return ein;
		}

		public void setEin(String ein) {
			this.ein = ein;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getPhone() {
			return phone;
		}

		public void setPhone(String phone) {
			this.phone = phone;
		}

		public String getFax() {
			return fax;
		}

		public void setFax(String fax) {
			this.fax = fax;
		}

		public String getWebsiteUrl() {
			return websiteUrl;
		}

		public void setWebsiteUrl(String websiteUrl) {
			this.websiteUrl = websiteUrl;
		}

		public String getAlternativeWebsiteUrl() {
			return alternativeWebsiteUrl;
		}

		public void setAlternativeWebsiteUrl(String alternativeWebsiteUrl) {
			this.alternativeWebsiteUrl = alternativeWebsiteUrl;
		}

		public String getWebsiteAddress() {
			return websiteAddress;
		}

		public void setWebsiteAddress(String websiteAddress) {
			this.websiteAddress = websiteAddress;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getDirectDomain() {
			return directDomain;
		}

		public void setDirectDomain(String directDomain) {
			this.directDomain = directDomain;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getProtocol() {
			return protocol;
		}

		public void setProtocol(String protocol) {
			this.protocol = protocol;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public Long getPort() {
			return port;
		}

		public void setPort(Long port) {
			this.port = port;
		}

		public String getPath() {
			return path;
		}

		public void setPath(String path) {
			this.path = path;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public String getPracticeSpecialtyCode() {
			return practiceSpecialtyCode;
		}

		public void setPracticeSpecialtyCode(String practiceSpecialtyCode) {
			this.practiceSpecialtyCode = practiceSpecialtyCode;
		}

		public String getPracticeNpi() {
			return practiceNpi;
		}

		public void setPracticeNpi(String practiceNpi) {
			this.practiceNpi = practiceNpi;
		}

		public List<CommunicationConsentMethodRequest> getDefaultConsentMethods() {
			return defaultConsentMethods;
		}

		public void setDefaultConsentMethods(List<CommunicationConsentMethodRequest> defaultConsentMethods) {
			this.defaultConsentMethods = defaultConsentMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeUpdate1_1Response extends UpdoxResponse {
		private String accountId;
		private String action;
		private List<String> nonBlockingErrors;


		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}

		public List<String> getNonBlockingErrors() {
			return nonBlockingErrors;
		}

		public void setNonBlockingErrors(List<String> nonBlockingErrors) {
			this.nonBlockingErrors = nonBlockingErrors;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`
`4160`	`direct domain is invalid`
`4621`	`direct address error: domain does not match the direct domain for this vendor`
`4150`	`direct domain is already taken`
`4163`	`direct domain is unavailable`
`4610`	`direct address error: direct address is taken`
`4140`	`web address is already taken`
`4161`	`web address is invalid`
`4133`	`Account cannot be reopened since data has been purged. Open a new account instead.`

PracticeVettedDisable /io/PracticeVettedDisable

Disables the vetted status of a practice and the users in that practice.

Parameter	Type	Value	Description
accountId	String		The account ID of the practice to toggle. Max length 255 characters.

Try it! Toggle Notes/Code Samples

PracticeVettedDisable

Disables the vetted status of a practice and the users in that practice.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeVettedDisable {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeVettedDisable codeSample = new UpdoxCodeSample_PracticeVettedDisable();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeVettedDisable";
			PracticeVettedDisableRequest practiceVettedDisableRequest = new PracticeVettedDisableRequest();

			//set up credentials
			practiceVettedDisableRequest.auth.applicationId = "applicationId";
			practiceVettedDisableRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceVettedDisableRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceVettedDisableRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeVettedDisable", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeVettedDisableResponse practiceVettedDisableResponse = javascriptSerializer.Deserialize<PracticeVettedDisableResponse>(jsonResponse);

			Console.WriteLine(practiceVettedDisableResponse.responseCode);
			Console.WriteLine(practiceVettedDisableResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeVettedDisableRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PracticeVettedDisableResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeVettedDisable {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeVettedDisable codeSample = new UpdoxCodeSample_PracticeVettedDisable();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeVettedDisable";

		PracticeVettedDisableRequest practiceVettedDisableRequest = new PracticeVettedDisableRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceVettedDisableRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceVettedDisableRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceVettedDisableRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeVettedDisable', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeVettedDisableResponse practiceVettedDisableResponse = mapper.readValue(jsonResponse, PracticeVettedDisableResponse.class);

		System.out.println(practiceVettedDisableResponse.getResponseCode());
		System.out.println(practiceVettedDisableResponse.getResponseMessage());
	}

	private class PracticeVettedDisableRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeVettedDisableResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`

PracticeVettedToggle /io/PracticeVettedToggle

FOR QA TESTING ONLY: Toggles the vetted status of a practice and the users in that practice.

Parameter	Type	Value	Description
accountId	String		The account ID of the practice to toggle. Max length 255 characters.

Try it! Toggle Notes/Code Samples

PracticeVettedToggle

FOR QA TESTING ONLY: Toggles the vetted status of a practice and the users in that practice.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_PracticeVettedToggle {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_PracticeVettedToggle codeSample = new UpdoxCodeSample_PracticeVettedToggle();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "PracticeVettedToggle";
			PracticeVettedToggleRequest practiceVettedToggleRequest = new PracticeVettedToggleRequest();

			//set up credentials
			practiceVettedToggleRequest.auth.applicationId = "applicationId";
			practiceVettedToggleRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			practiceVettedToggleRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(practiceVettedToggleRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "PracticeVettedToggle", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			PracticeVettedToggleResponse practiceVettedToggleResponse = javascriptSerializer.Deserialize<PracticeVettedToggleResponse>(jsonResponse);

			Console.WriteLine(practiceVettedToggleResponse.responseCode);
			Console.WriteLine(practiceVettedToggleResponse.responseMessage);

			Environment.Exit (0);
		}


		public class PracticeVettedToggleRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class PracticeVettedToggleResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_PracticeVettedToggle {

	public static void main(String[] args) {
		UpdoxCodeSample_PracticeVettedToggle codeSample = new UpdoxCodeSample_PracticeVettedToggle();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "PracticeVettedToggle";

		PracticeVettedToggleRequest practiceVettedToggleRequest = new PracticeVettedToggleRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = practiceVettedToggleRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		practiceVettedToggleRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(practiceVettedToggleRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'PracticeVettedToggle', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		PracticeVettedToggleResponse practiceVettedToggleResponse = mapper.readValue(jsonResponse, PracticeVettedToggleResponse.class);

		System.out.println(practiceVettedToggleResponse.getResponseCode());
		System.out.println(practiceVettedToggleResponse.getResponseMessage());
	}

	private class PracticeVettedToggleRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class PracticeVettedToggleResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`

ScriptListGet /io/ScriptListGet

Gets the scripts associated with supplied accountId.

Parameter	Type	Value	Description
accountId	String		The ID of the account to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

ScriptListGet

Gets the scripts associated with supplied accountId.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ScriptListGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ScriptListGet codeSample = new UpdoxCodeSample_ScriptListGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ScriptListGet";
			ScriptListGetRequest scriptListGetRequest = new ScriptListGetRequest();

			//set up credentials
			scriptListGetRequest.auth.applicationId = "applicationId";
			scriptListGetRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			scriptListGetRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(scriptListGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ScriptListGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ScriptListGetResponse scriptListGetResponse = javascriptSerializer.Deserialize<ScriptListGetResponse>(jsonResponse);

			Console.WriteLine(scriptListGetResponse.responseCode);
			Console.WriteLine(scriptListGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ScriptListGetRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ScriptDefault {
			public long defaultHomePhoneScriptId { get; set;}
			public long defaultCellPhoneScriptId { get; set;}
			public long defaultEmailScriptId { get; set;}
			public long defaultTextScriptId { get; set;}
		}

		public class ScriptObject {
			public long id { get; set;}
			public long formLanguageId { get; set;}
			public string communicationLanguage { get; set;}
			public string title { get; set;}
			public string content { get; set;}
			public string source { get; set;}
			public string type { get; set;}
		}

		public class ScriptListObject {
			public ScriptDefault scriptDefault { get; set;}
			public List<ScriptObject> scriptObjects { get; set;}
		}

		public class ScriptListGetResponse : UpdoxResponse {
			public ScriptListObject scriptListObject { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ScriptListGet {

	public static void main(String[] args) {
		UpdoxCodeSample_ScriptListGet codeSample = new UpdoxCodeSample_ScriptListGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ScriptListGet";

		ScriptListGetRequest scriptListGetRequest = new ScriptListGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = scriptListGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		scriptListGetRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(scriptListGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ScriptListGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ScriptListGetResponse scriptListGetResponse = mapper.readValue(jsonResponse, ScriptListGetResponse.class);

		System.out.println(scriptListGetResponse.getResponseCode());
		System.out.println(scriptListGetResponse.getResponseMessage());
	}

	private class ScriptListGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class ScriptDefault {
		private Long defaultHomePhoneScriptId;
		private Long defaultCellPhoneScriptId;
		private Long defaultEmailScriptId;
		private Long defaultTextScriptId;


		public Long getDefaultHomePhoneScriptId() {
			return defaultHomePhoneScriptId;
		}

		public void setDefaultHomePhoneScriptId(Long defaultHomePhoneScriptId) {
			this.defaultHomePhoneScriptId = defaultHomePhoneScriptId;
		}

		public Long getDefaultCellPhoneScriptId() {
			return defaultCellPhoneScriptId;
		}

		public void setDefaultCellPhoneScriptId(Long defaultCellPhoneScriptId) {
			this.defaultCellPhoneScriptId = defaultCellPhoneScriptId;
		}

		public Long getDefaultEmailScriptId() {
			return defaultEmailScriptId;
		}

		public void setDefaultEmailScriptId(Long defaultEmailScriptId) {
			this.defaultEmailScriptId = defaultEmailScriptId;
		}

		public Long getDefaultTextScriptId() {
			return defaultTextScriptId;
		}

		public void setDefaultTextScriptId(Long defaultTextScriptId) {
			this.defaultTextScriptId = defaultTextScriptId;
		}
	}

	private static class ScriptObject {
		private long id;
		private Long formLanguageId;
		private String communicationLanguage;
		private String title;
		private String content;
		private String source;
		private String type;


		public long getId() {
			return id;
		}

		public void setId(long id) {
			this.id = id;
		}

		public Long getFormLanguageId() {
			return formLanguageId;
		}

		public void setFormLanguageId(Long formLanguageId) {
			this.formLanguageId = formLanguageId;
		}

		public String getCommunicationLanguage() {
			return communicationLanguage;
		}

		public void setCommunicationLanguage(String communicationLanguage) {
			this.communicationLanguage = communicationLanguage;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}

		public String getSource() {
			return source;
		}

		public void setSource(String source) {
			this.source = source;
		}

		public String getType() {
			return type;
		}

		public void setType(String type) {
			this.type = type;
		}
	}

	private static class ScriptListObject {
		private ScriptDefault scriptDefault;
		private List<ScriptObject> scriptObjects;


		public ScriptDefault getScriptDefault() {
			return scriptDefault;
		}

		public void setScriptDefault(ScriptDefault scriptDefault) {
			this.scriptDefault = scriptDefault;
		}

		public List<ScriptObject> getScriptObjects() {
			return scriptObjects;
		}

		public void setScriptObjects(List<ScriptObject> scriptObjects) {
			this.scriptObjects = scriptObjects;
		}
	}

	private static class ScriptListGetResponse extends UpdoxResponse {
		private ScriptListObject scriptListObject;


		public ScriptListObject getScriptListObject() {
			return scriptListObject;
		}

		public void setScriptListObject(ScriptListObject scriptListObject) {
			this.scriptListObject = scriptListObject;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4131`	`account does not exist`

RoiActions

CreateRoi /io/roi/CreateRoi

Create a Release of Information (ROI) request for the given updoxAccountId.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
updoxAccountId	String	The Updox Account Id the request is for. Min length 1 characters. Max length 60 characters. This is required.
vendorRequestId	String	The Vendor Request Id of the request. Min length 1 characters. Max length 60 characters. This is required.
requestorName	String	The name of the party submitting the request. Max length 75 characters.
dueDate	String	The request's due date, format is "yyyy-MM-DD". This is required.
paymentAmount	String	The payment amount for completing the request in USD, regex format is "^\d+\.\d\d$" (ex: "50.00" for $50.00). This is required.
patient		The patient the request is about. This is required.
name	String	The patient's full name. Min length 1 characters. Max length 100 characters. This is required.
dob	String	The patient's date of birth (dob), format "yyyy-MM-DD" (ex: "2001-01-01"). This is required.
sex	String	The patient's sex, optional. Must be one of the following values: m, f.
document		The document supporting the request. This is required.
name	String	The descriptive name of the document (e.g. Release Labs for John Doe). This is required.
fileName	String	The filename of the attachment with extension (e.g. test-results.pdf). This is required.
mimeType	String	The MIME type of the attachment, defaults to "application/pdf". This is required.
content	String	The Base64 URL encoded content document. This is required.

Try it! Toggle Notes/Code Samples

CreateRoi

Create a Release of Information (ROI) request for the given updoxAccountId.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Receiving a 4092 with "Try again, a concurrent request for the same vendorRequestId was processing" means that one should try the request again after a short delay.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_RoiCreateRoi {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_RoiCreateRoi codeSample = new UpdoxCodeSample_RoiCreateRoi();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "RoiCreateRoi";
			RoiCreateRoiRequest roiCreateRoiRequest = new RoiCreateRoiRequest();

			//set up credentials
			roiCreateRoiRequest.auth.applicationId = "applicationId";
			roiCreateRoiRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			roiCreateRoiRequest.updoxAccountId = "updoxAccountId";
			roiCreateRoiRequest.vendorRequestId = "vendorRequestId";
			roiCreateRoiRequest.requestorName = "requestorName";
			roiCreateRoiRequest.dueDate = "dueDate";
			roiCreateRoiRequest.paymentAmount = "paymentAmount";
			CreateRoiPatient patient = new CreateRoiPatient();
			patient.name = "name";
			patient.dob = "dob";
			patient.sex = "M";
			roiCreateRoiRequest.patient = patient;
			CreateRoiDocument document = new CreateRoiDocument();
			document.name = "name";
			document.fileName = "fileName";
			document.mimeType = "mimeType";
			document.content = "content";
			roiCreateRoiRequest.document = document;

			//create the request
			string json = Utilities.buildRequestJson(roiCreateRoiRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "roi/CreateRoi", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			RoiCreateRoiResponse roiCreateRoiResponse = javascriptSerializer.Deserialize<RoiCreateRoiResponse>(jsonResponse);

			Console.WriteLine(roiCreateRoiResponse.responseCode);
			Console.WriteLine(roiCreateRoiResponse.responseMessage);

			Environment.Exit (0);
		}


		public class CreateRoiPatient {
			public string name { get; set;}
			public string dob { get; set;}
			public string sex { get; set;}
		}

		public class CreateRoiDocument {
			public string name { get; set;}
			public string fileName { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class RoiCreateRoiRequest : UpdoxRequest {
			public string updoxAccountId { get; set;}
			public string vendorRequestId { get; set;}
			public string requestorName { get; set;}
			public string dueDate { get; set;}
			public string paymentAmount { get; set;}
			public CreateRoiPatient patient { get; set;}
			public CreateRoiDocument document { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RoiCreateRoiResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_RoiCreateRoi {

	public static void main(String[] args) {
		UpdoxCodeSample_RoiCreateRoi codeSample = new UpdoxCodeSample_RoiCreateRoi();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "RoiCreateRoi";

		RoiCreateRoiRequest roiCreateRoiRequest = new RoiCreateRoiRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = roiCreateRoiRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		roiCreateRoiRequest.setUpdoxAccountId("updoxAccountId");
		roiCreateRoiRequest.setVendorRequestId("vendorRequestId");
		roiCreateRoiRequest.setRequestorName("requestorName");
		roiCreateRoiRequest.setDueDate("dueDate");
		roiCreateRoiRequest.setPaymentAmount("paymentAmount");
		CreateRoiPatient patient = new CreateRoiPatient();
		patient.setName("name");
		patient.setDob("dob");
		patient.setSex("M");
		roiCreateRoiRequest.setPatient(patient);
		CreateRoiDocument document = new CreateRoiDocument();
		document.setName("name");
		document.setFileName("fileName");
		document.setMimeType("mimeType");
		document.setContent("content");
		roiCreateRoiRequest.setDocument(document);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(roiCreateRoiRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'roi/CreateRoi', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		RoiCreateRoiResponse roiCreateRoiResponse = mapper.readValue(jsonResponse, RoiCreateRoiResponse.class);

		System.out.println(roiCreateRoiResponse.getResponseCode());
		System.out.println(roiCreateRoiResponse.getResponseMessage());
	}

	private static class CreateRoiPatient {
		private String name;
		private String dob;
		private String sex;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getDob() {
			return dob;
		}

		public void setDob(String dob) {
			this.dob = dob;
		}

		public String getSex() {
			return sex;
		}

		public void setSex(String sex) {
			this.sex = sex;
		}
	}

	private static class CreateRoiDocument {
		private String name;
		private String fileName;
		private String mimeType;
		private String content;


		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class RoiCreateRoiRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String updoxAccountId;
    	private String vendorRequestId;
    	private String requestorName;
    	private String dueDate;
    	private String paymentAmount;
    	private CreateRoiPatient patient;
    	private CreateRoiDocument document;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUpdoxAccountId() {
			return updoxAccountId;
		}

		public void setUpdoxAccountId(String updoxAccountId) {
			this.updoxAccountId = updoxAccountId;
		}

		public String getVendorRequestId() {
			return vendorRequestId;
		}

		public void setVendorRequestId(String vendorRequestId) {
			this.vendorRequestId = vendorRequestId;
		}

		public String getRequestorName() {
			return requestorName;
		}

		public void setRequestorName(String requestorName) {
			this.requestorName = requestorName;
		}

		public String getDueDate() {
			return dueDate;
		}

		public void setDueDate(String dueDate) {
			this.dueDate = dueDate;
		}

		public String getPaymentAmount() {
			return paymentAmount;
		}

		public void setPaymentAmount(String paymentAmount) {
			this.paymentAmount = paymentAmount;
		}

		public CreateRoiPatient getPatient() {
			return patient;
		}

		public void setPatient(CreateRoiPatient patient) {
			this.patient = patient;
		}

		public CreateRoiDocument getDocument() {
			return document;
		}

		public void setDocument(CreateRoiDocument document) {
			this.document = document;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class RoiCreateRoiResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4092`	`record currently locked`
`4099`	`record already exists`
`4131`	`Invalid updoxAccountId`

UpdateRoi /io/roi/UpdateRoi

Update a Release of Information (ROI) request's status for the given vendorRequestId.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
vendorRequestId	String	The Vendor Request Id of the request. Min length 1 characters. Max length 60 characters. This is required.
status	String	The Status of the request. Must be one of the following values: CANCELLED, COMPLETED. This is required.
reason	String	The Reason for updating a request's status (e.g. "Cancelled by requestor"). Please supply an explanation when updating the ROI request status to CANCELLED. Max length 255 characters.

Try it! Toggle Notes/Code Samples

UpdateRoi

Update a Release of Information (ROI) request's status for the given vendorRequestId.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_RoiUpdateRoi {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_RoiUpdateRoi codeSample = new UpdoxCodeSample_RoiUpdateRoi();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "RoiUpdateRoi";
			RoiUpdateRoiRequest roiUpdateRoiRequest = new RoiUpdateRoiRequest();

			//set up credentials
			roiUpdateRoiRequest.auth.applicationId = "applicationId";
			roiUpdateRoiRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			roiUpdateRoiRequest.vendorRequestId = "vendorRequestId";
			roiUpdateRoiRequest.status = "status";
			roiUpdateRoiRequest.reason = "reason";

			//create the request
			string json = Utilities.buildRequestJson(roiUpdateRoiRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "roi/UpdateRoi", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			RoiUpdateRoiResponse roiUpdateRoiResponse = javascriptSerializer.Deserialize<RoiUpdateRoiResponse>(jsonResponse);

			Console.WriteLine(roiUpdateRoiResponse.responseCode);
			Console.WriteLine(roiUpdateRoiResponse.responseMessage);

			Environment.Exit (0);
		}


		public class RoiUpdateRoiRequest : UpdoxRequest {
			public string vendorRequestId { get; set;}
			public string status { get; set;}
			public string reason { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RoiUpdateRoiResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_RoiUpdateRoi {

	public static void main(String[] args) {
		UpdoxCodeSample_RoiUpdateRoi codeSample = new UpdoxCodeSample_RoiUpdateRoi();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "RoiUpdateRoi";

		RoiUpdateRoiRequest roiUpdateRoiRequest = new RoiUpdateRoiRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = roiUpdateRoiRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		roiUpdateRoiRequest.setVendorRequestId("vendorRequestId");
		roiUpdateRoiRequest.setStatus("status");
		roiUpdateRoiRequest.setReason("reason");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(roiUpdateRoiRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'roi/UpdateRoi', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		RoiUpdateRoiResponse roiUpdateRoiResponse = mapper.readValue(jsonResponse, RoiUpdateRoiResponse.class);

		System.out.println(roiUpdateRoiResponse.getResponseCode());
		System.out.println(roiUpdateRoiResponse.getResponseMessage());
	}

	private class RoiUpdateRoiRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String vendorRequestId;
    	private String status;
    	private String reason;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getVendorRequestId() {
			return vendorRequestId;
		}

		public void setVendorRequestId(String vendorRequestId) {
			this.vendorRequestId = vendorRequestId;
		}

		public String getStatus() {
			return status;
		}

		public void setStatus(String status) {
			this.status = status;
		}

		public String getReason() {
			return reason;
		}

		public void setReason(String reason) {
			this.reason = reason;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class RoiUpdateRoiResponse extends UpdoxResponse {

	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

SecureConversationActions

CreateConversation /io/secure-conversation/CreateConversation

Used to initiate a new conversation with a specified recipient. The conversation must be created prior to sending any messages. Creating a conversation does not notify the recipient. The sending of a new message to the conversation will trigger a notification to the recipient that a message is available.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
title	String	The title of the conversation that is visible to the recipient. Min length 1 characters. Max length 100 characters. This is required.
recipient		Who this conversation is with. This is required.
id	String	Partner ID of the recipient (One of: ContactSync or PatientSync `id` field). This is required.
category	String	One of: 'patient' or 'contact'. This is required.
settings		Settings for the created conversation.
allowReplies	Boolean	Are replies from the recipient allowed for this conversation? (default: true).

Try it! Toggle Notes/Code Samples

CreateConversation

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationCreateConversation {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationCreateConversation codeSample = new UpdoxCodeSample_Secure-conversationCreateConversation();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationCreateConversation";
			Secure-conversationCreateConversationRequest secure-conversationCreateConversationRequest = new Secure-conversationCreateConversationRequest();

			//set up credentials
			secure-conversationCreateConversationRequest.auth.applicationId = "applicationId";
			secure-conversationCreateConversationRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationCreateConversationRequest.auth.accountId = "accountId";

			//set up request specific parameters
			secure-conversationCreateConversationRequest.title = "title";
			UpdoxRecipient recipient = new UpdoxRecipient();
			recipient.id = "id";
			recipient.category = "category";
			secure-conversationCreateConversationRequest.recipient = recipient;
			CreateConversationSettings settings = new CreateConversationSettings();
			settings.allowReplies = true;
			secure-conversationCreateConversationRequest.settings = settings;

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationCreateConversationRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/CreateConversation", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationCreateConversationResponse secure-conversationCreateConversationResponse = javascriptSerializer.Deserialize<Secure-conversationCreateConversationResponse>(jsonResponse);

			Console.WriteLine(secure-conversationCreateConversationResponse.responseCode);
			Console.WriteLine(secure-conversationCreateConversationResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UpdoxRecipient {
			public string id { get; set;}
			public string category { get; set;}
		}

		public class CreateConversationSettings {
			public bool allowReplies { get; set;}
		}

		public class Secure-conversationCreateConversationRequest : UpdoxRequest {
			public string title { get; set;}
			public UpdoxRecipient recipient { get; set;}
			public CreateConversationSettings settings { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Secure-conversationCreateConversationResponse : UpdoxResponse {
			public string id { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_Secure-conversationCreateConversation {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationCreateConversation codeSample = new UpdoxCodeSample_Secure-conversationCreateConversation();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationCreateConversation";

		Secure-conversationCreateConversationRequest secure-conversationCreateConversationRequest = new Secure-conversationCreateConversationRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationCreateConversationRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		secure-conversationCreateConversationRequest.setTitle("title");
		UpdoxRecipient recipient = new UpdoxRecipient();
		recipient.setId("id");
		recipient.setCategory("category");
		secure-conversationCreateConversationRequest.setRecipient(recipient);
		CreateConversationSettings settings = new CreateConversationSettings();
		settings.setAllowReplies(true);
		secure-conversationCreateConversationRequest.setSettings(settings);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationCreateConversationRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/CreateConversation', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationCreateConversationResponse secure-conversationCreateConversationResponse = mapper.readValue(jsonResponse, Secure-conversationCreateConversationResponse.class);

		System.out.println(secure-conversationCreateConversationResponse.getResponseCode());
		System.out.println(secure-conversationCreateConversationResponse.getResponseMessage());
	}

	private static class UpdoxRecipient {
		private String id;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private static class CreateConversationSettings {
		private boolean allowReplies;


		public boolean isAllowReplies() {
			return allowReplies;
		}

		public void setAllowReplies(boolean allowReplies) {
			this.allowReplies = allowReplies;
		}
	}

	private class Secure-conversationCreateConversationRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String title;
    	private UpdoxRecipient recipient;
    	private CreateConversationSettings settings;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getTitle() {
			return title;
		}

		public void setTitle(String title) {
			this.title = title;
		}

		public UpdoxRecipient getRecipient() {
			return recipient;
		}

		public void setRecipient(UpdoxRecipient recipient) {
			this.recipient = recipient;
		}

		public CreateConversationSettings getSettings() {
			return settings;
		}

		public void setSettings(CreateConversationSettings settings) {
			this.settings = settings;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Secure-conversationCreateConversationResponse extends UpdoxResponse {
		private String id;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4731`	`patient account does not exist`
`4331`	`contact does not exist`
`4015`	`Unauthorized - API not enabled for the request's access rights`

SendMessage /io/secure-conversation/SendMessage

Send a secure conversation message and/or attachment(s) to a recipient that is associated with a conversation.

Each attachment is saved for display to the recipient in the order in which they were sent. Attachments that are saved successfully are noted in the returned response. Attachments that failed to save successfully are noted by their absence in the returned response.
If one wants to affirm attachment order is maintained regardless of failures, then each attachment should be sent in separate API calls with error handling in between.
Note that at least a message body or single attachment is required in order to make a request.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
conversationId	String		The unique identifier of the conversation the message is intended for. This is required.
body	String		The message body intended to be sent to the recipient of the conversation. Max length 4000 characters.
attachments	List	add remove	Any attachments to send to the recipient of the conversation. Note: This field is required if the message `body` is not included.

filename	String		The filename of the attachment with extension (e.g. test-results.pdf). Min length 1 characters. Max length 250 characters. This is required.
mimeType	String		The MIME type of the attachment (e.g. application/pdf). Min length 1 characters. Max length 100 characters. This is required.
content	String		Base64 URL encoded content with padding. This is required.

Try it! Toggle Notes/Code Samples

SendMessage

Send a secure conversation message and/or attachment(s) to a recipient that is associated with a conversation.

Each attachment is saved for display to the recipient in the order in which they were sent. Attachments that are saved successfully are noted in the returned response. Attachments that failed to save successfully are noted by their absence in the returned response.
If one wants to affirm attachment order is maintained regardless of failures, then each attachment should be sent in separate API calls with error handling in between.
Note that at least a message body or single attachment is required in order to make a request.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationSendMessage {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationSendMessage codeSample = new UpdoxCodeSample_Secure-conversationSendMessage();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationSendMessage";
			Secure-conversationSendMessageRequest secure-conversationSendMessageRequest = new Secure-conversationSendMessageRequest();

			//set up credentials
			secure-conversationSendMessageRequest.auth.applicationId = "applicationId";
			secure-conversationSendMessageRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationSendMessageRequest.auth.accountId = "accountId";
			secure-conversationSendMessageRequest.auth.userId = "userId";

			//set up request specific parameters
			secure-conversationSendMessageRequest.conversationId = "conversationId";
			secure-conversationSendMessageRequest.body = "body";
			List<MessageAttachmentRequest> attachments = new List<MessageAttachmentRequest>();
			MessageAttachmentRequest messageAttachmentRequest = new MessageAttachmentRequest();
			messageAttachmentRequest.filename = "filename";
			messageAttachmentRequest.mimeType = "mimeType";
			messageAttachmentRequest.content = "content";
			attachments.Add(messageAttachmentRequest);
			secure-conversationSendMessageRequest.attachments = attachments;

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationSendMessageRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/SendMessage", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationSendMessageResponse secure-conversationSendMessageResponse = javascriptSerializer.Deserialize<Secure-conversationSendMessageResponse>(jsonResponse);

			Console.WriteLine(secure-conversationSendMessageResponse.responseCode);
			Console.WriteLine(secure-conversationSendMessageResponse.responseMessage);

			Environment.Exit (0);
		}


		public class MessageAttachmentRequest {
			public string filename { get; set;}
			public string mimeType { get; set;}
			public string content { get; set;}
		}

		public class Secure-conversationSendMessageRequest : UpdoxRequest {
			public string conversationId { get; set;}
			public string body { get; set;}
			public List<MessageAttachmentRequest> attachments { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageAttachmentNoContent {
			public string id { get; set;}
			public string filename { get; set;}
		}

		public class Secure-conversationSendMessageResponse : UpdoxResponse {
			public string id { get; set;}
			public List<MessageAttachmentNoContent> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_Secure-conversationSendMessage {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationSendMessage codeSample = new UpdoxCodeSample_Secure-conversationSendMessage();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationSendMessage";

		Secure-conversationSendMessageRequest secure-conversationSendMessageRequest = new Secure-conversationSendMessageRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationSendMessageRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		secure-conversationSendMessageRequest.setConversationId("conversationId");
		secure-conversationSendMessageRequest.setBody("body");
	List<MessageAttachmentRequest> attachments = new ArrayList<>();
		MessageAttachmentRequest messageAttachmentRequest = new MessageAttachmentRequest();
		messageAttachmentRequest.setFilename("filename");
		messageAttachmentRequest.setMimeType("mimeType");
		messageAttachmentRequest.setContent("content");
		attachments.add(messageAttachmentRequest);
		secure-conversationSendMessageRequest.setAttachments(attachments);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationSendMessageRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/SendMessage', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationSendMessageResponse secure-conversationSendMessageResponse = mapper.readValue(jsonResponse, Secure-conversationSendMessageResponse.class);

		System.out.println(secure-conversationSendMessageResponse.getResponseCode());
		System.out.println(secure-conversationSendMessageResponse.getResponseMessage());
	}

	private static class MessageAttachmentRequest {
		private String filename;
		private String mimeType;
		private String content;


		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}
	}

	private class Secure-conversationSendMessageRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String conversationId;
    	private String body;
    	private List<MessageAttachmentRequest> attachments;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getConversationId() {
			return conversationId;
		}

		public void setConversationId(String conversationId) {
			this.conversationId = conversationId;
		}

		public String getBody() {
			return body;
		}

		public void setBody(String body) {
			this.body = body;
		}

		public List<MessageAttachmentRequest> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<MessageAttachmentRequest> attachments) {
			this.attachments = attachments;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageAttachmentNoContent {
		private String id;
		private String filename;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}
	}

	private static class Secure-conversationSendMessageResponse extends UpdoxResponse {
		private String id;
		private List<MessageAttachmentNoContent> attachments;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public List<MessageAttachmentNoContent> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<MessageAttachmentNoContent> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6210`	`at least one value must be provided`
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveMessage /io/secure-conversation/RetrieveMessage

Retrieve a specific conversation message and associated attachment metadata.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
conversationId	String		The unique identifier of the conversation the message is associated with. This is required.
messageId	String		The unique identifier for the message associated with the supplied conversation identifier. This is required.

Try it! Toggle Notes/Code Samples

RetrieveMessage

Retrieve a specific conversation message and associated attachment metadata.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationRetrieveMessage {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationRetrieveMessage codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessage();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationRetrieveMessage";
			Secure-conversationRetrieveMessageRequest secure-conversationRetrieveMessageRequest = new Secure-conversationRetrieveMessageRequest();

			//set up credentials
			secure-conversationRetrieveMessageRequest.auth.applicationId = "applicationId";
			secure-conversationRetrieveMessageRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationRetrieveMessageRequest.auth.accountId = "accountId";
			secure-conversationRetrieveMessageRequest.auth.userId = "userId";

			//set up request specific parameters
			secure-conversationRetrieveMessageRequest.conversationId = "conversationId";
			secure-conversationRetrieveMessageRequest.messageId = "messageId";

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationRetrieveMessageRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/RetrieveMessage", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationRetrieveMessageResponse secure-conversationRetrieveMessageResponse = javascriptSerializer.Deserialize<Secure-conversationRetrieveMessageResponse>(jsonResponse);

			Console.WriteLine(secure-conversationRetrieveMessageResponse.responseCode);
			Console.WriteLine(secure-conversationRetrieveMessageResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Secure-conversationRetrieveMessageRequest : UpdoxRequest {
			public string conversationId { get; set;}
			public string messageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageAttachmentNoContent {
			public string id { get; set;}
			public string filename { get; set;}
		}

		public class ConversationMessageDetail {
			public string id { get; set;}
			public string body { get; set;}
			public string dttmCreate { get; set;}
			public List<MessageAttachmentNoContent> attachments { get; set;}
		}

		public class Secure-conversationRetrieveMessageResponse : UpdoxResponse {
			public ConversationMessageDetail message { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_Secure-conversationRetrieveMessage {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationRetrieveMessage codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessage();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationRetrieveMessage";

		Secure-conversationRetrieveMessageRequest secure-conversationRetrieveMessageRequest = new Secure-conversationRetrieveMessageRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationRetrieveMessageRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		secure-conversationRetrieveMessageRequest.setConversationId("conversationId");
		secure-conversationRetrieveMessageRequest.setMessageId("messageId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationRetrieveMessageRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/RetrieveMessage', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationRetrieveMessageResponse secure-conversationRetrieveMessageResponse = mapper.readValue(jsonResponse, Secure-conversationRetrieveMessageResponse.class);

		System.out.println(secure-conversationRetrieveMessageResponse.getResponseCode());
		System.out.println(secure-conversationRetrieveMessageResponse.getResponseMessage());
	}

	private class Secure-conversationRetrieveMessageRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String conversationId;
    	private String messageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getConversationId() {
			return conversationId;
		}

		public void setConversationId(String conversationId) {
			this.conversationId = conversationId;
		}

		public String getMessageId() {
			return messageId;
		}

		public void setMessageId(String messageId) {
			this.messageId = messageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageAttachmentNoContent {
		private String id;
		private String filename;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}
	}

	private static class ConversationMessageDetail {
		private String id;
		private String body;
		private String dttmCreate;
		private List<MessageAttachmentNoContent> attachments;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getBody() {
			return body;
		}

		public void setBody(String body) {
			this.body = body;
		}

		public String getDttmCreate() {
			return dttmCreate;
		}

		public void setDttmCreate(String dttmCreate) {
			this.dttmCreate = dttmCreate;
		}

		public List<MessageAttachmentNoContent> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<MessageAttachmentNoContent> attachments) {
			this.attachments = attachments;
		}
	}

	private static class Secure-conversationRetrieveMessageResponse extends UpdoxResponse {
		private ConversationMessageDetail message;


		public ConversationMessageDetail getMessage() {
			return message;
		}

		public void setMessage(ConversationMessageDetail message) {
			this.message = message;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveMessageAttachment /io/secure-conversation/RetrieveMessageAttachment

Retrieve the actual content and metadata of an attachment. The returned content is Base64 URL encoded with padding.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
conversationId	String		The unique identifier of the conversation the attachment is associated with. This is required.
attachmentId	String		The unique identifier for the attachment associated with the supplied conversation identifier. This is required.

Try it! Toggle Notes/Code Samples

RetrieveMessageAttachment

Retrieve the actual content and metadata of an attachment. The returned content is Base64 URL encoded with padding.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationRetrieveMessageAttachment";
			Secure-conversationRetrieveMessageAttachmentRequest secure-conversationRetrieveMessageAttachmentRequest = new Secure-conversationRetrieveMessageAttachmentRequest();

			//set up credentials
			secure-conversationRetrieveMessageAttachmentRequest.auth.applicationId = "applicationId";
			secure-conversationRetrieveMessageAttachmentRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationRetrieveMessageAttachmentRequest.auth.accountId = "accountId";
			secure-conversationRetrieveMessageAttachmentRequest.auth.userId = "userId";

			//set up request specific parameters
			secure-conversationRetrieveMessageAttachmentRequest.conversationId = "conversationId";
			secure-conversationRetrieveMessageAttachmentRequest.attachmentId = "attachmentId";

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationRetrieveMessageAttachmentRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/RetrieveMessageAttachment", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationRetrieveMessageAttachmentResponse secure-conversationRetrieveMessageAttachmentResponse = javascriptSerializer.Deserialize<Secure-conversationRetrieveMessageAttachmentResponse>(jsonResponse);

			Console.WriteLine(secure-conversationRetrieveMessageAttachmentResponse.responseCode);
			Console.WriteLine(secure-conversationRetrieveMessageAttachmentResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Secure-conversationRetrieveMessageAttachmentRequest : UpdoxRequest {
			public string conversationId { get; set;}
			public string attachmentId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Secure-conversationRetrieveMessageAttachmentResponse : UpdoxResponse {
			public string id { get; set;}
			public string content { get; set;}
			public string filename { get; set;}
			public string mimeType { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessageAttachment();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationRetrieveMessageAttachment";

		Secure-conversationRetrieveMessageAttachmentRequest secure-conversationRetrieveMessageAttachmentRequest = new Secure-conversationRetrieveMessageAttachmentRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationRetrieveMessageAttachmentRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		secure-conversationRetrieveMessageAttachmentRequest.setConversationId("conversationId");
		secure-conversationRetrieveMessageAttachmentRequest.setAttachmentId("attachmentId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationRetrieveMessageAttachmentRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/RetrieveMessageAttachment', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationRetrieveMessageAttachmentResponse secure-conversationRetrieveMessageAttachmentResponse = mapper.readValue(jsonResponse, Secure-conversationRetrieveMessageAttachmentResponse.class);

		System.out.println(secure-conversationRetrieveMessageAttachmentResponse.getResponseCode());
		System.out.println(secure-conversationRetrieveMessageAttachmentResponse.getResponseMessage());
	}

	private class Secure-conversationRetrieveMessageAttachmentRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String conversationId;
    	private String attachmentId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getConversationId() {
			return conversationId;
		}

		public void setConversationId(String conversationId) {
			this.conversationId = conversationId;
		}

		public String getAttachmentId() {
			return attachmentId;
		}

		public void setAttachmentId(String attachmentId) {
			this.attachmentId = attachmentId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class Secure-conversationRetrieveMessageAttachmentResponse extends UpdoxResponse {
		private String id;
		private String content;
		private String filename;
		private String mimeType;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}

		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveMessagesSince /io/secure-conversation/RetrieveMessagesSince

Retrieve conversation messages and attachments.

If sinceLastMessageId is populated then only messages after that message will be included. The last message value itself is always excluded from the results.
If sinceLastMessageId is excluded, then the entire conversation message history will be evaluated.
If repliesOnly is set to true, then only messages sent from the recipient will be evaluated.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
conversationId	String	The unique identifier of the conversation the message is associated with. This is required.
sinceLastMessageId	String	The unique identifier for the last known conversation message. If not provided then the entire conversation history will be evaluated.
repliesOnly	Boolean	Are replies from the recipient the only messages that should be returned? (default: true).

Try it! Toggle Notes/Code Samples

RetrieveMessagesSince

Retrieve conversation messages and attachments.

If sinceLastMessageId is populated then only messages after that message will be included. The last message value itself is always excluded from the results.
If sinceLastMessageId is excluded, then the entire conversation message history will be evaluated.
If repliesOnly is set to true, then only messages sent from the recipient will be evaluated.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationRetrieveMessagesSince {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationRetrieveMessagesSince codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessagesSince();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationRetrieveMessagesSince";
			Secure-conversationRetrieveMessagesSinceRequest secure-conversationRetrieveMessagesSinceRequest = new Secure-conversationRetrieveMessagesSinceRequest();

			//set up credentials
			secure-conversationRetrieveMessagesSinceRequest.auth.applicationId = "applicationId";
			secure-conversationRetrieveMessagesSinceRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationRetrieveMessagesSinceRequest.auth.accountId = "accountId";
			secure-conversationRetrieveMessagesSinceRequest.auth.userId = "userId";

			//set up request specific parameters
			secure-conversationRetrieveMessagesSinceRequest.conversationId = "conversationId";
			secure-conversationRetrieveMessagesSinceRequest.sinceLastMessageId = "sinceLastMessageId";
			secure-conversationRetrieveMessagesSinceRequest.repliesOnly = true;

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationRetrieveMessagesSinceRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/RetrieveMessagesSince", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationRetrieveMessagesSinceResponse secure-conversationRetrieveMessagesSinceResponse = javascriptSerializer.Deserialize<Secure-conversationRetrieveMessagesSinceResponse>(jsonResponse);

			Console.WriteLine(secure-conversationRetrieveMessagesSinceResponse.responseCode);
			Console.WriteLine(secure-conversationRetrieveMessagesSinceResponse.responseMessage);

			Environment.Exit (0);
		}


		public class Secure-conversationRetrieveMessagesSinceRequest : UpdoxRequest {
			public string conversationId { get; set;}
			public string sinceLastMessageId { get; set;}
			public bool repliesOnly { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MessageAttachmentNoContent {
			public string id { get; set;}
			public string filename { get; set;}
		}

		public class ConversationMessageDetail {
			public string id { get; set;}
			public string body { get; set;}
			public string dttmCreate { get; set;}
			public List<MessageAttachmentNoContent> attachments { get; set;}
		}

		public class Secure-conversationRetrieveMessagesSinceResponse : UpdoxResponse {
			public List<ConversationMessageDetail> messages { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_Secure-conversationRetrieveMessagesSince {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationRetrieveMessagesSince codeSample = new UpdoxCodeSample_Secure-conversationRetrieveMessagesSince();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationRetrieveMessagesSince";

		Secure-conversationRetrieveMessagesSinceRequest secure-conversationRetrieveMessagesSinceRequest = new Secure-conversationRetrieveMessagesSinceRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationRetrieveMessagesSinceRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		secure-conversationRetrieveMessagesSinceRequest.setConversationId("conversationId");
		secure-conversationRetrieveMessagesSinceRequest.setSinceLastMessageId("sinceLastMessageId");
		secure-conversationRetrieveMessagesSinceRequest.setRepliesOnly(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationRetrieveMessagesSinceRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/RetrieveMessagesSince', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationRetrieveMessagesSinceResponse secure-conversationRetrieveMessagesSinceResponse = mapper.readValue(jsonResponse, Secure-conversationRetrieveMessagesSinceResponse.class);

		System.out.println(secure-conversationRetrieveMessagesSinceResponse.getResponseCode());
		System.out.println(secure-conversationRetrieveMessagesSinceResponse.getResponseMessage());
	}

	private class Secure-conversationRetrieveMessagesSinceRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String conversationId;
    	private String sinceLastMessageId;
    	private boolean repliesOnly;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getConversationId() {
			return conversationId;
		}

		public void setConversationId(String conversationId) {
			this.conversationId = conversationId;
		}

		public String getSinceLastMessageId() {
			return sinceLastMessageId;
		}

		public void setSinceLastMessageId(String sinceLastMessageId) {
			this.sinceLastMessageId = sinceLastMessageId;
		}

		public boolean isRepliesOnly() {
			return repliesOnly;
		}

		public void setRepliesOnly(boolean repliesOnly) {
			this.repliesOnly = repliesOnly;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class MessageAttachmentNoContent {
		private String id;
		private String filename;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}
	}

	private static class ConversationMessageDetail {
		private String id;
		private String body;
		private String dttmCreate;
		private List<MessageAttachmentNoContent> attachments;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getBody() {
			return body;
		}

		public void setBody(String body) {
			this.body = body;
		}

		public String getDttmCreate() {
			return dttmCreate;
		}

		public void setDttmCreate(String dttmCreate) {
			this.dttmCreate = dttmCreate;
		}

		public List<MessageAttachmentNoContent> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<MessageAttachmentNoContent> attachments) {
			this.attachments = attachments;
		}
	}

	private static class Secure-conversationRetrieveMessagesSinceResponse extends UpdoxResponse {
		private List<ConversationMessageDetail> messages;


		public List<ConversationMessageDetail> getMessages() {
			return messages;
		}

		public void setMessages(List<ConversationMessageDetail> messages) {
			this.messages = messages;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4015`	`Unauthorized - API not enabled for the request's access rights`

SetRecipientInviteType /io/secure-conversation/SetRecipientInviteType

A partner can specify a notification type for a Secure Conversation recipient and it will be used for future notifications when a new secure message is delivered.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
recipient			Who this conversation is with. This is required.
id	String		Partner ID of the recipient (One of: ContactSync or PatientSync `id` field). This is required.
category	String		One of: 'patient' or 'contact'. This is required.
notificationMethods	List	add remove	Which method(s) of notification(s) the provider has selected. Valid methods are: SMS, EMAIL. This is required.

	String

Try it! Toggle Notes/Code Samples

SetRecipientInviteType

A partner can specify a notification type for a Secure Conversation recipient and it will be used for future notifications when a new secure message is delivered.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_Secure-conversationSetRecipientInviteType {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_Secure-conversationSetRecipientInviteType codeSample = new UpdoxCodeSample_Secure-conversationSetRecipientInviteType();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "Secure-conversationSetRecipientInviteType";
			Secure-conversationSetRecipientInviteTypeRequest secure-conversationSetRecipientInviteTypeRequest = new Secure-conversationSetRecipientInviteTypeRequest();

			//set up credentials
			secure-conversationSetRecipientInviteTypeRequest.auth.applicationId = "applicationId";
			secure-conversationSetRecipientInviteTypeRequest.auth.applicationPassword = "applicationPassword";
			secure-conversationSetRecipientInviteTypeRequest.auth.accountId = "accountId";

			//set up request specific parameters
			UpdoxRecipient recipient = new UpdoxRecipient();
			recipient.id = "id";
			recipient.category = "category";
			secure-conversationSetRecipientInviteTypeRequest.recipient = recipient;
			List<string> notificationMethods = new List<string>();
			string notificationMethodsString = "notificationMethods";
			notificationMethods.Add(notificationMethodsString);
			secure-conversationSetRecipientInviteTypeRequest.notificationMethods = notificationMethods;

			//create the request
			string json = Utilities.buildRequestJson(secure-conversationSetRecipientInviteTypeRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "secure-conversation/SetRecipientInviteType", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			Secure-conversationSetRecipientInviteTypeResponse secure-conversationSetRecipientInviteTypeResponse = javascriptSerializer.Deserialize<Secure-conversationSetRecipientInviteTypeResponse>(jsonResponse);

			Console.WriteLine(secure-conversationSetRecipientInviteTypeResponse.responseCode);
			Console.WriteLine(secure-conversationSetRecipientInviteTypeResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UpdoxRecipient {
			public string id { get; set;}
			public string category { get; set;}
		}

		public class Secure-conversationSetRecipientInviteTypeRequest : UpdoxRequest {
			public UpdoxRecipient recipient { get; set;}
			public List<string> notificationMethods { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class Secure-conversationSetRecipientInviteTypeResponse : UpdoxResponse {
			public List<string> notificationMethods { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_Secure-conversationSetRecipientInviteType {

	public static void main(String[] args) {
		UpdoxCodeSample_Secure-conversationSetRecipientInviteType codeSample = new UpdoxCodeSample_Secure-conversationSetRecipientInviteType();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "Secure-conversationSetRecipientInviteType";

		Secure-conversationSetRecipientInviteTypeRequest secure-conversationSetRecipientInviteTypeRequest = new Secure-conversationSetRecipientInviteTypeRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = secure-conversationSetRecipientInviteTypeRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		UpdoxRecipient recipient = new UpdoxRecipient();
		recipient.setId("id");
		recipient.setCategory("category");
		secure-conversationSetRecipientInviteTypeRequest.setRecipient(recipient);
	List<String> notificationMethods = new ArrayList<>();
		String notificationMethodsString = "notificationMethods";
		notificationMethods.add(notificationMethodsString);
		secure-conversationSetRecipientInviteTypeRequest.setNotificationMethods(notificationMethods);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(secure-conversationSetRecipientInviteTypeRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'secure-conversation/SetRecipientInviteType', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		Secure-conversationSetRecipientInviteTypeResponse secure-conversationSetRecipientInviteTypeResponse = mapper.readValue(jsonResponse, Secure-conversationSetRecipientInviteTypeResponse.class);

		System.out.println(secure-conversationSetRecipientInviteTypeResponse.getResponseCode());
		System.out.println(secure-conversationSetRecipientInviteTypeResponse.getResponseMessage());
	}

	private static class UpdoxRecipient {
		private String id;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private class Secure-conversationSetRecipientInviteTypeRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private UpdoxRecipient recipient;
    	private List<String> notificationMethods;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public UpdoxRecipient getRecipient() {
			return recipient;
		}

		public void setRecipient(UpdoxRecipient recipient) {
			this.recipient = recipient;
		}

		public List<String> getNotificationMethods() {
			return notificationMethods;
		}

		public void setNotificationMethods(List<String> notificationMethods) {
			this.notificationMethods = notificationMethods;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class Secure-conversationSetRecipientInviteTypeResponse extends UpdoxResponse {
		private List<String> notificationMethods;


		public List<String> getNotificationMethods() {
			return notificationMethods;
		}

		public void setNotificationMethods(List<String> notificationMethods) {
			this.notificationMethods = notificationMethods;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`6213`	`record does not exist for ID`
`4332`	`contact is missing required field`
`4731`	`patient is missing required field`
`4015`	`Unauthorized - API not enabled for the request's access rights`

SmsActions

SmsSend /io/SmsSend

Sends an SMS that can be viewed as a thread in Updox Inbox.

Individual SMS number verification is required for each account as well as each location and queue before SMS messages can be sent. The initial call to /SmsSend for new accounts, locations, or queues will initiate the submission process for SMS number verification.

Please refer to Partner: SMS Phone Numbers | Updox Knowledge Base for more information on the verification process.

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
toNumber	String	The mobile phone number to receive the message. Max length 255 characters. This is required.
content	String	The content of the SMS. Please note that accounts using the consent footer will actually be limited to a maximum of 597 characters as each message will include the following footer (which equates to 73 characters): "To stop receiving these messages, reply STOP. Msg&Data rates may apply.". Max length 670 characters. This is required.
locationId	String	The unique ID of your location that has been sync'd with Updox. If you do not sync locations with Updox, ignore this field. At most of one of locationId and queueId can be specified.
queueId	String	The unique ID of your queue to send SMS from. If you do not have SMS Queues enabled within Updox, ignore this field. Call DocumentQueueIDList for ids to use for queueId. At most one of locationId and queueId can be specified.

Try it! Toggle Notes/Code Samples

SmsSend

Sends an SMS that can be viewed as a thread in Updox Inbox.

Please refer to Partner: SMS Phone Numbers | Updox Knowledge Base for more information on the verification process.

Note: Shortened URLs are not advised and can result in the SMS number being blocked by carriers.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_SmsSend {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_SmsSend codeSample = new UpdoxCodeSample_SmsSend();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "SmsSend";
			SmsSendRequest smsSendRequest = new SmsSendRequest();

			//set up credentials
			smsSendRequest.auth.applicationId = "applicationId";
			smsSendRequest.auth.applicationPassword = "applicationPassword";
			smsSendRequest.auth.accountId = "accountId";

			//set up request specific parameters
			smsSendRequest.toNumber = "toNumber";
			smsSendRequest.content = "content";
			smsSendRequest.locationId = "locationId";
			smsSendRequest.queueId = "queueId";

			//create the request
			string json = Utilities.buildRequestJson(smsSendRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "SmsSend", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			SmsSendResponse smsSendResponse = javascriptSerializer.Deserialize<SmsSendResponse>(jsonResponse);

			Console.WriteLine(smsSendResponse.responseCode);
			Console.WriteLine(smsSendResponse.responseMessage);

			Environment.Exit (0);
		}


		public class SmsSendRequest : UpdoxRequest {
			public string toNumber { get; set;}
			public string content { get; set;}
			public string locationId { get; set;}
			public string queueId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class SmsSendResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_SmsSend {

	public static void main(String[] args) {
		UpdoxCodeSample_SmsSend codeSample = new UpdoxCodeSample_SmsSend();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "SmsSend";

		SmsSendRequest smsSendRequest = new SmsSendRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = smsSendRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		smsSendRequest.setToNumber("toNumber");
		smsSendRequest.setContent("content");
		smsSendRequest.setLocationId("locationId");
		smsSendRequest.setQueueId("queueId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(smsSendRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'SmsSend', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		SmsSendResponse smsSendResponse = mapper.readValue(jsonResponse, SmsSendResponse.class);

		System.out.println(smsSendResponse.getResponseCode());
		System.out.println(smsSendResponse.getResponseMessage());
	}

	private class SmsSendRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String toNumber;
    	private String content;
    	private String locationId;
    	private String queueId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getToNumber() {
			return toNumber;
		}

		public void setToNumber(String toNumber) {
			this.toNumber = toNumber;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}

		public String getLocationId() {
			return locationId;
		}

		public void setLocationId(String locationId) {
			this.locationId = locationId;
		}

		public String getQueueId() {
			return queueId;
		}

		public void setQueueId(String queueId) {
			this.queueId = queueId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class SmsSendResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4035`	`SMS number not verified; verification has been requested.`
`4033`	`SMS number verification has been rejected; contact support.`
`4039`	`On file account business information is insufficient for verification.`
`4015`	`Unauthorized - API not enabled for the request's access rights`

SmsSendNumberList /io/SmsSendNumberList

Retrieve a list of SMS Quicksend numbers for an account including their verification status.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Try it! Toggle Notes/Code Samples

SmsSendNumberList

Retrieve a list of SMS Quicksend numbers for an account including their verification status.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Below are the number statuses, but please note that they are subject to change:

disabled -> Number cannot be used; reach out to Updox Partner Support for more information.
pending -> Number is pending verification and is unavailable for use until verification has been completed.
registered -> Number has completed verification and is available for use.
rejected -> Number cannot be used; reach out to Updox Partner Support for more information.
unknown -> Number state is unknown; reach out to Updox Partner Support for more information.
unregistered -> Number state is unknown; reach out to Updox Partner Support for more information.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_SmsSendNumberList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_SmsSendNumberList codeSample = new UpdoxCodeSample_SmsSendNumberList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "SmsSendNumberList";
			SmsSendNumberListRequest smsSendNumberListRequest = new SmsSendNumberListRequest();

			//set up credentials
			smsSendNumberListRequest.auth.applicationId = "applicationId";
			smsSendNumberListRequest.auth.applicationPassword = "applicationPassword";
			smsSendNumberListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(smsSendNumberListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "SmsSendNumberList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			SmsSendNumberListResponse smsSendNumberListResponse = javascriptSerializer.Deserialize<SmsSendNumberListResponse>(jsonResponse);

			Console.WriteLine(smsSendNumberListResponse.responseCode);
			Console.WriteLine(smsSendNumberListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class SmsSendNumberListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class SmsSendNumberApiCallableId {
			public string locationId { get; set;}
			public string queueId { get; set;}
		}

		public class SmsSendNumberStatus {
			public string smsNumber { get; set;}
			public string smsNumberStatus { get; set;}
			public string updoxName { get; set;}
			public SmsSendNumberApiCallableId apiCallableId { get; set;}
		}

		public class SmsSendNumberListResponse : UpdoxResponse {
			public List<SmsSendNumberStatus> smsNumbers { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_SmsSendNumberList {

	public static void main(String[] args) {
		UpdoxCodeSample_SmsSendNumberList codeSample = new UpdoxCodeSample_SmsSendNumberList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "SmsSendNumberList";

		SmsSendNumberListRequest smsSendNumberListRequest = new SmsSendNumberListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = smsSendNumberListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(smsSendNumberListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'SmsSendNumberList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		SmsSendNumberListResponse smsSendNumberListResponse = mapper.readValue(jsonResponse, SmsSendNumberListResponse.class);

		System.out.println(smsSendNumberListResponse.getResponseCode());
		System.out.println(smsSendNumberListResponse.getResponseMessage());
	}

	private class SmsSendNumberListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class SmsSendNumberApiCallableId {
		private String locationId;
		private String queueId;


		public String getLocationId() {
			return locationId;
		}

		public void setLocationId(String locationId) {
			this.locationId = locationId;
		}

		public String getQueueId() {
			return queueId;
		}

		public void setQueueId(String queueId) {
			this.queueId = queueId;
		}
	}

	private static class SmsSendNumberStatus {
		private String smsNumber;
		private String smsNumberStatus;
		private String updoxName;
		private SmsSendNumberApiCallableId apiCallableId;


		public String getSmsNumber() {
			return smsNumber;
		}

		public void setSmsNumber(String smsNumber) {
			this.smsNumber = smsNumber;
		}

		public String getSmsNumberStatus() {
			return smsNumberStatus;
		}

		public void setSmsNumberStatus(String smsNumberStatus) {
			this.smsNumberStatus = smsNumberStatus;
		}

		public String getUpdoxName() {
			return updoxName;
		}

		public void setUpdoxName(String updoxName) {
			this.updoxName = updoxName;
		}

		public SmsSendNumberApiCallableId getApiCallableId() {
			return apiCallableId;
		}

		public void setApiCallableId(SmsSendNumberApiCallableId apiCallableId) {
			this.apiCallableId = apiCallableId;
		}
	}

	private static class SmsSendNumberListResponse extends UpdoxResponse {
		private List<SmsSendNumberStatus> smsNumbers;


		public List<SmsSendNumberStatus> getSmsNumbers() {
			return smsNumbers;
		}

		public void setSmsNumbers(List<SmsSendNumberStatus> smsNumbers) {
			this.smsNumbers = smsNumbers;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

SmsStatus /io/SmsStatus

Used to retrieve the current status (queued, then sent or failed) of SMS messages sent via /SmsSend

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
smsMessageId	Long		The `messageId` returned from `/SmsSend`. This is required.

Try it! Toggle Notes/Code Samples

SmsStatus

Used to retrieve the current status (queued, then sent or failed) of SMS messages sent via /SmsSend

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Both status and statusReason can be updated based on the current statuses and the known failures at any given time.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_SmsStatus {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_SmsStatus codeSample = new UpdoxCodeSample_SmsStatus();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "SmsStatus";
			SmsStatusRequest smsStatusRequest = new SmsStatusRequest();

			//set up credentials
			smsStatusRequest.auth.applicationId = "applicationId";
			smsStatusRequest.auth.applicationPassword = "applicationPassword";
			smsStatusRequest.auth.accountId = "accountId";

			//set up request specific parameters
			smsStatusRequest.smsMessageId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(smsStatusRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "SmsStatus", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			SmsStatusResponse smsStatusResponse = javascriptSerializer.Deserialize<SmsStatusResponse>(jsonResponse);

			Console.WriteLine(smsStatusResponse.responseCode);
			Console.WriteLine(smsStatusResponse.responseMessage);

			Environment.Exit (0);
		}


		public class SmsStatusRequest : UpdoxRequest {
			public long smsMessageId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class SmsStatusResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_SmsStatus {

	public static void main(String[] args) {
		UpdoxCodeSample_SmsStatus codeSample = new UpdoxCodeSample_SmsStatus();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "SmsStatus";

		SmsStatusRequest smsStatusRequest = new SmsStatusRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = smsStatusRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		smsStatusRequest.setSmsMessageId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(smsStatusRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'SmsStatus', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		SmsStatusResponse smsStatusResponse = mapper.readValue(jsonResponse, SmsStatusResponse.class);

		System.out.println(smsStatusResponse.getResponseCode());
		System.out.println(smsStatusResponse.getResponseMessage());
	}

	private class SmsStatusRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long smsMessageId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getSmsMessageId() {
			return smsMessageId;
		}

		public void setSmsMessageId(long smsMessageId) {
			this.smsMessageId = smsMessageId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class SmsStatusResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`4094`	`record does not exist`

SmsThread /io/SmsThread

Retrieve an SMS thread

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
threadId	Long		The ID of the SMS thread. This is required.

Try it! Toggle Notes/Code Samples

SmsThread

Retrieve an SMS thread

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_SmsThread {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_SmsThread codeSample = new UpdoxCodeSample_SmsThread();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "SmsThread";
			SmsThreadRequest smsThreadRequest = new SmsThreadRequest();

			//set up credentials
			smsThreadRequest.auth.applicationId = "applicationId";
			smsThreadRequest.auth.applicationPassword = "applicationPassword";
			smsThreadRequest.auth.accountId = "accountId";

			//set up request specific parameters
			smsThreadRequest.threadId = 1L;

			//create the request
			string json = Utilities.buildRequestJson(smsThreadRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "SmsThread", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			SmsThreadResponse smsThreadResponse = javascriptSerializer.Deserialize<SmsThreadResponse>(jsonResponse);

			Console.WriteLine(smsThreadResponse.responseCode);
			Console.WriteLine(smsThreadResponse.responseMessage);

			Environment.Exit (0);
		}


		public class SmsThreadRequest : UpdoxRequest {
			public long threadId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class SmsThreadResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_SmsThread {

	public static void main(String[] args) {
		UpdoxCodeSample_SmsThread codeSample = new UpdoxCodeSample_SmsThread();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "SmsThread";

		SmsThreadRequest smsThreadRequest = new SmsThreadRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = smsThreadRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		smsThreadRequest.setThreadId(1L);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(smsThreadRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'SmsThread', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		SmsThreadResponse smsThreadResponse = mapper.readValue(jsonResponse, SmsThreadResponse.class);

		System.out.println(smsThreadResponse.getResponseCode());
		System.out.println(smsThreadResponse.getResponseMessage());
	}

	private class SmsThreadRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private long threadId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public long getThreadId() {
			return threadId;
		}

		public void setThreadId(long threadId) {
			this.threadId = threadId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class SmsThreadResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

SsoMessageActions

ApplicationOpen /io/ApplicationOpen

Request a token used to open the SSO application at 'https://{serverRegion}/sso/applicationOpen/{applicationId}/{token}'. NOTE: Tokens are one-time use only - subsequent SSO operation attempts with a used token will receive a 404.

Parameter	Type	Description
ipAddress	String	Optional: sets the IP required to use this token. Max length 100 characters.
timeout	Int	Optional: sets the time to timeout this token in seconds. Max value is 3600 (1 hour). Default is 600 (10 minutes). The value must be between 0 and 3600.
metadata	String	The metadata associated with this SSO attempt. Used for vendor information only.

Try it! Toggle Notes/Code Samples

ApplicationOpen

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Use the received token to construct a url in the following manner:

https://{environment}/sso/${method.methodName}/{vendorId}/{token}

An example might look like this:

https://updoxqa.com/sso/${method.methodName}/updox/611e840357c9dd58625436996cc2631910188c61

Note: As this token has already been used, browsing this exact link will result in a 404 error.

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ApplicationOpen {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ApplicationOpen codeSample = new UpdoxCodeSample_ApplicationOpen();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ApplicationOpen";
			ApplicationOpenRequest applicationOpenRequest = new ApplicationOpenRequest();

			//set up credentials
			applicationOpenRequest.auth.applicationId = "applicationId";
			applicationOpenRequest.auth.applicationPassword = "applicationPassword";
			applicationOpenRequest.auth.accountId = "accountId";
			applicationOpenRequest.auth.userId = "userId";

			//set up request specific parameters
			applicationOpenRequest.ipAddress = "ipAddress";
			applicationOpenRequest.timeout = 1;
			applicationOpenRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(applicationOpenRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ApplicationOpen", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ApplicationOpenResponse applicationOpenResponse = javascriptSerializer.Deserialize<ApplicationOpenResponse>(jsonResponse);

			Console.WriteLine(applicationOpenResponse.responseCode);
			Console.WriteLine(applicationOpenResponse.responseMessage);

			Environment.Exit (0);
		}


		public class ApplicationOpenRequest : UpdoxRequest {
			public string ipAddress { get; set;}
			public int timeout { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ApplicationOpenResponse : UpdoxResponse {
			public string token { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_ApplicationOpen {

	public static void main(String[] args) {
		UpdoxCodeSample_ApplicationOpen codeSample = new UpdoxCodeSample_ApplicationOpen();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ApplicationOpen";

		ApplicationOpenRequest applicationOpenRequest = new ApplicationOpenRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = applicationOpenRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		applicationOpenRequest.setIpAddress("ipAddress");
		applicationOpenRequest.setTimeout(1);
		applicationOpenRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(applicationOpenRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ApplicationOpen', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ApplicationOpenResponse applicationOpenResponse = mapper.readValue(jsonResponse, ApplicationOpenResponse.class);

		System.out.println(applicationOpenResponse.getResponseCode());
		System.out.println(applicationOpenResponse.getResponseMessage());
	}

	private class ApplicationOpenRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ipAddress;
    	private int timeout;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public int getTimeout() {
			return timeout;
		}

		public void setTimeout(int timeout) {
			this.timeout = timeout;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class ApplicationOpenResponse extends UpdoxResponse {
		private String token;


		public String getToken() {
			return token;
		}

		public void setToken(String token) {
			this.token = token;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

ApplicationOpenPage /io/ApplicationOpenPage

Request a token used to open the SSO application at 'https://{serverRegion}/sso/applicationOpenPage/{applicationId}/{token}'. NOTE: Tokens are one-time use only - subsequent SSO operation attempts with a used token will receive a 404.

Parameter	Type	Value	Description
ipAddress	String		Optional: sets the IP required to use this token. Max length 100 characters.
timeout	Int		Optional: sets the time to timeout this token in seconds. Max value is 3600 (1 hour). Default is 600 (10 minutes). The value must be between 0 and 3600.
metadata	String		The metadata associated with this SSO attempt. Used for vendor information only.
destinationPage
name	String		Name of the destination page/feature. Max length 64 characters. Must be one of the following values: reminderscriptcreate, reminderscriptedit, reminderrules, addressbook, admintab, video, formdashboard. This is required.
parameters	List	add remove	List of Key/Value pairs used to augment the SSO Page request.

key	String
value	String

Try it! Toggle Notes/Code Samples

ApplicationOpenPage

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Use the received token to construct a url in the following manner:

https://{environment}/sso/${method.methodName}/{vendorId}/{token}

An example might look like this:

https://updoxqa.com/sso/${method.methodName}/updox/611e840357c9dd58625436996cc2631910188c61

Note: As this token has already been used, browsing this exact link will result in a 404 error.

Destination Page Name	Parameter Key	Parameter Value	Notes
`ReminderScriptCreate`	`scriptType`	Voice\|Text2Voice\|Email\|Text	Only one script type may be provided
`ReminderScriptEdit`	`scriptId`	number	The scriptId value represents the id of the script to be edited

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_ApplicationOpenPage {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_ApplicationOpenPage codeSample = new UpdoxCodeSample_ApplicationOpenPage();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "ApplicationOpenPage";
			ApplicationOpenPageRequest applicationOpenPageRequest = new ApplicationOpenPageRequest();

			//set up credentials
			applicationOpenPageRequest.auth.applicationId = "applicationId";
			applicationOpenPageRequest.auth.applicationPassword = "applicationPassword";
			applicationOpenPageRequest.auth.accountId = "accountId";
			applicationOpenPageRequest.auth.userId = "userId";

			//set up request specific parameters
			applicationOpenPageRequest.ipAddress = "ipAddress";
			applicationOpenPageRequest.timeout = 1;
			applicationOpenPageRequest.metadata = "metadata";
			List<DestinationPageParameter> parameters = new List<DestinationPageParameter>();
			DestinationPageParameter destinationPageParameter = new DestinationPageParameter();
			destinationPageParameter.key = "key";
			destinationPageParameter.value = "value";
			parameters.Add(destinationPageParameter);
			DestinationPage destinationPage = new DestinationPage();
			destinationPage.name = "name";
			destinationPage.parameters = parameters;
			applicationOpenPageRequest.destinationPage = destinationPage;

			//create the request
			string json = Utilities.buildRequestJson(applicationOpenPageRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "ApplicationOpenPage", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			ApplicationOpenPageResponse applicationOpenPageResponse = javascriptSerializer.Deserialize<ApplicationOpenPageResponse>(jsonResponse);

			Console.WriteLine(applicationOpenPageResponse.responseCode);
			Console.WriteLine(applicationOpenPageResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DestinationPageParameter {
			public string key { get; set;}
			public string value { get; set;}
		}

		public class ApplicationOpenPageRequest : UpdoxRequest {
			public string ipAddress { get; set;}
			public int timeout { get; set;}
			public string metadata { get; set;}
			public DestinationPage destinationPage { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ApplicationOpenPageResponse : UpdoxResponse {
			public string token { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_ApplicationOpenPage {

	public static void main(String[] args) {
		UpdoxCodeSample_ApplicationOpenPage codeSample = new UpdoxCodeSample_ApplicationOpenPage();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "ApplicationOpenPage";

		ApplicationOpenPageRequest applicationOpenPageRequest = new ApplicationOpenPageRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = applicationOpenPageRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		applicationOpenPageRequest.setIpAddress("ipAddress");
		applicationOpenPageRequest.setTimeout(1);
		applicationOpenPageRequest.setMetadata("metadata");
	List<DestinationPageParameter> parameters = new ArrayList<>();
		DestinationPageParameter destinationPageParameter = new DestinationPageParameter();
		destinationPageParameter.setKey("key");
		destinationPageParameter.setValue("value");
		parameters.add(destinationPageParameter);
		DestinationPage destinationPage = new DestinationPage();
		destinationPage.setName("name");
		destinationPage.setParameters(parameters);
		applicationOpenPageRequest.setDestinationPage(destinationPage);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(applicationOpenPageRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'ApplicationOpenPage', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		ApplicationOpenPageResponse applicationOpenPageResponse = mapper.readValue(jsonResponse, ApplicationOpenPageResponse.class);

		System.out.println(applicationOpenPageResponse.getResponseCode());
		System.out.println(applicationOpenPageResponse.getResponseMessage());
	}

	private static class DestinationPageParameter {
		private String key;
		private String value;


		public String getKey() {
			return key;
		}

		public void setKey(String key) {
			this.key = key;
		}

		public String getValue() {
			return value;
		}

		public void setValue(String value) {
			this.value = value;
		}
	}

	private class ApplicationOpenPageRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String ipAddress;
    	private int timeout;
    	private String metadata;
    	private DestinationPage destinationPage;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getIpAddress() {
			return ipAddress;
		}

		public void setIpAddress(String ipAddress) {
			this.ipAddress = ipAddress;
		}

		public int getTimeout() {
			return timeout;
		}

		public void setTimeout(int timeout) {
			this.timeout = timeout;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public DestinationPage getDestinationPage() {
			return destinationPage;
		}

		public void setDestinationPage(DestinationPage destinationPage) {
			this.destinationPage = destinationPage;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class ApplicationOpenPageResponse extends UpdoxResponse {
		private String token;


		public String getToken() {
			return token;
		}

		public void setToken(String token) {
			this.token = token;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

UserActions

DirectAddressIsAvailable /io/DirectAddressIsAvailable

Checks the availability of the given direct address. Important note: this method is only a preliminary check, it does not reserve the address. There is a race condition from when this method is called and when UserCreate/Update/Save is called. The address may be taken between the two calls, and proper care should be taken to handle the corresponding error codes.

Parameter	Type	Value	Description
directAddress	String		The direct address to check. This field should pass only the `username` in the full address `username@direct.domain.com`. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

DirectAddressIsAvailable

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_DirectAddressIsAvailable {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_DirectAddressIsAvailable codeSample = new UpdoxCodeSample_DirectAddressIsAvailable();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "DirectAddressIsAvailable";
			DirectAddressIsAvailableRequest directAddressIsAvailableRequest = new DirectAddressIsAvailableRequest();

			//set up credentials
			directAddressIsAvailableRequest.auth.applicationId = "applicationId";
			directAddressIsAvailableRequest.auth.applicationPassword = "applicationPassword";
			directAddressIsAvailableRequest.auth.accountId = "accountId";

			//set up request specific parameters
			directAddressIsAvailableRequest.directAddress = "directAddress";

			//create the request
			string json = Utilities.buildRequestJson(directAddressIsAvailableRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "DirectAddressIsAvailable", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			DirectAddressIsAvailableResponse directAddressIsAvailableResponse = javascriptSerializer.Deserialize<DirectAddressIsAvailableResponse>(jsonResponse);

			Console.WriteLine(directAddressIsAvailableResponse.responseCode);
			Console.WriteLine(directAddressIsAvailableResponse.responseMessage);

			Environment.Exit (0);
		}


		public class DirectAddressIsAvailableRequest : UpdoxRequest {
			public string directAddress { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class DirectAddressIsAvailableResponse : UpdoxResponse {
			public bool isAvailable { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_DirectAddressIsAvailable {

	public static void main(String[] args) {
		UpdoxCodeSample_DirectAddressIsAvailable codeSample = new UpdoxCodeSample_DirectAddressIsAvailable();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "DirectAddressIsAvailable";

		DirectAddressIsAvailableRequest directAddressIsAvailableRequest = new DirectAddressIsAvailableRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = directAddressIsAvailableRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		directAddressIsAvailableRequest.setDirectAddress("directAddress");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(directAddressIsAvailableRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'DirectAddressIsAvailable', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		DirectAddressIsAvailableResponse directAddressIsAvailableResponse = mapper.readValue(jsonResponse, DirectAddressIsAvailableResponse.class);

		System.out.println(directAddressIsAvailableResponse.getResponseCode());
		System.out.println(directAddressIsAvailableResponse.getResponseMessage());
	}

	private class DirectAddressIsAvailableRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String directAddress;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class DirectAddressIsAvailableResponse extends UpdoxResponse {
		private boolean isAvailable;


		public boolean isIsAvailable() {
			return isAvailable;
		}

		public void setIsAvailable(boolean isAvailable) {
			this.isAvailable = isAvailable;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

LoginIdIsAvailable /io/LoginIdIsAvailable

Checks the availability of the given loginId.

Parameter	Type	Value	Description
loginId	String		The `loginId` to check. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

LoginIdIsAvailable

Checks the availability of the given loginId.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_LoginIdIsAvailable {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_LoginIdIsAvailable codeSample = new UpdoxCodeSample_LoginIdIsAvailable();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "LoginIdIsAvailable";
			LoginIdIsAvailableRequest loginIdIsAvailableRequest = new LoginIdIsAvailableRequest();

			//set up credentials
			loginIdIsAvailableRequest.auth.applicationId = "applicationId";
			loginIdIsAvailableRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			loginIdIsAvailableRequest.loginId = "loginId";

			//create the request
			string json = Utilities.buildRequestJson(loginIdIsAvailableRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "LoginIdIsAvailable", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			LoginIdIsAvailableResponse loginIdIsAvailableResponse = javascriptSerializer.Deserialize<LoginIdIsAvailableResponse>(jsonResponse);

			Console.WriteLine(loginIdIsAvailableResponse.responseCode);
			Console.WriteLine(loginIdIsAvailableResponse.responseMessage);

			Environment.Exit (0);
		}


		public class LoginIdIsAvailableRequest : UpdoxRequest {
			public string loginId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class LoginIdIsAvailableResponse : UpdoxResponse {
			public bool isAvailable { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_LoginIdIsAvailable {

	public static void main(String[] args) {
		UpdoxCodeSample_LoginIdIsAvailable codeSample = new UpdoxCodeSample_LoginIdIsAvailable();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "LoginIdIsAvailable";

		LoginIdIsAvailableRequest loginIdIsAvailableRequest = new LoginIdIsAvailableRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = loginIdIsAvailableRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		loginIdIsAvailableRequest.setLoginId("loginId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(loginIdIsAvailableRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'LoginIdIsAvailable', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		LoginIdIsAvailableResponse loginIdIsAvailableResponse = mapper.readValue(jsonResponse, LoginIdIsAvailableResponse.class);

		System.out.println(loginIdIsAvailableResponse.getResponseCode());
		System.out.println(loginIdIsAvailableResponse.getResponseMessage());
	}

	private class LoginIdIsAvailableRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String loginId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class LoginIdIsAvailableResponse extends UpdoxResponse {
		private boolean isAvailable;


		public boolean isIsAvailable() {
			return isAvailable;
		}

		public void setIsAvailable(boolean isAvailable) {
			this.isAvailable = isAvailable;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

UserCreate /io/UserCreate

Creates a user with the userId passed into auth.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	Min length 5 characters. Max length 15 characters.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserCreate

Creates a user with the userId passed into auth.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserCreate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserCreate codeSample = new UpdoxCodeSample_UserCreate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserCreate";
			UserCreateRequest userCreateRequest = new UserCreateRequest();

			//set up credentials
			userCreateRequest.auth.applicationId = "applicationId";
			userCreateRequest.auth.applicationPassword = "applicationPassword";
			userCreateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			userCreateRequest.userId = "userId";
			userCreateRequest.emrUserId = "emrUserId";
			userCreateRequest.loginId = "loginId";
			userCreateRequest.loginPassword = "loginPassword";
			userCreateRequest.firstName = "firstName";
			userCreateRequest.middleName = "middleName";
			userCreateRequest.lastName = "lastName";
			userCreateRequest.address1 = "address1";
			userCreateRequest.address2 = "address2";
			userCreateRequest.city = "Dublin";
			userCreateRequest.state = "OH";
			userCreateRequest.postal = "postal";
			userCreateRequest.timeZone = "timeZone";
			userCreateRequest.active = true;
			userCreateRequest.provider = true;
			userCreateRequest.admin = true;
			userCreateRequest.directAddress = "directAddress";
			userCreateRequest.npi = "npi";
			userCreateRequest.providerTaxonomyCode = "providerTaxonomyCode";
			userCreateRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userCreateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserCreate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserCreateResponse userCreateResponse = javascriptSerializer.Deserialize<UserCreateResponse>(jsonResponse);

			Console.WriteLine(userCreateResponse.responseCode);
			Console.WriteLine(userCreateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserCreateRequest : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserCreateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserCreate {

	public static void main(String[] args) {
		UpdoxCodeSample_UserCreate codeSample = new UpdoxCodeSample_UserCreate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserCreate";

		UserCreateRequest userCreateRequest = new UserCreateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userCreateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userCreateRequest.setUserId("userId");
		userCreateRequest.setEmrUserId("emrUserId");
		userCreateRequest.setLoginId("loginId");
		userCreateRequest.setLoginPassword("loginPassword");
		userCreateRequest.setFirstName("firstName");
		userCreateRequest.setMiddleName("middleName");
		userCreateRequest.setLastName("lastName");
		userCreateRequest.setAddress1("address1");
		userCreateRequest.setAddress2("address2");
		userCreateRequest.setCity("Dublin");
		userCreateRequest.setState("OH");
		userCreateRequest.setPostal("postal");
		userCreateRequest.setTimeZone("timeZone");
		userCreateRequest.setActive(true);
		userCreateRequest.setProvider(true);
		userCreateRequest.setAdmin(true);
		userCreateRequest.setDirectAddress("directAddress");
		userCreateRequest.setNpi("npi");
		userCreateRequest.setProviderTaxonomyCode("providerTaxonomyCode");
		userCreateRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userCreateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserCreate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserCreateResponse userCreateResponse = mapper.readValue(jsonResponse, UserCreateResponse.class);

		System.out.println(userCreateResponse.getResponseCode());
		System.out.println(userCreateResponse.getResponseMessage());
	}

	private class UserCreateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserCreateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4232`	`user password is required`

UserCreate/1.1 /io/UserCreate/1.1

Creates a user with the userId passed into auth.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the user's address

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	The user's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The user's valid postal code based on the country: If "US" - The ZIP 5 postal code (ex: "43017") If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserCreate/1.1

Creates a user with the userId passed into auth.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the user's address

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserCreate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserCreate1_1 codeSample = new UpdoxCodeSample_UserCreate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserCreate1_1";
			UserCreate1_1Request userCreate1_1Request = new UserCreate1_1Request();

			//set up credentials
			userCreate1_1Request.auth.applicationId = "applicationId";
			userCreate1_1Request.auth.applicationPassword = "applicationPassword";
			userCreate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			userCreate1_1Request.userId = "userId";
			userCreate1_1Request.emrUserId = "emrUserId";
			userCreate1_1Request.loginId = "loginId";
			userCreate1_1Request.loginPassword = "loginPassword";
			userCreate1_1Request.firstName = "firstName";
			userCreate1_1Request.middleName = "middleName";
			userCreate1_1Request.lastName = "lastName";
			userCreate1_1Request.address1 = "address1";
			userCreate1_1Request.address2 = "address2";
			userCreate1_1Request.city = "Dublin";
			userCreate1_1Request.state = "OH";
			userCreate1_1Request.postal = "postal";
			userCreate1_1Request.country = "country";
			userCreate1_1Request.timeZone = "timeZone";
			userCreate1_1Request.active = true;
			userCreate1_1Request.provider = true;
			userCreate1_1Request.admin = true;
			userCreate1_1Request.directAddress = "directAddress";
			userCreate1_1Request.npi = "npi";
			userCreate1_1Request.providerTaxonomyCode = "providerTaxonomyCode";
			userCreate1_1Request.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userCreate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserCreate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserCreate1_1Response userCreate1_1Response = javascriptSerializer.Deserialize<UserCreate1_1Response>(jsonResponse);

			Console.WriteLine(userCreate1_1Response.responseCode);
			Console.WriteLine(userCreate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class UserCreate1_1Request : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserCreate1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserCreate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_UserCreate1_1 codeSample = new UpdoxCodeSample_UserCreate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserCreate1_1";

		UserCreate1_1Request userCreate1_1Request = new UserCreate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userCreate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userCreate1_1Request.setUserId("userId");
		userCreate1_1Request.setEmrUserId("emrUserId");
		userCreate1_1Request.setLoginId("loginId");
		userCreate1_1Request.setLoginPassword("loginPassword");
		userCreate1_1Request.setFirstName("firstName");
		userCreate1_1Request.setMiddleName("middleName");
		userCreate1_1Request.setLastName("lastName");
		userCreate1_1Request.setAddress1("address1");
		userCreate1_1Request.setAddress2("address2");
		userCreate1_1Request.setCity("Dublin");
		userCreate1_1Request.setState("OH");
		userCreate1_1Request.setPostal("postal");
		userCreate1_1Request.setCountry("country");
		userCreate1_1Request.setTimeZone("timeZone");
		userCreate1_1Request.setActive(true);
		userCreate1_1Request.setProvider(true);
		userCreate1_1Request.setAdmin(true);
		userCreate1_1Request.setDirectAddress("directAddress");
		userCreate1_1Request.setNpi("npi");
		userCreate1_1Request.setProviderTaxonomyCode("providerTaxonomyCode");
		userCreate1_1Request.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userCreate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserCreate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserCreate1_1Response userCreate1_1Response = mapper.readValue(jsonResponse, UserCreate1_1Response.class);

		System.out.println(userCreate1_1Response.getResponseCode());
		System.out.println(userCreate1_1Response.getResponseMessage());
	}

	private class UserCreate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserCreate1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4232`	`user password is required`

UserGet /io/UserGet

Gets the user associated with supplied userId inside the authorized account.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
userId	String		The ID of the user to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

UserGet

Gets the user associated with supplied userId inside the authorized account.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserGet codeSample = new UpdoxCodeSample_UserGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserGet";
			UserGetRequest userGetRequest = new UserGetRequest();

			//set up credentials
			userGetRequest.auth.applicationId = "applicationId";
			userGetRequest.auth.applicationPassword = "applicationPassword";
			userGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			userGetRequest.userId = "userId";

			//create the request
			string json = Utilities.buildRequestJson(userGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserGetResponse userGetResponse = javascriptSerializer.Deserialize<UserGetResponse>(jsonResponse);

			Console.WriteLine(userGetResponse.responseCode);
			Console.WriteLine(userGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserGetRequest : UpdoxRequest {
			public string userId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MemberInfoLimited {
			public string userId { get; set;}
			public string accountId { get; set;}
			public string loginId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
			public bool isProvider { get; set;}
			public bool isAdmin { get; set;}
			public bool vetted { get; set;}
			public bool active { get; set;}
			public bool searchOptOut { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string directAddress { get; set;}
		}

		public class UserGetResponse : UpdoxResponse {
			public MemberInfoLimited user { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserGet {

	public static void main(String[] args) {
		UpdoxCodeSample_UserGet codeSample = new UpdoxCodeSample_UserGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserGet";

		UserGetRequest userGetRequest = new UserGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userGetRequest.setUserId("userId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserGetResponse userGetResponse = mapper.readValue(jsonResponse, UserGetResponse.class);

		System.out.println(userGetResponse.getResponseCode());
		System.out.println(userGetResponse.getResponseMessage());
	}

	private class UserGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class MemberInfoLimited {
		private String userId;
		private String accountId;
		private String loginId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String timeZone;
		private String metadata;
		private boolean isProvider;
		private boolean isAdmin;
		private boolean vetted;
		private boolean active;
		private boolean searchOptOut;
		private String npi;
		private String providerTaxonomyCode;
		private String directAddress;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public boolean isIsProvider() {
			return isProvider;
		}

		public void setIsProvider(boolean isProvider) {
			this.isProvider = isProvider;
		}

		public boolean isIsAdmin() {
			return isAdmin;
		}

		public void setIsAdmin(boolean isAdmin) {
			this.isAdmin = isAdmin;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isSearchOptOut() {
			return searchOptOut;
		}

		public void setSearchOptOut(boolean searchOptOut) {
			this.searchOptOut = searchOptOut;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}
	}

	private static class UserGetResponse extends UpdoxResponse {
		private MemberInfoLimited user;


		public MemberInfoLimited getUser() {
			return user;
		}

		public void setUser(MemberInfoLimited user) {
			this.user = user;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`

UserGet/1.1 /io/UserGet/1.1

Gets the user associated with supplied userId inside the authorized account.

Changes from v1.0 to v1.1:

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

Parameter	Type	Value	Description
userId	String		The ID of the user to get. Max length 255 characters. This is required.

Try it! Toggle Notes/Code Samples

UserGet/1.1

Gets the user associated with supplied userId inside the authorized account.

Changes from v1.0 to v1.1:

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserGet1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserGet1_1 codeSample = new UpdoxCodeSample_UserGet1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserGet1_1";
			UserGet1_1Request userGet1_1Request = new UserGet1_1Request();

			//set up credentials
			userGet1_1Request.auth.applicationId = "applicationId";
			userGet1_1Request.auth.applicationPassword = "applicationPassword";
			userGet1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			userGet1_1Request.userId = "userId";

			//create the request
			string json = Utilities.buildRequestJson(userGet1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserGet/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserGet1_1Response userGet1_1Response = javascriptSerializer.Deserialize<UserGet1_1Response>(jsonResponse);

			Console.WriteLine(userGet1_1Response.responseCode);
			Console.WriteLine(userGet1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class UserGet1_1Request : UpdoxRequest {
			public string userId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MemberInfoLimitedWithCountry {
			public string userId { get; set;}
			public string accountId { get; set;}
			public string loginId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
			public bool isProvider { get; set;}
			public bool isAdmin { get; set;}
			public bool vetted { get; set;}
			public bool active { get; set;}
			public bool searchOptOut { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string directAddress { get; set;}
			public string country { get; set;}
		}

		public class UserGet1_1Response : UpdoxResponse {
			public MemberInfoLimitedWithCountry user { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserGet1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_UserGet1_1 codeSample = new UpdoxCodeSample_UserGet1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserGet1_1";

		UserGet1_1Request userGet1_1Request = new UserGet1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userGet1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userGet1_1Request.setUserId("userId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userGet1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserGet/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserGet1_1Response userGet1_1Response = mapper.readValue(jsonResponse, UserGet1_1Response.class);

		System.out.println(userGet1_1Response.getResponseCode());
		System.out.println(userGet1_1Response.getResponseMessage());
	}

	private class UserGet1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class MemberInfoLimitedWithCountry {
		private String userId;
		private String accountId;
		private String loginId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String timeZone;
		private String metadata;
		private boolean isProvider;
		private boolean isAdmin;
		private boolean vetted;
		private boolean active;
		private boolean searchOptOut;
		private String npi;
		private String providerTaxonomyCode;
		private String directAddress;
		private String country;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public boolean isIsProvider() {
			return isProvider;
		}

		public void setIsProvider(boolean isProvider) {
			this.isProvider = isProvider;
		}

		public boolean isIsAdmin() {
			return isAdmin;
		}

		public void setIsAdmin(boolean isAdmin) {
			this.isAdmin = isAdmin;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isSearchOptOut() {
			return searchOptOut;
		}

		public void setSearchOptOut(boolean searchOptOut) {
			this.searchOptOut = searchOptOut;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}
	}

	private static class UserGet1_1Response extends UpdoxResponse {
		private MemberInfoLimitedWithCountry user;


		public MemberInfoLimitedWithCountry getUser() {
			return user;
		}

		public void setUser(MemberInfoLimitedWithCountry user) {
			this.user = user;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`

UserList /io/UserList

Lists all of the users in an application.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Value	Description
accountId	String		Optional account ID supplied to list the users within a specific account. Max length 255 characters.

Try it! Toggle Notes/Code Samples

UserList

Lists all of the users in an application.

Outdated: A newer version of this endpoint is available.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserList codeSample = new UpdoxCodeSample_UserList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserList";
			UserListRequest userListRequest = new UserListRequest();

			//set up credentials
			userListRequest.auth.applicationId = "applicationId";
			userListRequest.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			userListRequest.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(userListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserListResponse userListResponse = javascriptSerializer.Deserialize<UserListResponse>(jsonResponse);

			Console.WriteLine(userListResponse.responseCode);
			Console.WriteLine(userListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserListRequest : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MemberInfoLimited {
			public string userId { get; set;}
			public string accountId { get; set;}
			public string loginId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
			public bool isProvider { get; set;}
			public bool isAdmin { get; set;}
			public bool vetted { get; set;}
			public bool active { get; set;}
			public bool searchOptOut { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string directAddress { get; set;}
		}

		public class UserListResponse : UpdoxResponse {
			public List<MemberInfoLimited> userList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_UserList {

	public static void main(String[] args) {
		UpdoxCodeSample_UserList codeSample = new UpdoxCodeSample_UserList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserList";

		UserListRequest userListRequest = new UserListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		userListRequest.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserListResponse userListResponse = mapper.readValue(jsonResponse, UserListResponse.class);

		System.out.println(userListResponse.getResponseCode());
		System.out.println(userListResponse.getResponseMessage());
	}

	private class UserListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class MemberInfoLimited {
		private String userId;
		private String accountId;
		private String loginId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String timeZone;
		private String metadata;
		private boolean isProvider;
		private boolean isAdmin;
		private boolean vetted;
		private boolean active;
		private boolean searchOptOut;
		private String npi;
		private String providerTaxonomyCode;
		private String directAddress;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public boolean isIsProvider() {
			return isProvider;
		}

		public void setIsProvider(boolean isProvider) {
			this.isProvider = isProvider;
		}

		public boolean isIsAdmin() {
			return isAdmin;
		}

		public void setIsAdmin(boolean isAdmin) {
			this.isAdmin = isAdmin;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isSearchOptOut() {
			return searchOptOut;
		}

		public void setSearchOptOut(boolean searchOptOut) {
			this.searchOptOut = searchOptOut;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}
	}

	private static class UserListResponse extends UpdoxResponse {
		private List<MemberInfoLimited> userList;


		public List<MemberInfoLimited> getUserList() {
			return userList;
		}

		public void setUserList(List<MemberInfoLimited> userList) {
			this.userList = userList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

UserList/1.1 /io/UserList/1.1

Lists all of the users in an application.

Changes from v1.0 to v1.1:

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

Parameter	Type	Value	Description
accountId	String		Optional account ID supplied to list the users within a specific account. Max length 255 characters.

Try it! Toggle Notes/Code Samples

UserList/1.1

Lists all of the users in an application.

Changes from v1.0 to v1.1:

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

Prerequisites

This API call requires Application Credentials . The credentials should be populated into the applicationId and applicationPassword fields.


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserList1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserList1_1 codeSample = new UpdoxCodeSample_UserList1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserList1_1";
			UserList1_1Request userList1_1Request = new UserList1_1Request();

			//set up credentials
			userList1_1Request.auth.applicationId = "applicationId";
			userList1_1Request.auth.applicationPassword = "applicationPassword";

			//set up request specific parameters
			userList1_1Request.accountId = "accountId";

			//create the request
			string json = Utilities.buildRequestJson(userList1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserList/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserList1_1Response userList1_1Response = javascriptSerializer.Deserialize<UserList1_1Response>(jsonResponse);

			Console.WriteLine(userList1_1Response.responseCode);
			Console.WriteLine(userList1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class UserList1_1Request : UpdoxRequest {
			public string accountId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class MemberInfoLimitedWithCountry {
			public string userId { get; set;}
			public string accountId { get; set;}
			public string loginId { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public string metadata { get; set;}
			public bool isProvider { get; set;}
			public bool isAdmin { get; set;}
			public bool vetted { get; set;}
			public bool active { get; set;}
			public bool searchOptOut { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string directAddress { get; set;}
			public string country { get; set;}
		}

		public class UserList1_1Response : UpdoxResponse {
			public List<MemberInfoLimitedWithCountry> userList { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_UserList1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_UserList1_1 codeSample = new UpdoxCodeSample_UserList1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserList1_1";

		UserList1_1Request userList1_1Request = new UserList1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userList1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");

		userList1_1Request.setAccountId("accountId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userList1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserList/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserList1_1Response userList1_1Response = mapper.readValue(jsonResponse, UserList1_1Response.class);

		System.out.println(userList1_1Response.getResponseCode());
		System.out.println(userList1_1Response.getResponseMessage());
	}

	private class UserList1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String accountId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

	}

	private static class MemberInfoLimitedWithCountry {
		private String userId;
		private String accountId;
		private String loginId;
		private String firstName;
		private String middleName;
		private String lastName;
		private String address1;
		private String address2;
		private String city;
		private String state;
		private String postal;
		private String timeZone;
		private String metadata;
		private boolean isProvider;
		private boolean isAdmin;
		private boolean vetted;
		private boolean active;
		private boolean searchOptOut;
		private String npi;
		private String providerTaxonomyCode;
		private String directAddress;
		private String country;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAccountId() {
			return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}

		public boolean isIsProvider() {
			return isProvider;
		}

		public void setIsProvider(boolean isProvider) {
			this.isProvider = isProvider;
		}

		public boolean isIsAdmin() {
			return isAdmin;
		}

		public void setIsAdmin(boolean isAdmin) {
			this.isAdmin = isAdmin;
		}

		public boolean isVetted() {
			return vetted;
		}

		public void setVetted(boolean vetted) {
			this.vetted = vetted;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isSearchOptOut() {
			return searchOptOut;
		}

		public void setSearchOptOut(boolean searchOptOut) {
			this.searchOptOut = searchOptOut;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}
	}

	private static class UserList1_1Response extends UpdoxResponse {
		private List<MemberInfoLimitedWithCountry> userList;


		public List<MemberInfoLimitedWithCountry> getUserList() {
			return userList;
		}

		public void setUserList(List<MemberInfoLimitedWithCountry> userList) {
			this.userList = userList;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

UserSave /io/UserSave

Creates or updates the user with the userId passed into auth. If a user with that ID does not exist, a user is created, else that user is updated.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	Min length 5 characters. Max length 15 characters.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserSave

Creates or updates the user with the userId passed into auth. If a user with that ID does not exist, a user is created, else that user is updated.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserSave codeSample = new UpdoxCodeSample_UserSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserSave";
			UserSaveRequest userSaveRequest = new UserSaveRequest();

			//set up credentials
			userSaveRequest.auth.applicationId = "applicationId";
			userSaveRequest.auth.applicationPassword = "applicationPassword";
			userSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			userSaveRequest.userId = "userId";
			userSaveRequest.emrUserId = "emrUserId";
			userSaveRequest.loginId = "loginId";
			userSaveRequest.loginPassword = "loginPassword";
			userSaveRequest.firstName = "firstName";
			userSaveRequest.middleName = "middleName";
			userSaveRequest.lastName = "lastName";
			userSaveRequest.address1 = "address1";
			userSaveRequest.address2 = "address2";
			userSaveRequest.city = "Dublin";
			userSaveRequest.state = "OH";
			userSaveRequest.postal = "postal";
			userSaveRequest.timeZone = "timeZone";
			userSaveRequest.active = true;
			userSaveRequest.provider = true;
			userSaveRequest.admin = true;
			userSaveRequest.directAddress = "directAddress";
			userSaveRequest.npi = "npi";
			userSaveRequest.providerTaxonomyCode = "providerTaxonomyCode";
			userSaveRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserSaveResponse userSaveResponse = javascriptSerializer.Deserialize<UserSaveResponse>(jsonResponse);

			Console.WriteLine(userSaveResponse.responseCode);
			Console.WriteLine(userSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserSaveRequest : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserSaveResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserSave {

	public static void main(String[] args) {
		UpdoxCodeSample_UserSave codeSample = new UpdoxCodeSample_UserSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserSave";

		UserSaveRequest userSaveRequest = new UserSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userSaveRequest.setUserId("userId");
		userSaveRequest.setEmrUserId("emrUserId");
		userSaveRequest.setLoginId("loginId");
		userSaveRequest.setLoginPassword("loginPassword");
		userSaveRequest.setFirstName("firstName");
		userSaveRequest.setMiddleName("middleName");
		userSaveRequest.setLastName("lastName");
		userSaveRequest.setAddress1("address1");
		userSaveRequest.setAddress2("address2");
		userSaveRequest.setCity("Dublin");
		userSaveRequest.setState("OH");
		userSaveRequest.setPostal("postal");
		userSaveRequest.setTimeZone("timeZone");
		userSaveRequest.setActive(true);
		userSaveRequest.setProvider(true);
		userSaveRequest.setAdmin(true);
		userSaveRequest.setDirectAddress("directAddress");
		userSaveRequest.setNpi("npi");
		userSaveRequest.setProviderTaxonomyCode("providerTaxonomyCode");
		userSaveRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserSaveResponse userSaveResponse = mapper.readValue(jsonResponse, UserSaveResponse.class);

		System.out.println(userSaveResponse.getResponseCode());
		System.out.println(userSaveResponse.getResponseMessage());
	}

	private class UserSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserSaveResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4232`	`user password is required`
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`
`4092`	`record currently locked`

UserSave/1.1 /io/UserSave/1.1

Creates or updates the user with the userId passed into auth. If a user with that ID does not exist, a user is created; else, that user is updated.

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	The user's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The user's valid postal code based on the country: If "US" - The ZIP 5 postal code (ex: "43017") If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserSave/1.1

Creates or updates the user with the userId passed into auth. If a user with that ID does not exist, a user is created; else, that user is updated.

country - Added field to response specifying country code for the user's address
postal - Updated field formatting to include the fully detailed postal code for the user's address. For example, a United States zip code of '43016-1234' would be transmitted as such instead of only the first five characters.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserSave1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserSave1_1 codeSample = new UpdoxCodeSample_UserSave1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserSave1_1";
			UserSave1_1Request userSave1_1Request = new UserSave1_1Request();

			//set up credentials
			userSave1_1Request.auth.applicationId = "applicationId";
			userSave1_1Request.auth.applicationPassword = "applicationPassword";
			userSave1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			userSave1_1Request.userId = "userId";
			userSave1_1Request.emrUserId = "emrUserId";
			userSave1_1Request.loginId = "loginId";
			userSave1_1Request.loginPassword = "loginPassword";
			userSave1_1Request.firstName = "firstName";
			userSave1_1Request.middleName = "middleName";
			userSave1_1Request.lastName = "lastName";
			userSave1_1Request.address1 = "address1";
			userSave1_1Request.address2 = "address2";
			userSave1_1Request.city = "Dublin";
			userSave1_1Request.state = "OH";
			userSave1_1Request.postal = "postal";
			userSave1_1Request.country = "country";
			userSave1_1Request.timeZone = "timeZone";
			userSave1_1Request.active = true;
			userSave1_1Request.provider = true;
			userSave1_1Request.admin = true;
			userSave1_1Request.directAddress = "directAddress";
			userSave1_1Request.npi = "npi";
			userSave1_1Request.providerTaxonomyCode = "providerTaxonomyCode";
			userSave1_1Request.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userSave1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserSave/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserSave1_1Response userSave1_1Response = javascriptSerializer.Deserialize<UserSave1_1Response>(jsonResponse);

			Console.WriteLine(userSave1_1Response.responseCode);
			Console.WriteLine(userSave1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class UserSave1_1Request : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserSave1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserSave1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_UserSave1_1 codeSample = new UpdoxCodeSample_UserSave1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserSave1_1";

		UserSave1_1Request userSave1_1Request = new UserSave1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userSave1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userSave1_1Request.setUserId("userId");
		userSave1_1Request.setEmrUserId("emrUserId");
		userSave1_1Request.setLoginId("loginId");
		userSave1_1Request.setLoginPassword("loginPassword");
		userSave1_1Request.setFirstName("firstName");
		userSave1_1Request.setMiddleName("middleName");
		userSave1_1Request.setLastName("lastName");
		userSave1_1Request.setAddress1("address1");
		userSave1_1Request.setAddress2("address2");
		userSave1_1Request.setCity("Dublin");
		userSave1_1Request.setState("OH");
		userSave1_1Request.setPostal("postal");
		userSave1_1Request.setCountry("country");
		userSave1_1Request.setTimeZone("timeZone");
		userSave1_1Request.setActive(true);
		userSave1_1Request.setProvider(true);
		userSave1_1Request.setAdmin(true);
		userSave1_1Request.setDirectAddress("directAddress");
		userSave1_1Request.setNpi("npi");
		userSave1_1Request.setProviderTaxonomyCode("providerTaxonomyCode");
		userSave1_1Request.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userSave1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserSave/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserSave1_1Response userSave1_1Response = mapper.readValue(jsonResponse, UserSave1_1Response.class);

		System.out.println(userSave1_1Response.getResponseCode());
		System.out.println(userSave1_1Response.getResponseMessage());
	}

	private class UserSave1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserSave1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4210`	`no user ID`
`4241`	`invalid user ID, user IDs starting with '@' are reserved for practice users`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4232`	`user password is required`
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4240`	`user does not exist, use practice methods instead`
`4231`	`user does not exist`
`4092`	`record currently locked`

UserUpdate /io/UserUpdate

Updates the user with the userId passed into auth.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	Must be a valid 2 character state code. The value must contain exactly 2 characters.
postal	String	Min length 5 characters. Max length 15 characters.
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserUpdate

Updates the user with the userId passed into auth.

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Outdated: A newer version of this endpoint is available.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserUpdate {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserUpdate codeSample = new UpdoxCodeSample_UserUpdate();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserUpdate";
			UserUpdateRequest userUpdateRequest = new UserUpdateRequest();

			//set up credentials
			userUpdateRequest.auth.applicationId = "applicationId";
			userUpdateRequest.auth.applicationPassword = "applicationPassword";
			userUpdateRequest.auth.accountId = "accountId";

			//set up request specific parameters
			userUpdateRequest.userId = "userId";
			userUpdateRequest.emrUserId = "emrUserId";
			userUpdateRequest.loginId = "loginId";
			userUpdateRequest.loginPassword = "loginPassword";
			userUpdateRequest.firstName = "firstName";
			userUpdateRequest.middleName = "middleName";
			userUpdateRequest.lastName = "lastName";
			userUpdateRequest.address1 = "address1";
			userUpdateRequest.address2 = "address2";
			userUpdateRequest.city = "Dublin";
			userUpdateRequest.state = "OH";
			userUpdateRequest.postal = "postal";
			userUpdateRequest.timeZone = "timeZone";
			userUpdateRequest.active = true;
			userUpdateRequest.provider = true;
			userUpdateRequest.admin = true;
			userUpdateRequest.directAddress = "directAddress";
			userUpdateRequest.npi = "npi";
			userUpdateRequest.providerTaxonomyCode = "providerTaxonomyCode";
			userUpdateRequest.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userUpdateRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserUpdate", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserUpdateResponse userUpdateResponse = javascriptSerializer.Deserialize<UserUpdateResponse>(jsonResponse);

			Console.WriteLine(userUpdateResponse.responseCode);
			Console.WriteLine(userUpdateResponse.responseMessage);

			Environment.Exit (0);
		}


		public class UserUpdateRequest : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserUpdateResponse : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserUpdate {

	public static void main(String[] args) {
		UpdoxCodeSample_UserUpdate codeSample = new UpdoxCodeSample_UserUpdate();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserUpdate";

		UserUpdateRequest userUpdateRequest = new UserUpdateRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userUpdateRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userUpdateRequest.setUserId("userId");
		userUpdateRequest.setEmrUserId("emrUserId");
		userUpdateRequest.setLoginId("loginId");
		userUpdateRequest.setLoginPassword("loginPassword");
		userUpdateRequest.setFirstName("firstName");
		userUpdateRequest.setMiddleName("middleName");
		userUpdateRequest.setLastName("lastName");
		userUpdateRequest.setAddress1("address1");
		userUpdateRequest.setAddress2("address2");
		userUpdateRequest.setCity("Dublin");
		userUpdateRequest.setState("OH");
		userUpdateRequest.setPostal("postal");
		userUpdateRequest.setTimeZone("timeZone");
		userUpdateRequest.setActive(true);
		userUpdateRequest.setProvider(true);
		userUpdateRequest.setAdmin(true);
		userUpdateRequest.setDirectAddress("directAddress");
		userUpdateRequest.setNpi("npi");
		userUpdateRequest.setProviderTaxonomyCode("providerTaxonomyCode");
		userUpdateRequest.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userUpdateRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserUpdate', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserUpdateResponse userUpdateResponse = mapper.readValue(jsonResponse, UserUpdateResponse.class);

		System.out.println(userUpdateResponse.getResponseCode());
		System.out.println(userUpdateResponse.getResponseMessage());
	}

	private class UserUpdateRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserUpdateResponse extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4231`	`user does not exist`
`4240`	`user does not exist, use practice methods instead`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4092`	`record currently locked`

UserUpdate/1.1 /io/UserUpdate/1.1

Updates the user with the userId passed into auth.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the user's address

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Parameter	Type	Description
userId	String	The user ID to be associated to this new or updated user for Application Authorization. Max length 255 characters.
emrUserId	String	If EHR user ID submitted in "emrUserId" does not exist yet, a new EHR user will be created with the information that is sent in this API call. If EHR user ID submitted in "emrUserId" does exist, we will associate the information sent in this API call to the existing EHR user, but we will not update the content of the existing EHR user. If the desired result it to update the content of the existing EHR user, a separate call will need to be made to "EhrUsersSync". Documentation for "EhrUsersSync" can be found on the Integration Actions section of the Updox Interactive API page. Max length 255 characters.
loginId	String	The login ID to be used for this user for Individual Authorization or logging into the full Updox product. Must contain only printable, non-whitespace characters in the Latin-1 character set. Max length 100 characters.
loginPassword	String	The login password to be used for this user for Individual Authorization or logging into the full Updox product. Max length 100 characters.
firstName	String	Max length 50 characters. This is required.
middleName	String	Max length 50 characters.
lastName	String	Max length 50 characters. This is required.
address1	String	Max length 100 characters.
address2	String	Max length 100 characters.
city	String	Max length 50 characters.
state	String	The user's 2 character state/province code. The state/province code must be valid for the provided 'country' field. If 'country' is not provided, only American or US Territorial state codes are accepted. "US" and US territory state codes: "AL" - Alabama "AK" - Alaska "AS" - American Samoa "AZ" - Arizona "AR" - Arkansas "CA" - California "CO" - Colorado "CT" - Connecticut "DE" - Delaware "DC" - District of Columbia "FM" - Federated States of Micronesia "FL" - Florida "GA" - Georgia "GU" - Guam "HI" - Hawaii "ID" - Idaho "IL" - Illinois "IN" - Indiana "IA" - Iowa "KS" - Kansas "KY" - Kentucky "LA" - Louisiana "ME" - Maine "MH" - Marshall Islands "MD" - Maryland "MA" - Massachusetts "MI" - Michigan "MN" - Minnesota "UM" - U.S. Minor Outlying Islands "MS" - Mississippi "MO" - Missouri "MT" - Montana "NE" - Nebraska "NV" - Nevada "NH" - New Hampshire "NJ" - New Jersey "NM" - New Mexico "NY" - New York "NC" - North Carolina "ND" - North Dakota "MP" - Northern Mariana Islands "OH" - Ohio "OK" - Oklahoma "OR" - Oregon "PW" - Palau "PA" - Pennsylvania "PR" - Puerto Rico "RI" - Rhode Island "SC" - South Carolina "SD" - South Dakota "TN" - Tennessee "TX" - Texas "UT" - Utah "VT" - Vermont "VI" - Virgin Islands "VA" - Virginia "WA" - Washington "WV" - West Virginia "WI" - Wisconsin "WY" - Wyoming "CA" province codes: "AB" - Alberta "BC" - British Columbia "MB" - Manitoba "NB" - New Brunswick "NL" - Newfoundland and Labrador "NT" - Northwest Territories "NS" - Nova Scotia "NU" - Nunavut "ON" - Ontario "PE" - Prince Edward Island "QC" - Quebec "SK" - Saskatchewan "YT" - Yukon . The value must contain exactly 2 characters.
postal	String	The user's valid postal code based on the country: If "US" - The ZIP 5 postal code (ex: "43017") If "US" - Supported formats: ZIP 5 postal code (ex: "43017") ZIP 9 postal code (ex: "43017-1234" or "430171234") If "CA" - The Canadian postal code with the space (ex: "H0H 0H0") If other - Treated as a "US" postal code . Min length 5 characters. Max length 15 characters.
country	String	The account's 2 digit country code from ISO 3166 Country Codes Alpha-2. "US" - United States of America "AS" - American Samoa "CA" - Canada (Only with special Updox agreements) "FM" - Federated States of Micronesia "GU" - Guam "MH" - Marshall Islands "MP" - Northern Mariana Islands "PR" - Puerto Rico "PW" - Palau "VI" - U.S. Virgin Islands "UM" - U.S. Minor Outlying Islands Note on US territories: When in doubt please use "US". .
timeZone	String	Default: Zulu. Valid values: America/New_York, America/Los_Angeles, America/Denver, America/Chicago, America/Phoenix, Zulu, America/Puerto_Rico, America/Anchorage, Pacific/Honolulu, Pacific/Guam, Pacific/Samoa. Max length 100 characters.
active	Boolean	True if active. If false, this user will fail authorization. This is required.
provider	Boolean	If the user is a provider with an NPI, this should be `true`. Usage of this depends on how the partner's integration strategy is configured.
admin	Boolean	If `true`, gives the user who is being saved access to the admin menu within the Updox Inbox (Login ID/Password or SSO required).
directAddress	String	The direct address associated with this account. Direct messages sent to and from this user will be sent to and from this address. This field can be of the form `username@directdomain.com` where directdomain.com must be the domain configured for this account, or it can just be `username`. Max length 255 characters.
npi	String	National Provider Identifier. Max length 10 characters.
providerTaxonomyCode	String	Taxonomy Code. Max length 10 characters.
metadata	String	The metadata associated with this account. Used for vendor information only.

Try it! Toggle Notes/Code Samples

UserUpdate/1.1

Updates the user with the userId passed into auth.

Changes from v1.0 to v1.1:

country - Added optional field which collects the country code for the user's address

September 2024:

searchOptOut - This value has been removed from the API documentation as Updox no longer supports opting out of the Provider Directory. It is now mandatory for all users with a direct address to be published in the DirectTrust federated directory. If submitted, the value will be ignored.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_UserUpdate1_1 {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_UserUpdate1_1 codeSample = new UpdoxCodeSample_UserUpdate1_1();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "UserUpdate1_1";
			UserUpdate1_1Request userUpdate1_1Request = new UserUpdate1_1Request();

			//set up credentials
			userUpdate1_1Request.auth.applicationId = "applicationId";
			userUpdate1_1Request.auth.applicationPassword = "applicationPassword";
			userUpdate1_1Request.auth.accountId = "accountId";

			//set up request specific parameters
			userUpdate1_1Request.userId = "userId";
			userUpdate1_1Request.emrUserId = "emrUserId";
			userUpdate1_1Request.loginId = "loginId";
			userUpdate1_1Request.loginPassword = "loginPassword";
			userUpdate1_1Request.firstName = "firstName";
			userUpdate1_1Request.middleName = "middleName";
			userUpdate1_1Request.lastName = "lastName";
			userUpdate1_1Request.address1 = "address1";
			userUpdate1_1Request.address2 = "address2";
			userUpdate1_1Request.city = "Dublin";
			userUpdate1_1Request.state = "OH";
			userUpdate1_1Request.postal = "postal";
			userUpdate1_1Request.country = "country";
			userUpdate1_1Request.timeZone = "timeZone";
			userUpdate1_1Request.active = true;
			userUpdate1_1Request.provider = true;
			userUpdate1_1Request.admin = true;
			userUpdate1_1Request.directAddress = "directAddress";
			userUpdate1_1Request.npi = "npi";
			userUpdate1_1Request.providerTaxonomyCode = "providerTaxonomyCode";
			userUpdate1_1Request.metadata = "metadata";

			//create the request
			string json = Utilities.buildRequestJson(userUpdate1_1Request);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "UserUpdate/1.1", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			UserUpdate1_1Response userUpdate1_1Response = javascriptSerializer.Deserialize<UserUpdate1_1Response>(jsonResponse);

			Console.WriteLine(userUpdate1_1Response.responseCode);
			Console.WriteLine(userUpdate1_1Response.responseMessage);

			Environment.Exit (0);
		}


		public class UserUpdate1_1Request : UpdoxRequest {
			public string userId { get; set;}
			public string emrUserId { get; set;}
			public string loginId { get; set;}
			public string loginPassword { get; set;}
			public string firstName { get; set;}
			public string middleName { get; set;}
			public string lastName { get; set;}
			public string address1 { get; set;}
			public string address2 { get; set;}
			public string city { get; set;}
			public string state { get; set;}
			public string postal { get; set;}
			public string country { get; set;}
			public string timeZone { get; set;}
			public bool active { get; set;}
			public bool provider { get; set;}
			public bool admin { get; set;}
			public string directAddress { get; set;}
			public string npi { get; set;}
			public string providerTaxonomyCode { get; set;}
			public string metadata { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class UserUpdate1_1Response : UpdoxResponse {
			public string userId { get; set;}
			public string action { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_UserUpdate1_1 {

	public static void main(String[] args) {
		UpdoxCodeSample_UserUpdate1_1 codeSample = new UpdoxCodeSample_UserUpdate1_1();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "UserUpdate1_1";

		UserUpdate1_1Request userUpdate1_1Request = new UserUpdate1_1Request();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = userUpdate1_1Request.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		userUpdate1_1Request.setUserId("userId");
		userUpdate1_1Request.setEmrUserId("emrUserId");
		userUpdate1_1Request.setLoginId("loginId");
		userUpdate1_1Request.setLoginPassword("loginPassword");
		userUpdate1_1Request.setFirstName("firstName");
		userUpdate1_1Request.setMiddleName("middleName");
		userUpdate1_1Request.setLastName("lastName");
		userUpdate1_1Request.setAddress1("address1");
		userUpdate1_1Request.setAddress2("address2");
		userUpdate1_1Request.setCity("Dublin");
		userUpdate1_1Request.setState("OH");
		userUpdate1_1Request.setPostal("postal");
		userUpdate1_1Request.setCountry("country");
		userUpdate1_1Request.setTimeZone("timeZone");
		userUpdate1_1Request.setActive(true);
		userUpdate1_1Request.setProvider(true);
		userUpdate1_1Request.setAdmin(true);
		userUpdate1_1Request.setDirectAddress("directAddress");
		userUpdate1_1Request.setNpi("npi");
		userUpdate1_1Request.setProviderTaxonomyCode("providerTaxonomyCode");
		userUpdate1_1Request.setMetadata("metadata");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(userUpdate1_1Request);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'UserUpdate/1.1', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		UserUpdate1_1Response userUpdate1_1Response = mapper.readValue(jsonResponse, UserUpdate1_1Response.class);

		System.out.println(userUpdate1_1Response.getResponseCode());
		System.out.println(userUpdate1_1Response.getResponseMessage());
	}

	private class UserUpdate1_1Request extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;
    	private String emrUserId;
    	private String loginId;
    	private String loginPassword;
    	private String firstName;
    	private String middleName;
    	private String lastName;
    	private String address1;
    	private String address2;
    	private String city;
    	private String state;
    	private String postal;
    	private String country;
    	private String timeZone;
    	private boolean active;
    	private boolean provider;
    	private boolean admin;
    	private String directAddress;
    	private String npi;
    	private String providerTaxonomyCode;
    	private String metadata;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getEmrUserId() {
			return emrUserId;
		}

		public void setEmrUserId(String emrUserId) {
			this.emrUserId = emrUserId;
		}

		public String getLoginId() {
			return loginId;
		}

		public void setLoginId(String loginId) {
			this.loginId = loginId;
		}

		public String getLoginPassword() {
			return loginPassword;
		}

		public void setLoginPassword(String loginPassword) {
			this.loginPassword = loginPassword;
		}

		public String getFirstName() {
			return firstName;
		}

		public void setFirstName(String firstName) {
			this.firstName = firstName;
		}

		public String getMiddleName() {
			return middleName;
		}

		public void setMiddleName(String middleName) {
			this.middleName = middleName;
		}

		public String getLastName() {
			return lastName;
		}

		public void setLastName(String lastName) {
			this.lastName = lastName;
		}

		public String getAddress1() {
			return address1;
		}

		public void setAddress1(String address1) {
			this.address1 = address1;
		}

		public String getAddress2() {
			return address2;
		}

		public void setAddress2(String address2) {
			this.address2 = address2;
		}

		public String getCity() {
			return city;
		}

		public void setCity(String city) {
			this.city = city;
		}

		public String getState() {
			return state;
		}

		public void setState(String state) {
			this.state = state;
		}

		public String getPostal() {
			return postal;
		}

		public void setPostal(String postal) {
			this.postal = postal;
		}

		public String getCountry() {
			return country;
		}

		public void setCountry(String country) {
			this.country = country;
		}

		public String getTimeZone() {
			return timeZone;
		}

		public void setTimeZone(String timeZone) {
			this.timeZone = timeZone;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public boolean isProvider() {
			return provider;
		}

		public void setProvider(boolean provider) {
			this.provider = provider;
		}

		public boolean isAdmin() {
			return admin;
		}

		public void setAdmin(boolean admin) {
			this.admin = admin;
		}

		public String getDirectAddress() {
			return directAddress;
		}

		public void setDirectAddress(String directAddress) {
			this.directAddress = directAddress;
		}

		public String getNpi() {
			return npi;
		}

		public void setNpi(String npi) {
			this.npi = npi;
		}

		public String getProviderTaxonomyCode() {
			return providerTaxonomyCode;
		}

		public void setProviderTaxonomyCode(String providerTaxonomyCode) {
			this.providerTaxonomyCode = providerTaxonomyCode;
		}

		public String getMetadata() {
			return metadata;
		}

		public void setMetadata(String metadata) {
			this.metadata = metadata;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class UserUpdate1_1Response extends UpdoxResponse {
		private String userId;
		private String action;


		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}

		public String getAction() {
			return action;
		}

		public void setAction(String action) {
			this.action = action;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4231`	`user does not exist`
`4240`	`user does not exist, use practice methods instead`
`4610`	`direct address error: direct address is taken`
`4630`	`direct address error: account does not have a direct domain configured`
`4251`	`invalid NPI`
`4252`	`invalid taxonomy code`
`4230`	`user already exists`
`4012`	`authenticating user must be an admin`
`4092`	`record currently locked`

VideoCallActions

RetrieveCallIds /io/video/RetrieveCallIds

Obtain the Call IDs of completed video chats for a specified time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime

The response will include a list of callIds within the timeframe specified by the request parameters. The callId can be used for the RetrieveCallMetrics API to retrieve the video chat metric data.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
fromDatetime	String		The call start date/time to search from, format is ISO-8601. This is required.
toDatetime	String		The call start date/time to search to, format is ISO-8601. This is required.

Try it! Toggle Notes/Code Samples

RetrieveCallIds

Obtain the Call IDs of completed video chats for a specified time range.

Please note that a maximum of 7 days can be specified for the timeframe between the fromDatetime and toDatetime

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrieveCallIds {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrieveCallIds codeSample = new UpdoxCodeSample_VideoRetrieveCallIds();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrieveCallIds";
			VideoRetrieveCallIdsRequest videoRetrieveCallIdsRequest = new VideoRetrieveCallIdsRequest();

			//set up credentials
			videoRetrieveCallIdsRequest.auth.applicationId = "applicationId";
			videoRetrieveCallIdsRequest.auth.applicationPassword = "applicationPassword";
			videoRetrieveCallIdsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			videoRetrieveCallIdsRequest.fromDatetime = "fromDatetime";
			videoRetrieveCallIdsRequest.toDatetime = "toDatetime";

			//create the request
			string json = Utilities.buildRequestJson(videoRetrieveCallIdsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrieveCallIds", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrieveCallIdsResponse videoRetrieveCallIdsResponse = javascriptSerializer.Deserialize<VideoRetrieveCallIdsResponse>(jsonResponse);

			Console.WriteLine(videoRetrieveCallIdsResponse.responseCode);
			Console.WriteLine(videoRetrieveCallIdsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrieveCallIdsRequest : UpdoxRequest {
			public string fromDatetime { get; set;}
			public string toDatetime { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class VideoRetrieveCallIdsResponse : UpdoxResponse {
			public List<string> callIds { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VideoRetrieveCallIds {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrieveCallIds codeSample = new UpdoxCodeSample_VideoRetrieveCallIds();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrieveCallIds";

		VideoRetrieveCallIdsRequest videoRetrieveCallIdsRequest = new VideoRetrieveCallIdsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrieveCallIdsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		videoRetrieveCallIdsRequest.setFromDatetime("fromDatetime");
		videoRetrieveCallIdsRequest.setToDatetime("toDatetime");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrieveCallIdsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrieveCallIds', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrieveCallIdsResponse videoRetrieveCallIdsResponse = mapper.readValue(jsonResponse, VideoRetrieveCallIdsResponse.class);

		System.out.println(videoRetrieveCallIdsResponse.getResponseCode());
		System.out.println(videoRetrieveCallIdsResponse.getResponseMessage());
	}

	private class VideoRetrieveCallIdsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String fromDatetime;
    	private String toDatetime;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getFromDatetime() {
			return fromDatetime;
		}

		public void setFromDatetime(String fromDatetime) {
			this.fromDatetime = fromDatetime;
		}

		public String getToDatetime() {
			return toDatetime;
		}

		public void setToDatetime(String toDatetime) {
			this.toDatetime = toDatetime;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class VideoRetrieveCallIdsResponse extends UpdoxResponse {
		private List<String> callIds;


		public List<String> getCallIds() {
			return callIds;
		}

		public void setCallIds(List<String> callIds) {
			this.callIds = callIds;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveCallMetrics /io/video/RetrieveCallMetrics

Retrieve the video call metric details of completed calls, generally utilized for billing purposes.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
callId	String		The video call for which to retrieve metrics. This is required.

Try it! Toggle Notes/Code Samples

RetrieveCallMetrics

Retrieve the video call metric details of completed calls, generally utilized for billing purposes.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrieveCallMetrics {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrieveCallMetrics codeSample = new UpdoxCodeSample_VideoRetrieveCallMetrics();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrieveCallMetrics";
			VideoRetrieveCallMetricsRequest videoRetrieveCallMetricsRequest = new VideoRetrieveCallMetricsRequest();

			//set up credentials
			videoRetrieveCallMetricsRequest.auth.applicationId = "applicationId";
			videoRetrieveCallMetricsRequest.auth.applicationPassword = "applicationPassword";
			videoRetrieveCallMetricsRequest.auth.accountId = "accountId";

			//set up request specific parameters
			videoRetrieveCallMetricsRequest.callId = "callId";

			//create the request
			string json = Utilities.buildRequestJson(videoRetrieveCallMetricsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrieveCallMetrics", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrieveCallMetricsResponse videoRetrieveCallMetricsResponse = javascriptSerializer.Deserialize<VideoRetrieveCallMetricsResponse>(jsonResponse);

			Console.WriteLine(videoRetrieveCallMetricsResponse.responseCode);
			Console.WriteLine(videoRetrieveCallMetricsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrieveCallMetricsRequest : UpdoxRequest {
			public string callId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveCallMetricsHost {
			public string id { get; set;}
			public string hostName { get; set;}
		}

		public class RetrieveCallMetricsParticipant {
			public string id { get; set;}
			public string category { get; set;}
			public string name { get; set;}
			public Instant earliestJoinedAt { get; set;}
			public long durationInSeconds { get; set;}
		}

		public class VideoRetrieveCallMetricsResponse : UpdoxResponse {
			public Instant startedAt { get; set;}
			public Instant endedAt { get; set;}
			public long durationInSeconds { get; set;}
			public RetrieveCallMetricsHost host { get; set;}
			public List<RetrieveCallMetricsParticipant> participants { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VideoRetrieveCallMetrics {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrieveCallMetrics codeSample = new UpdoxCodeSample_VideoRetrieveCallMetrics();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrieveCallMetrics";

		VideoRetrieveCallMetricsRequest videoRetrieveCallMetricsRequest = new VideoRetrieveCallMetricsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrieveCallMetricsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		videoRetrieveCallMetricsRequest.setCallId("callId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrieveCallMetricsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrieveCallMetrics', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrieveCallMetricsResponse videoRetrieveCallMetricsResponse = mapper.readValue(jsonResponse, VideoRetrieveCallMetricsResponse.class);

		System.out.println(videoRetrieveCallMetricsResponse.getResponseCode());
		System.out.println(videoRetrieveCallMetricsResponse.getResponseMessage());
	}

	private class VideoRetrieveCallMetricsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String callId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getCallId() {
			return callId;
		}

		public void setCallId(String callId) {
			this.callId = callId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetrieveCallMetricsHost {
		private String id;
		private String hostName;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getHostName() {
			return hostName;
		}

		public void setHostName(String hostName) {
			this.hostName = hostName;
		}
	}

	private static class RetrieveCallMetricsParticipant {
		private String id;
		private String category;
		private String name;
		private Instant earliestJoinedAt;
		private Long durationInSeconds;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public Instant getEarliestJoinedAt() {
			return earliestJoinedAt;
		}

		public void setEarliestJoinedAt(Instant earliestJoinedAt) {
			this.earliestJoinedAt = earliestJoinedAt;
		}

		public Long getDurationInSeconds() {
			return durationInSeconds;
		}

		public void setDurationInSeconds(Long durationInSeconds) {
			this.durationInSeconds = durationInSeconds;
		}
	}

	private static class VideoRetrieveCallMetricsResponse extends UpdoxResponse {
		private Instant startedAt;
		private Instant endedAt;
		private Long durationInSeconds;
		private RetrieveCallMetricsHost host;
		private List<RetrieveCallMetricsParticipant> participants;


		public Instant getStartedAt() {
			return startedAt;
		}

		public void setStartedAt(Instant startedAt) {
			this.startedAt = startedAt;
		}

		public Instant getEndedAt() {
			return endedAt;
		}

		public void setEndedAt(Instant endedAt) {
			this.endedAt = endedAt;
		}

		public Long getDurationInSeconds() {
			return durationInSeconds;
		}

		public void setDurationInSeconds(Long durationInSeconds) {
			this.durationInSeconds = durationInSeconds;
		}

		public RetrieveCallMetricsHost getHost() {
			return host;
		}

		public void setHost(RetrieveCallMetricsHost host) {
			this.host = host;
		}

		public List<RetrieveCallMetricsParticipant> getParticipants() {
			return participants;
		}

		public void setParticipants(List<RetrieveCallMetricsParticipant> participants) {
			this.participants = participants;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`4094`	`record does not exist`
`4095`	`record invalid for action`

RetrieveCallSummaryDetails /io/video/RetrieveCallSummaryDetails

Retrieve the summary details of completed calls including the start date time, host information, participant information, notes, and attachmentIds.

Use the summaryId and attachmentId to retrieve the call summary attachments via the RetrieveCallSummaryAttachments API.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
summaryId	String		The unique identifier of the video call summary. This is required.

Try it! Toggle Notes/Code Samples

RetrieveCallSummaryDetails

Retrieve the summary details of completed calls including the start date time, host information, participant information, notes, and attachmentIds.

Use the summaryId and attachmentId to retrieve the call summary attachments via the RetrieveCallSummaryAttachments API.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrieveCallSummaryDetails {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrieveCallSummaryDetails codeSample = new UpdoxCodeSample_VideoRetrieveCallSummaryDetails();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrieveCallSummaryDetails";
			VideoRetrieveCallSummaryDetailsRequest videoRetrieveCallSummaryDetailsRequest = new VideoRetrieveCallSummaryDetailsRequest();

			//set up credentials
			videoRetrieveCallSummaryDetailsRequest.auth.applicationId = "applicationId";
			videoRetrieveCallSummaryDetailsRequest.auth.applicationPassword = "applicationPassword";
			videoRetrieveCallSummaryDetailsRequest.auth.accountId = "accountId";
			videoRetrieveCallSummaryDetailsRequest.auth.userId = "userId";

			//set up request specific parameters
			videoRetrieveCallSummaryDetailsRequest.summaryId = "summaryId";

			//create the request
			string json = Utilities.buildRequestJson(videoRetrieveCallSummaryDetailsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrieveCallSummaryDetails", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrieveCallSummaryDetailsResponse videoRetrieveCallSummaryDetailsResponse = javascriptSerializer.Deserialize<VideoRetrieveCallSummaryDetailsResponse>(jsonResponse);

			Console.WriteLine(videoRetrieveCallSummaryDetailsResponse.responseCode);
			Console.WriteLine(videoRetrieveCallSummaryDetailsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrieveCallSummaryDetailsRequest : UpdoxRequest {
			public string summaryId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetrieveCallSummaryDetailsHost {
			public string id { get; set;}
			public string hostName { get; set;}
		}

		public class RetrieveCallSummaryDetailsParticipant {
			public string id { get; set;}
			public string name { get; set;}
			public string category { get; set;}
		}

		public class RetrieveCallSummaryDetailsAttachment {
			public string id { get; set;}
			public string mimeType { get; set;}
			public string fileName { get; set;}
		}

		public class VideoRetrieveCallSummaryDetailsResponse : UpdoxResponse {
			public Instant startedAt { get; set;}
			public long durationInSeconds { get; set;}
			public RetrieveCallSummaryDetailsHost host { get; set;}
			public List<RetrieveCallSummaryDetailsParticipant> participants { get; set;}
			public List<string> notes { get; set;}
			public List<RetrieveCallSummaryDetailsAttachment> attachments { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VideoRetrieveCallSummaryDetails {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrieveCallSummaryDetails codeSample = new UpdoxCodeSample_VideoRetrieveCallSummaryDetails();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrieveCallSummaryDetails";

		VideoRetrieveCallSummaryDetailsRequest videoRetrieveCallSummaryDetailsRequest = new VideoRetrieveCallSummaryDetailsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrieveCallSummaryDetailsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		videoRetrieveCallSummaryDetailsRequest.setSummaryId("summaryId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrieveCallSummaryDetailsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrieveCallSummaryDetails', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrieveCallSummaryDetailsResponse videoRetrieveCallSummaryDetailsResponse = mapper.readValue(jsonResponse, VideoRetrieveCallSummaryDetailsResponse.class);

		System.out.println(videoRetrieveCallSummaryDetailsResponse.getResponseCode());
		System.out.println(videoRetrieveCallSummaryDetailsResponse.getResponseMessage());
	}

	private class VideoRetrieveCallSummaryDetailsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String summaryId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getSummaryId() {
			return summaryId;
		}

		public void setSummaryId(String summaryId) {
			this.summaryId = summaryId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class RetrieveCallSummaryDetailsHost {
		private String id;
		private String hostName;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getHostName() {
			return hostName;
		}

		public void setHostName(String hostName) {
			this.hostName = hostName;
		}
	}

	private static class RetrieveCallSummaryDetailsParticipant {
		private String id;
		private String name;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			this.name = name;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private static class RetrieveCallSummaryDetailsAttachment {
		private String id;
		private String mimeType;
		private String fileName;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}
	}

	private static class VideoRetrieveCallSummaryDetailsResponse extends UpdoxResponse {
		private Instant startedAt;
		private Long durationInSeconds;
		private RetrieveCallSummaryDetailsHost host;
		private List<RetrieveCallSummaryDetailsParticipant> participants;
		private List<String> notes;
		private List<RetrieveCallSummaryDetailsAttachment> attachments;


		public Instant getStartedAt() {
			return startedAt;
		}

		public void setStartedAt(Instant startedAt) {
			this.startedAt = startedAt;
		}

		public Long getDurationInSeconds() {
			return durationInSeconds;
		}

		public void setDurationInSeconds(Long durationInSeconds) {
			this.durationInSeconds = durationInSeconds;
		}

		public RetrieveCallSummaryDetailsHost getHost() {
			return host;
		}

		public void setHost(RetrieveCallSummaryDetailsHost host) {
			this.host = host;
		}

		public List<RetrieveCallSummaryDetailsParticipant> getParticipants() {
			return participants;
		}

		public void setParticipants(List<RetrieveCallSummaryDetailsParticipant> participants) {
			this.participants = participants;
		}

		public List<String> getNotes() {
			return notes;
		}

		public void setNotes(List<String> notes) {
			this.notes = notes;
		}

		public List<RetrieveCallSummaryDetailsAttachment> getAttachments() {
			return attachments;
		}

		public void setAttachments(List<RetrieveCallSummaryDetailsAttachment> attachments) {
			this.attachments = attachments;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`4094`	`record does not exist`
`4095`	`record invalid for action`

RetrieveCallSummaryAttachments /io/video/RetrieveCallSummaryAttachments

Retrieve the content and metadata of a call attachment. The returned content is Base64 URL-encoded with padding.

Please note that attachmentIds can be retrieved via the RetrieveCallSummaryDetails API.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
summaryId	String		The summary id which owns the attachment. This is required.
attachmentId	String		The attachment id of the attachment is loaded. This is required.

Try it! Toggle Notes/Code Samples

RetrieveCallSummaryAttachments

Retrieve the content and metadata of a call attachment. The returned content is Base64 URL-encoded with padding.

Please note that attachmentIds can be retrieved via the RetrieveCallSummaryDetails API.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account",
		"userId": "user"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrieveCallSummaryAttachments {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrieveCallSummaryAttachments codeSample = new UpdoxCodeSample_VideoRetrieveCallSummaryAttachments();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrieveCallSummaryAttachments";
			VideoRetrieveCallSummaryAttachmentsRequest videoRetrieveCallSummaryAttachmentsRequest = new VideoRetrieveCallSummaryAttachmentsRequest();

			//set up credentials
			videoRetrieveCallSummaryAttachmentsRequest.auth.applicationId = "applicationId";
			videoRetrieveCallSummaryAttachmentsRequest.auth.applicationPassword = "applicationPassword";
			videoRetrieveCallSummaryAttachmentsRequest.auth.accountId = "accountId";
			videoRetrieveCallSummaryAttachmentsRequest.auth.userId = "userId";

			//set up request specific parameters
			videoRetrieveCallSummaryAttachmentsRequest.summaryId = "summaryId";
			videoRetrieveCallSummaryAttachmentsRequest.attachmentId = "attachmentId";

			//create the request
			string json = Utilities.buildRequestJson(videoRetrieveCallSummaryAttachmentsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrieveCallSummaryAttachments", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrieveCallSummaryAttachmentsResponse videoRetrieveCallSummaryAttachmentsResponse = javascriptSerializer.Deserialize<VideoRetrieveCallSummaryAttachmentsResponse>(jsonResponse);

			Console.WriteLine(videoRetrieveCallSummaryAttachmentsResponse.responseCode);
			Console.WriteLine(videoRetrieveCallSummaryAttachmentsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrieveCallSummaryAttachmentsRequest : UpdoxRequest {
			public string summaryId { get; set;}
			public string attachmentId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class VideoRetrieveCallSummaryAttachmentsResponse : UpdoxResponse {
			public string id { get; set;}
			public string content { get; set;}
			public string filename { get; set;}
			public string mimeType { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_VideoRetrieveCallSummaryAttachments {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrieveCallSummaryAttachments codeSample = new UpdoxCodeSample_VideoRetrieveCallSummaryAttachments();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrieveCallSummaryAttachments";

		VideoRetrieveCallSummaryAttachmentsRequest videoRetrieveCallSummaryAttachmentsRequest = new VideoRetrieveCallSummaryAttachmentsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrieveCallSummaryAttachmentsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");
		auth.setUserId("userId");

		videoRetrieveCallSummaryAttachmentsRequest.setSummaryId("summaryId");
		videoRetrieveCallSummaryAttachmentsRequest.setAttachmentId("attachmentId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrieveCallSummaryAttachmentsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrieveCallSummaryAttachments', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrieveCallSummaryAttachmentsResponse videoRetrieveCallSummaryAttachmentsResponse = mapper.readValue(jsonResponse, VideoRetrieveCallSummaryAttachmentsResponse.class);

		System.out.println(videoRetrieveCallSummaryAttachmentsResponse.getResponseCode());
		System.out.println(videoRetrieveCallSummaryAttachmentsResponse.getResponseMessage());
	}

	private class VideoRetrieveCallSummaryAttachmentsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String summaryId;
    	private String attachmentId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getSummaryId() {
			return summaryId;
		}

		public void setSummaryId(String summaryId) {
			this.summaryId = summaryId;
		}

		public String getAttachmentId() {
			return attachmentId;
		}

		public void setAttachmentId(String attachmentId) {
			this.attachmentId = attachmentId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;
		private String userId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private static class VideoRetrieveCallSummaryAttachmentsResponse extends UpdoxResponse {
		private String id;
		private String content;
		private String filename;
		private String mimeType;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getContent() {
			return content;
		}

		public void setContent(String content) {
			this.content = content;
		}

		public String getFilename() {
			return filename;
		}

		public void setFilename(String filename) {
			this.filename = filename;
		}

		public String getMimeType() {
			return mimeType;
		}

		public void setMimeType(String mimeType) {
			this.mimeType = mimeType;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`
`4094`	`record does not exist`
`4095`	`record invalid for action`

RetrievePublicWaitingRooms /io/video/RetrievePublicWaitingRooms

Retrieve a list of all active public video chat waiting rooms for a specific account.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Try it! Toggle Notes/Code Samples

RetrievePublicWaitingRooms

Retrieve a list of all active public video chat waiting rooms for a specific account.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrievePublicWaitingRooms {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrievePublicWaitingRooms codeSample = new UpdoxCodeSample_VideoRetrievePublicWaitingRooms();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrievePublicWaitingRooms";
			VideoRetrievePublicWaitingRoomsRequest videoRetrievePublicWaitingRoomsRequest = new VideoRetrievePublicWaitingRoomsRequest();

			//set up credentials
			videoRetrievePublicWaitingRoomsRequest.auth.applicationId = "applicationId";
			videoRetrievePublicWaitingRoomsRequest.auth.applicationPassword = "applicationPassword";
			videoRetrievePublicWaitingRoomsRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(videoRetrievePublicWaitingRoomsRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrievePublicWaitingRooms", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrievePublicWaitingRoomsResponse videoRetrievePublicWaitingRoomsResponse = javascriptSerializer.Deserialize<VideoRetrievePublicWaitingRoomsResponse>(jsonResponse);

			Console.WriteLine(videoRetrievePublicWaitingRoomsResponse.responseCode);
			Console.WriteLine(videoRetrievePublicWaitingRoomsResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrievePublicWaitingRoomsRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class ExpiringPublicUrl {
			public string url { get; set;}
			public Instant expiresAt { get; set;}
		}

		public class WaitingRoom {
			public string waitingRoomId { get; set;}
			public string waitingRoomDisplayName { get; set;}
			public string ownerId { get; set;}
			public string publicUrl { get; set;}
			public List<ExpiringPublicUrl> expiringPublicUrls { get; set;}
		}

		public class VideoRetrievePublicWaitingRoomsResponse : UpdoxResponse {
			public List<WaitingRoom> publicWaitingRooms { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VideoRetrievePublicWaitingRooms {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrievePublicWaitingRooms codeSample = new UpdoxCodeSample_VideoRetrievePublicWaitingRooms();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrievePublicWaitingRooms";

		VideoRetrievePublicWaitingRoomsRequest videoRetrievePublicWaitingRoomsRequest = new VideoRetrievePublicWaitingRoomsRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrievePublicWaitingRoomsRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrievePublicWaitingRoomsRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrievePublicWaitingRooms', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrievePublicWaitingRoomsResponse videoRetrievePublicWaitingRoomsResponse = mapper.readValue(jsonResponse, VideoRetrievePublicWaitingRoomsResponse.class);

		System.out.println(videoRetrievePublicWaitingRoomsResponse.getResponseCode());
		System.out.println(videoRetrievePublicWaitingRoomsResponse.getResponseMessage());
	}

	private class VideoRetrievePublicWaitingRoomsRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class ExpiringPublicUrl {
		private String url;
		private Instant expiresAt;


		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public Instant getExpiresAt() {
			return expiresAt;
		}

		public void setExpiresAt(Instant expiresAt) {
			this.expiresAt = expiresAt;
		}
	}

	private static class WaitingRoom {
		private String waitingRoomId;
		private String waitingRoomDisplayName;
		private String ownerId;
		private String publicUrl;
		private List<ExpiringPublicUrl> expiringPublicUrls;


		public String getWaitingRoomId() {
			return waitingRoomId;
		}

		public void setWaitingRoomId(String waitingRoomId) {
			this.waitingRoomId = waitingRoomId;
		}

		public String getWaitingRoomDisplayName() {
			return waitingRoomDisplayName;
		}

		public void setWaitingRoomDisplayName(String waitingRoomDisplayName) {
			this.waitingRoomDisplayName = waitingRoomDisplayName;
		}

		public String getOwnerId() {
			return ownerId;
		}

		public void setOwnerId(String ownerId) {
			this.ownerId = ownerId;
		}

		public String getPublicUrl() {
			return publicUrl;
		}

		public void setPublicUrl(String publicUrl) {
			this.publicUrl = publicUrl;
		}

		public List<ExpiringPublicUrl> getExpiringPublicUrls() {
			return expiringPublicUrls;
		}

		public void setExpiringPublicUrls(List<ExpiringPublicUrl> expiringPublicUrls) {
			this.expiringPublicUrls = expiringPublicUrls;
		}
	}

	private static class VideoRetrievePublicWaitingRoomsResponse extends UpdoxResponse {
		private List<WaitingRoom> publicWaitingRooms;


		public List<WaitingRoom> getPublicWaitingRooms() {
			return publicWaitingRooms;
		}

		public void setPublicWaitingRooms(List<WaitingRoom> publicWaitingRooms) {
			this.publicWaitingRooms = publicWaitingRooms;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

RetrieveUserDelegateAccess /io/video/RetrieveUserDelegateAccess

Retrieve a list of all waiting rooms that a user has access to.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Value	Description
userId	String		The ID of the user retrieving delegate access for. This is required.

Try it! Toggle Notes/Code Samples

RetrieveUserDelegateAccess

Retrieve a list of all waiting rooms that a user has access to.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoRetrieveUserDelegateAccess {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoRetrieveUserDelegateAccess codeSample = new UpdoxCodeSample_VideoRetrieveUserDelegateAccess();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoRetrieveUserDelegateAccess";
			VideoRetrieveUserDelegateAccessRequest videoRetrieveUserDelegateAccessRequest = new VideoRetrieveUserDelegateAccessRequest();

			//set up credentials
			videoRetrieveUserDelegateAccessRequest.auth.applicationId = "applicationId";
			videoRetrieveUserDelegateAccessRequest.auth.applicationPassword = "applicationPassword";
			videoRetrieveUserDelegateAccessRequest.auth.accountId = "accountId";

			//set up request specific parameters
			videoRetrieveUserDelegateAccessRequest.userId = "userId";

			//create the request
			string json = Utilities.buildRequestJson(videoRetrieveUserDelegateAccessRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/RetrieveUserDelegateAccess", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoRetrieveUserDelegateAccessResponse videoRetrieveUserDelegateAccessResponse = javascriptSerializer.Deserialize<VideoRetrieveUserDelegateAccessResponse>(jsonResponse);

			Console.WriteLine(videoRetrieveUserDelegateAccessResponse.responseCode);
			Console.WriteLine(videoRetrieveUserDelegateAccessResponse.responseMessage);

			Environment.Exit (0);
		}


		public class VideoRetrieveUserDelegateAccessRequest : UpdoxRequest {
			public string userId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class VideoChat2UserDelegateAccess {
			public string ownerUserId { get; set;}
			public string waitingRoomId { get; set;}
			public string waitingRoomDisplayName { get; set;}
		}

		public class VideoRetrieveUserDelegateAccessResponse : UpdoxResponse {
			public List<VideoChat2UserDelegateAccess> delegateOn { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_VideoRetrieveUserDelegateAccess {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoRetrieveUserDelegateAccess codeSample = new UpdoxCodeSample_VideoRetrieveUserDelegateAccess();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoRetrieveUserDelegateAccess";

		VideoRetrieveUserDelegateAccessRequest videoRetrieveUserDelegateAccessRequest = new VideoRetrieveUserDelegateAccessRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoRetrieveUserDelegateAccessRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		videoRetrieveUserDelegateAccessRequest.setUserId("userId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoRetrieveUserDelegateAccessRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/RetrieveUserDelegateAccess', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoRetrieveUserDelegateAccessResponse videoRetrieveUserDelegateAccessResponse = mapper.readValue(jsonResponse, VideoRetrieveUserDelegateAccessResponse.class);

		System.out.println(videoRetrieveUserDelegateAccessResponse.getResponseCode());
		System.out.println(videoRetrieveUserDelegateAccessResponse.getResponseMessage());
	}

	private class VideoRetrieveUserDelegateAccessRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String userId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getUserId() {
			return userId;
		}

		public void setUserId(String userId) {
			this.userId = userId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class VideoChat2UserDelegateAccess {
		private String ownerUserId;
		private String waitingRoomId;
		private String waitingRoomDisplayName;


		public String getOwnerUserId() {
			return ownerUserId;
		}

		public void setOwnerUserId(String ownerUserId) {
			this.ownerUserId = ownerUserId;
		}

		public String getWaitingRoomId() {
			return waitingRoomId;
		}

		public void setWaitingRoomId(String waitingRoomId) {
			this.waitingRoomId = waitingRoomId;
		}

		public String getWaitingRoomDisplayName() {
			return waitingRoomDisplayName;
		}

		public void setWaitingRoomDisplayName(String waitingRoomDisplayName) {
			this.waitingRoomDisplayName = waitingRoomDisplayName;
		}
	}

	private static class VideoRetrieveUserDelegateAccessResponse extends UpdoxResponse {
		private List<VideoChat2UserDelegateAccess> delegateOn;


		public List<VideoChat2UserDelegateAccess> getDelegateOn() {
			return delegateOn;
		}

		public void setDelegateOn(List<VideoChat2UserDelegateAccess> delegateOn) {
			this.delegateOn = delegateOn;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4015`	`Unauthorized - API not enabled for the request's access rights`

SendInvite /io/video/SendInvite

Send a Video Chat waiting room invite to an existing patient/contact via SMS or email.

Note: Video Chat links will expire 72 hours after they are created.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Parameter	Type	Description
participant		Provide the patient or contact Id of the participant you'd like to invite to the specified Video Chat Waiting Room. This is required.
id	String	Partner ID of the participant from `PatientsSync` or `ContactsSync`. This is required.
category	String	Accepted values are: `PATIENT` or `CONTACT`. This is required.
notificationMethod		Provide the method you'd like to use for the delivery of the Video Chat invitation. If using the contact information on file, there is no need to supply a phone number or email address. If alternative contact information should be used for the invitation, please specify either an SMS number or email address. This is required.
method	String	Which method of delivery the provider has selected for the video chat invite. Accepted values are: `SMS` or `EMAIL`. This is required.
altNotificationSmsNumber	String	If alternative contact information, which differs from that on file for the participant (patient/contact), should be used for the video chat invite, specify the 10-digit number to send the invite to.
altNotificationEmailAddress	String	If alternative contact information, which differs from that on file for the participant (patient/contact), should be used for the video chat invite, specify the email address to send the invite to. This will take priority over what's in the address book.
waitingRoomOwnerUserId	String	UserId of the user who owns the waiting room the participant is getting invited into. This is required.
sendingUserId	String	UserId of the user who is sending the invite. Updox will enforce delegate access permissions.

Try it! Toggle Notes/Code Samples

SendInvite

Send a Video Chat waiting room invite to an existing patient/contact via SMS or email.

Note: Video Chat links will expire 72 hours after they are created.

Note: This endpoint requires whitelisting before usage. Please contact Updox for more details if interested.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_VideoSendInvite {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_VideoSendInvite codeSample = new UpdoxCodeSample_VideoSendInvite();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "VideoSendInvite";
			VideoSendInviteRequest videoSendInviteRequest = new VideoSendInviteRequest();

			//set up credentials
			videoSendInviteRequest.auth.applicationId = "applicationId";
			videoSendInviteRequest.auth.applicationPassword = "applicationPassword";
			videoSendInviteRequest.auth.accountId = "accountId";

			//set up request specific parameters
			SendInviteParticipant participant = new SendInviteParticipant();
			participant.id = "id";
			participant.category = "category";
			videoSendInviteRequest.participant = participant;
			NotificationMethod notificationMethod = new NotificationMethod();
			notificationMethod.method = "method";
			notificationMethod.altNotificationSmsNumber = "altNotificationSmsNumber";
			notificationMethod.altNotificationEmailAddress = "test@test.com";
			videoSendInviteRequest.notificationMethod = notificationMethod;
			videoSendInviteRequest.waitingRoomOwnerUserId = "waitingRoomOwnerUserId";
			videoSendInviteRequest.sendingUserId = "sendingUserId";

			//create the request
			string json = Utilities.buildRequestJson(videoSendInviteRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "video/SendInvite", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			VideoSendInviteResponse videoSendInviteResponse = javascriptSerializer.Deserialize<VideoSendInviteResponse>(jsonResponse);

			Console.WriteLine(videoSendInviteResponse.responseCode);
			Console.WriteLine(videoSendInviteResponse.responseMessage);

			Environment.Exit (0);
		}


		public class SendInviteParticipant {
			public string id { get; set;}
			public string category { get; set;}
		}

		public class NotificationMethod {
			public string method { get; set;}
			public string altNotificationSmsNumber { get; set;}
			public string altNotificationEmailAddress { get; set;}
		}

		public class VideoSendInviteRequest : UpdoxRequest {
			public SendInviteParticipant participant { get; set;}
			public NotificationMethod notificationMethod { get; set;}
			public string waitingRoomOwnerUserId { get; set;}
			public string sendingUserId { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class FailCode {
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public class VideoSendInviteResponse : UpdoxResponse {
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;


public class UpdoxCodeSample_VideoSendInvite {

	public static void main(String[] args) {
		UpdoxCodeSample_VideoSendInvite codeSample = new UpdoxCodeSample_VideoSendInvite();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "VideoSendInvite";

		VideoSendInviteRequest videoSendInviteRequest = new VideoSendInviteRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = videoSendInviteRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		SendInviteParticipant participant = new SendInviteParticipant();
		participant.setId("id");
		participant.setCategory("category");
		videoSendInviteRequest.setParticipant(participant);
		NotificationMethod notificationMethod = new NotificationMethod();
		notificationMethod.setMethod("method");
		notificationMethod.setAltNotificationSmsNumber("altNotificationSmsNumber");
		notificationMethod.setAltNotificationEmailAddress("test@test.com");
		videoSendInviteRequest.setNotificationMethod(notificationMethod);
		videoSendInviteRequest.setWaitingRoomOwnerUserId("waitingRoomOwnerUserId");
		videoSendInviteRequest.setSendingUserId("sendingUserId");

		//create the request
		String jsonRequest = Utilities.buildRequestJson(videoSendInviteRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'video/SendInvite', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		VideoSendInviteResponse videoSendInviteResponse = mapper.readValue(jsonResponse, VideoSendInviteResponse.class);

		System.out.println(videoSendInviteResponse.getResponseCode());
		System.out.println(videoSendInviteResponse.getResponseMessage());
	}

	private static class SendInviteParticipant {
		private String id;
		private String category;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getCategory() {
			return category;
		}

		public void setCategory(String category) {
			this.category = category;
		}
	}

	private static class NotificationMethod {
		private String method;
		private String altNotificationSmsNumber;
		private String altNotificationEmailAddress;


		public String getMethod() {
			return method;
		}

		public void setMethod(String method) {
			this.method = method;
		}

		public String getAltNotificationSmsNumber() {
			return altNotificationSmsNumber;
		}

		public void setAltNotificationSmsNumber(String altNotificationSmsNumber) {
			this.altNotificationSmsNumber = altNotificationSmsNumber;
		}

		public String getAltNotificationEmailAddress() {
			return altNotificationEmailAddress;
		}

		public void setAltNotificationEmailAddress(String altNotificationEmailAddress) {
			this.altNotificationEmailAddress = altNotificationEmailAddress;
		}
	}

	private class VideoSendInviteRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private SendInviteParticipant participant;
    	private NotificationMethod notificationMethod;
    	private String waitingRoomOwnerUserId;
    	private String sendingUserId;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public SendInviteParticipant getParticipant() {
			return participant;
		}

		public void setParticipant(SendInviteParticipant participant) {
			this.participant = participant;
		}

		public NotificationMethod getNotificationMethod() {
			return notificationMethod;
		}

		public void setNotificationMethod(NotificationMethod notificationMethod) {
			this.notificationMethod = notificationMethod;
		}

		public String getWaitingRoomOwnerUserId() {
			return waitingRoomOwnerUserId;
		}

		public void setWaitingRoomOwnerUserId(String waitingRoomOwnerUserId) {
			this.waitingRoomOwnerUserId = waitingRoomOwnerUserId;
		}

		public String getSendingUserId() {
			return sendingUserId;
		}

		public void setSendingUserId(String sendingUserId) {
			this.sendingUserId = sendingUserId;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class VideoSendInviteResponse extends UpdoxResponse {
	//Nothing to add here - Response is updoxResponse
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Relevant Response Codes

In addition to the General Response Set, this method may return the following values in the responseCode and responseMessage fields:

ResponseCode	ResponseMessage
`4233`	`User Invalid Permission`
`4070`	`Invalid recipient`
`4015`	`Unauthorized - API not enabled for the request's access rights`

WebHookActions

WebHookEventList /io/WebHookEventList

List of the active events you can subscribe to. Please refer to https://help.updox.com/help/webhooks for additional documentation and code examples.

Try it! Toggle Notes/Code Samples

WebHookEventList

List of the active events you can subscribe to. Please refer to https://help.updox.com/help/webhooks for additional documentation and code examples.

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_WebHookEventList {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_WebHookEventList codeSample = new UpdoxCodeSample_WebHookEventList();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "WebHookEventList";
			WebHookEventListRequest webHookEventListRequest = new WebHookEventListRequest();

			//set up credentials
			webHookEventListRequest.auth.applicationId = "applicationId";
			webHookEventListRequest.auth.applicationPassword = "applicationPassword";
			webHookEventListRequest.auth.accountId = "accountId";

			//set up request specific parameters

			//create the request
			string json = Utilities.buildRequestJson(webHookEventListRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "WebHookEventList", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			WebHookEventListResponse webHookEventListResponse = javascriptSerializer.Deserialize<WebHookEventListResponse>(jsonResponse);

			Console.WriteLine(webHookEventListResponse.responseCode);
			Console.WriteLine(webHookEventListResponse.responseMessage);

			Environment.Exit (0);
		}


		public class WebHookEventListRequest : UpdoxRequest {
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class WebHookEvent {
			public string id { get; set;}
			public string description { get; set;}
		}

		public class WebHookEventListResponse : UpdoxResponse {
			public List<WebHookEvent> events { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_WebHookEventList {

	public static void main(String[] args) {
		UpdoxCodeSample_WebHookEventList codeSample = new UpdoxCodeSample_WebHookEventList();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "WebHookEventList";

		WebHookEventListRequest webHookEventListRequest = new WebHookEventListRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = webHookEventListRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");


		//create the request
		String jsonRequest = Utilities.buildRequestJson(webHookEventListRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'WebHookEventList', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		WebHookEventListResponse webHookEventListResponse = mapper.readValue(jsonResponse, WebHookEventListResponse.class);

		System.out.println(webHookEventListResponse.getResponseCode());
		System.out.println(webHookEventListResponse.getResponseMessage());
	}

	private class WebHookEventListRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();


		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class WebHookEvent {
		private String id;
		private String description;


		public String getId() {
			return id;
		}

		public void setId(String id) {
			this.id = id;
		}

		public String getDescription() {
			return description;
		}

		public void setDescription(String description) {
			this.description = description;
		}
	}

	private static class WebHookEventListResponse extends UpdoxResponse {
		private List<WebHookEvent> events;


		public List<WebHookEvent> getEvents() {
			return events;
		}

		public void setEvents(List<WebHookEvent> events) {
			this.events = events;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

WebHookFailuresGet /io/WebHookFailuresGet

Get failed webhook requests

Parameter	Type	Description
start	Int	Used for paging. The starting index of the failures to be returned. Default 0. The value must be between 0 and 9223372036854775807.
count	Int	The maximum number of failures to return (the page size). Default 500. The value must be between 0 and 500.
fromDate	Date	Format yyyy-mm-dd.
toDate	Date	Format yyyy-mm-dd.

Try it! Toggle Notes/Code Samples

WebHookFailuresGet

Get failed webhook requests

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_WebHookFailuresGet {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_WebHookFailuresGet codeSample = new UpdoxCodeSample_WebHookFailuresGet();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "WebHookFailuresGet";
			WebHookFailuresGetRequest webHookFailuresGetRequest = new WebHookFailuresGetRequest();

			//set up credentials
			webHookFailuresGetRequest.auth.applicationId = "applicationId";
			webHookFailuresGetRequest.auth.applicationPassword = "applicationPassword";
			webHookFailuresGetRequest.auth.accountId = "accountId";

			//set up request specific parameters
			webHookFailuresGetRequest.start = 1;
			webHookFailuresGetRequest.count = 1;
			webHookFailuresGetRequest.fromDate = "fromdate";
			webHookFailuresGetRequest.toDate = "todate";

			//create the request
			string json = Utilities.buildRequestJson(webHookFailuresGetRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "WebHookFailuresGet", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			WebHookFailuresGetResponse webHookFailuresGetResponse = javascriptSerializer.Deserialize<WebHookFailuresGetResponse>(jsonResponse);

			Console.WriteLine(webHookFailuresGetResponse.responseCode);
			Console.WriteLine(webHookFailuresGetResponse.responseMessage);

			Environment.Exit (0);
		}


		public class WebHookFailuresGetRequest : UpdoxRequest {
			public int start { get; set;}
			public int count { get; set;}
			public String fromDate { get; set;}
			public String toDate { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class WebHookFailuresGetResponse : UpdoxResponse {
			public bool moreResultsAvailable { get; set;}
			public List<long> failures { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Date;

public class UpdoxCodeSample_WebHookFailuresGet {

	public static void main(String[] args) {
		UpdoxCodeSample_WebHookFailuresGet codeSample = new UpdoxCodeSample_WebHookFailuresGet();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "WebHookFailuresGet";

		WebHookFailuresGetRequest webHookFailuresGetRequest = new WebHookFailuresGetRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = webHookFailuresGetRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		webHookFailuresGetRequest.setStart(1);
		webHookFailuresGetRequest.setCount(1);
		webHookFailuresGetRequest.setFromDate(new Date());
		webHookFailuresGetRequest.setToDate(new Date());

		//create the request
		String jsonRequest = Utilities.buildRequestJson(webHookFailuresGetRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'WebHookFailuresGet', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		WebHookFailuresGetResponse webHookFailuresGetResponse = mapper.readValue(jsonResponse, WebHookFailuresGetResponse.class);

		System.out.println(webHookFailuresGetResponse.getResponseCode());
		System.out.println(webHookFailuresGetResponse.getResponseMessage());
	}

	private class WebHookFailuresGetRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private int start;
    	private int count;
    	private Date fromDate;
    	private Date toDate;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public int getStart() {
			return start;
		}

		public void setStart(int start) {
			this.start = start;
		}

		public int getCount() {
			return count;
		}

		public void setCount(int count) {
			this.count = count;
		}

		public Date getFromDate() {
			return fromDate;
		}

		public void setFromDate(Date fromDate) {
			this.fromDate = fromDate;
		}

		public Date getToDate() {
			return toDate;
		}

		public void setToDate(Date toDate) {
			this.toDate = toDate;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class WebHookFailuresGetResponse extends UpdoxResponse {
		private boolean moreResultsAvailable;
		private List<Long> failures;


		public boolean isMoreResultsAvailable() {
			return moreResultsAvailable;
		}

		public void setMoreResultsAvailable(boolean moreResultsAvailable) {
			this.moreResultsAvailable = moreResultsAvailable;
		}

		public List<Long> getFailures() {
			return failures;
		}

		public void setFailures(List<Long> failures) {
			this.failures = failures;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

WebHookRetry /io/WebHookRetry

Retry a failed webhook

Parameter	Type	Value	Description
failures	List	add remove	The list of failed webhook attempt IDs you wish to retry. This is required.

	Long

Try it! Toggle Notes/Code Samples

WebHookRetry

Retry a failed webhook

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_WebHookRetry {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_WebHookRetry codeSample = new UpdoxCodeSample_WebHookRetry();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "WebHookRetry";
			WebHookRetryRequest webHookRetryRequest = new WebHookRetryRequest();

			//set up credentials
			webHookRetryRequest.auth.applicationId = "applicationId";
			webHookRetryRequest.auth.applicationPassword = "applicationPassword";
			webHookRetryRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<long> failures = new List<long>();
			long failuresLong = 1L;
			failures.Add(failuresLong);
			webHookRetryRequest.failures = failures;

			//create the request
			string json = Utilities.buildRequestJson(webHookRetryRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "WebHookRetry", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			WebHookRetryResponse webHookRetryResponse = javascriptSerializer.Deserialize<WebHookRetryResponse>(jsonResponse);

			Console.WriteLine(webHookRetryResponse.responseCode);
			Console.WriteLine(webHookRetryResponse.responseMessage);

			Environment.Exit (0);
		}


		public class WebHookRetryRequest : UpdoxRequest {
			public List<long> failures { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class WebHookRetryResponse : UpdoxResponse {
			public Dictionary<String, Object> validity { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;

public class UpdoxCodeSample_WebHookRetry {

	public static void main(String[] args) {
		UpdoxCodeSample_WebHookRetry codeSample = new UpdoxCodeSample_WebHookRetry();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "WebHookRetry";

		WebHookRetryRequest webHookRetryRequest = new WebHookRetryRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = webHookRetryRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<Long> failures = new ArrayList<>();
		Long failuresLong = 1L;
		failures.add(failuresLong);
		webHookRetryRequest.setFailures(failures);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(webHookRetryRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'WebHookRetry', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		WebHookRetryResponse webHookRetryResponse = mapper.readValue(jsonResponse, WebHookRetryResponse.class);

		System.out.println(webHookRetryResponse.getResponseCode());
		System.out.println(webHookRetryResponse.getResponseMessage());
	}

	private class WebHookRetryRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<Long> failures;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<Long> getFailures() {
			return failures;
		}

		public void setFailures(List<Long> failures) {
			this.failures = failures;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class WebHookRetryResponse extends UpdoxResponse {
		private Map validity;


		public Map getValidity() {
			return validity;
		}

		public void setValidity(Map validity) {
			this.validity = validity;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

WebHookSave /io/WebHookSave

Create or update a webhook

Parameter	Type	Description
eventId	String	The event id you wish to subscribe to. This is required.
url	String	Your callback url for this event. Must contain HTTPS. This is required. This is required.
active	Boolean	Activate or inactivate your callback url. This is required.

Try it! Toggle Notes/Code Samples

WebHookSave

Create or update a webhook

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_WebHookSave {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_WebHookSave codeSample = new UpdoxCodeSample_WebHookSave();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "WebHookSave";
			WebHookSaveRequest webHookSaveRequest = new WebHookSaveRequest();

			//set up credentials
			webHookSaveRequest.auth.applicationId = "applicationId";
			webHookSaveRequest.auth.applicationPassword = "applicationPassword";
			webHookSaveRequest.auth.accountId = "accountId";

			//set up request specific parameters
			webHookSaveRequest.eventId = "eventId";
			webHookSaveRequest.url = "url";
			webHookSaveRequest.active = true;

			//create the request
			string json = Utilities.buildRequestJson(webHookSaveRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "WebHookSave", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			WebHookSaveResponse webHookSaveResponse = javascriptSerializer.Deserialize<WebHookSaveResponse>(jsonResponse);

			Console.WriteLine(webHookSaveResponse.responseCode);
			Console.WriteLine(webHookSaveResponse.responseMessage);

			Environment.Exit (0);
		}


		public class WebHookSaveRequest : UpdoxRequest {
			public string eventId { get; set;}
			public string url { get; set;}
			public bool active { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class WebHookInfo {
			public string eventId { get; set;}
			public string url { get; set;}
			public bool active { get; set;}
			public String added_date { get; set;}
			public String modified_date { get; set;}
		}

		public class WebHookSaveResponse : UpdoxResponse {
			public WebHookInfo webhook { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;

import java.sql.Timestamp;

public class UpdoxCodeSample_WebHookSave {

	public static void main(String[] args) {
		UpdoxCodeSample_WebHookSave codeSample = new UpdoxCodeSample_WebHookSave();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "WebHookSave";

		WebHookSaveRequest webHookSaveRequest = new WebHookSaveRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = webHookSaveRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

		webHookSaveRequest.setEventId("eventId");
		webHookSaveRequest.setUrl("url");
		webHookSaveRequest.setActive(true);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(webHookSaveRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'WebHookSave', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		WebHookSaveResponse webHookSaveResponse = mapper.readValue(jsonResponse, WebHookSaveResponse.class);

		System.out.println(webHookSaveResponse.getResponseCode());
		System.out.println(webHookSaveResponse.getResponseMessage());
	}

	private class WebHookSaveRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private String eventId;
    	private String url;
    	private Boolean active;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public String getEventId() {
			return eventId;
		}

		public void setEventId(String eventId) {
			this.eventId = eventId;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public Boolean isActive() {
			return active;
		}

		public void setActive(Boolean active) {
			this.active = active;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class WebHookInfo {
		private String eventId;
		private String url;
		private boolean active;
		private Timestamp added_date;
		private Timestamp modified_date;


		public String getEventId() {
			return eventId;
		}

		public void setEventId(String eventId) {
			this.eventId = eventId;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}

		public boolean isActive() {
			return active;
		}

		public void setActive(boolean active) {
			this.active = active;
		}

		public Timestamp getAdded_date() {
			return added_date;
		}

		public void setAdded_date(Timestamp added_date) {
			this.added_date = added_date;
		}

		public Timestamp getModified_date() {
			return modified_date;
		}

		public void setModified_date(Timestamp modified_date) {
			this.modified_date = modified_date;
		}
	}

	private static class WebHookSaveResponse extends UpdoxResponse {
		private WebHookInfo webhook;


		public WebHookInfo getWebhook() {
			return webhook;
		}

		public void setWebhook(WebHookInfo webhook) {
			this.webhook = webhook;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

WebHookVendorRetry /io/WebHookVendorRetry

Retry failed webhooks across practices

Parameter	Type	Value	Description
failures	List	add remove	The list of failed webhook attempt IDs you wish to retry. This is required.

	Long

Try it! Toggle Notes/Code Samples

WebHookVendorRetry

Retry failed webhooks across practices

Prerequisites


	...
	"auth": {
		"applicationId": "updox",
		"applicationPassword": "1234567890",
		"accountId": "account"
	}
	...

Code Samples

JAVA

Fullscreen Copy to clipboard


/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

using System;
using System.IO;
using System.Net;
using System.Web.Script.Serialization;
using System.Collections.Generic;

namespace Updox_Tester {
    public class UpdoxCodeSample_WebHookVendorRetry {

		public static void Main(string[] args) {
			try {
				UpdoxCodeSample_WebHookVendorRetry codeSample = new UpdoxCodeSample_WebHookVendorRetry();
				codeSample.execute();
			} catch (Exception ex) {
				System.Diagnostics.Debug.WriteLine(ex.StackTrace);
			}
		}

		public void execute() {
			string environment = "https://updoxqa.com/api/io/";
			String methodName = "WebHookVendorRetry";
			WebHookVendorRetryRequest webHookVendorRetryRequest = new WebHookVendorRetryRequest();

			//set up credentials
			webHookVendorRetryRequest.auth.applicationId = "applicationId";
			webHookVendorRetryRequest.auth.applicationPassword = "applicationPassword";
			webHookVendorRetryRequest.auth.accountId = "accountId";

			//set up request specific parameters
			List<long> failures = new List<long>();
			long failuresLong = 1L;
			failures.Add(failuresLong);
			webHookVendorRetryRequest.failures = failures;

			//create the request
			string json = Utilities.buildRequestJson(webHookVendorRetryRequest);

			//send the request and get the response
			string jsonResponse = Utilities.callApi(environment, "WebHookVendorRetry", json);

			//reconstitute the response into an object
    		JavaScriptSerializer javascriptSerializer = new JavaScriptSerializer();
			WebHookVendorRetryResponse webHookVendorRetryResponse = javascriptSerializer.Deserialize<WebHookVendorRetryResponse>(jsonResponse);

			Console.WriteLine(webHookVendorRetryResponse.responseCode);
			Console.WriteLine(webHookVendorRetryResponse.responseMessage);

			Environment.Exit (0);
		}


		public class WebHookVendorRetryRequest : UpdoxRequest {
			public List<long> failures { get; set;}
		}

		public class UpdoxAuth {
			public string applicationId { get; set;}
			public string applicationPassword { get; set;}
			public string accountId { get; set;}
			public string userId { get; set;}
		}

		public class UpdoxRequest {
			public UpdoxRequest() {
				this.auth = new UpdoxAuth();
			}
			public UpdoxAuth auth { get; set;}
		}



		public class RetryResult {
			public List<long> success { get; set;}
			public List<long> failure { get; set;}
		}

		public class WebHookVendorRetryResponse : UpdoxResponse {
			public RetryResult retries { get; set;}
		}

		public class UpdoxResponse {
			public bool successful { get; set;}
			public string responseMessage { get; set;}
			public long responseCode { get; set;}
		}

		public static class Utilities {
			public static string buildRequestJson(UpdoxRequest request) {
				string json = new JavaScriptSerializer().Serialize(request);
				return json;
			}

			public static HttpWebResponse sendRequest(string json, string url) {
				var httpWebRequest = HttpWebRequest.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();
					return httpResponse;
				}
			}

			public static string callApi(string environment, string methodName, string json) {
				string url = environment + methodName;
				HttpWebResponse httpResponse = sendRequest (json, url);

				if (httpResponse == null)
					throw new ArgumentNullException("response");

				Stream dataStream = null;
				StreamReader reader = null;
				string responseFromServer = null;

				try {
					dataStream = httpResponse.GetResponseStream();
					reader = new StreamReader(dataStream);
					responseFromServer = reader.ReadToEnd();
				} catch (Exception ex) {
					Console.WriteLine(ex.Message);
				} finally {
					if (reader != null)
						reader.Close();
					if (dataStream != null)
						dataStream.Close();
					httpResponse.Close();
				}
				return responseFromServer;
			}
		}
	}
}

package test;
/*
 * DISCLAIMER:
 *   Updox provides programming examples for demonstration purposes only,
 *   without warranty either expressed or implied, including, but not limited to,
 *   the implied warranties of merchantability or fitness for a particular purpose.
 *   These code samples assume that you are familiar with the programming
 *   language that is being demonstrated and the tools that are used to run them.
 *
 * NOTE:
 *   This source code sample was dynamically generated from the corresponding
 *   request and response objects.  This process can be complex and may not
 *   always generate source code that is ready for compilation.  Please be aware
 *   that slight tweaking of the code sample may be necessary.
 */

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

public class UpdoxCodeSample_WebHookVendorRetry {

	public static void main(String[] args) {
		UpdoxCodeSample_WebHookVendorRetry codeSample = new UpdoxCodeSample_WebHookVendorRetry();

		try {
			codeSample.execute();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public void execute() throws Exception {
		String methodName = "WebHookVendorRetry";

		WebHookVendorRetryRequest webHookVendorRetryRequest = new WebHookVendorRetryRequest();

		//set environment and credentials - QA
		String environment = "https://updoxqa.com/api/io/";
		UpdoxRequest auth = webHookVendorRetryRequest.getAuth();
		auth.setApplicationId("applicationId");
		auth.setApplicationPassword("applicationPassword");
		auth.setAccountId("accountId");

	List<Long> failures = new ArrayList<>();
		Long failuresLong = 1L;
		failures.add(failuresLong);
		webHookVendorRetryRequest.setFailures(failures);

		//create the request
		String jsonRequest = Utilities.buildRequestJson(webHookVendorRetryRequest);

		//send the request
		String jsonResponse = Utilities.callApi(environment, 'WebHookVendorRetry', jsonRequest);

		//reconstitute the response into an object
		ObjectMapper mapper = new ObjectMapper();
		WebHookVendorRetryResponse webHookVendorRetryResponse = mapper.readValue(jsonResponse, WebHookVendorRetryResponse.class);

		System.out.println(webHookVendorRetryResponse.getResponseCode());
		System.out.println(webHookVendorRetryResponse.getResponseMessage());
	}

	private class WebHookVendorRetryRequest extends UpdoxRequest {
		private UpdoxRequest auth = new UpdoxRequest();

    	private List<Long> failures;

		public UpdoxRequest getAuth() {
			return auth;
		}

		public void setAuth(UpdoxRequest auth) {
			this.auth = auth;
		}

		public List<Long> getFailures() {
			return failures;
		}

		public void setFailures(List<Long> failures) {
			this.failures = failures;
		}
	}

	private class UpdoxRequest implements Serializable {
		private String applicationId;
		private String applicationPassword;
		private String accountId;

		public String getApplicationId() {
			return applicationId;
		}

		public void setApplicationId(String applicationId) {
			this.applicationId = applicationId;
		}

		public String getApplicationPassword() {
			return applicationPassword;
		}

		public void setApplicationPassword(String applicationPassword) {
			this.applicationPassword = applicationPassword;
		}

		public String getAccountId() {
		   return accountId;
		}

		public void setAccountId(String accountId) {
			this.accountId = accountId;
		}
	}

	private static class RetryResult {
		private List<Long> success;
		private List<Long> failure;


		public List<Long> getSuccess() {
			return success;
		}

		public void setSuccess(List<Long> success) {
			this.success = success;
		}

		public List<Long> getFailure() {
			return failure;
		}

		public void setFailure(List<Long> failure) {
			this.failure = failure;
		}
	}

	private static class WebHookVendorRetryResponse extends UpdoxResponse {
		private RetryResult retries;


		public RetryResult getRetries() {
			return retries;
		}

		public void setRetries(RetryResult retries) {
			this.retries = retries;
		}
	}

	private static class UpdoxResponse implements Serializable {
		private boolean successful;
		private String responseMessage;
		private long responseCode;

		public boolean isSuccessful() {
			return successful;
		}

		public void setSuccessful(boolean successful) {
			this.successful = successful;
		}

		public String getResponseMessage() {
			return responseMessage;
		}

		public void setResponseMessage(String responseMessage) {
			this.responseMessage = responseMessage;
		}

		public long getResponseCode() {
			return responseCode;
		}

		public void setResponseCode(long responseCode) {
			this.responseCode = responseCode;
		}
	}

	private static class Utilities {
		public static String buildRequestJson(Object object) throws JsonProcessingException {
			ObjectMapper mapper = new ObjectMapper();
			return mapper.writeValueAsString(object);
		}

		public static String callApi(String environment, String methodName, String json) throws Exception {
			String uri = environment + methodName;
			HttpClient httpClient = new DefaultHttpClient();
			String result = null;
			StringEntity params = new StringEntity(json);

			try {
				HttpPost request = new HttpPost(uri);
				request.addHeader("content-type", "application/json");
				request.setEntity(params);
				HttpResponse response = httpClient.execute(request);
				result = EntityUtils.toString(response.getEntity());
			} catch (Exception ex) {
				// handle exception here
			} finally {
				httpClient.getConnectionManager().shutdown();
			}
			return result;
		}
	}
}

General Response Codes

The General Response Code Set is the set of response codes that is possible in any API response. Examples include general validation errors, authentication errors, or server errors.

ResponseCode	ResponseMessage
`2000`	`OK`
`4000`	`Bad Request`
`4010`	`Unauthorized`
`4011`	`Unauthorized [Practice does not exist, is inactive, or is not authorized for this action]`
`4012`	`Unauthorized [User does not exist, is inactive, or is not authorized for this action]`
`4060`	`A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.`
`5000`	`an unknown error has occurred`
`5100`	`an unknown server error has occurred`
`5110`	`an unknown server error has occurred`

Interactive API

Application Authentication

Individual Authentication

Ping

Prerequisites

Code Samples

General Response Codes

PingWithAccountAuth

Prerequisites

Code Samples

General Response Codes

PingWithApplicationAuth

Prerequisites

Code Samples

General Response Codes

PingWithAuth

Prerequisites

Code Samples

General Response Codes

AddressBookList

Prerequisites

Code Samples

General Response Codes

AddressBookList/1.1

Prerequisites

Code Samples

General Response Codes

AddressBookSearch

Prerequisites

Code Samples

General Response Codes

ContactCreate

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

ContactCreate/1.1

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

ContactDelete

Prerequisites

Code Samples

General Response Codes

ContactSave

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

ContactSave/1.1

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

ContactUpdate

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

ContactUpdate/1.1

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

AppointmentCountGet

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

AppointmentStatusUpdate

Prerequisites

Code Samples

General Response Codes

Relevant Response Codes

AppointmentStatusesGetByDate

Prerequisites

Code Samples

General Response Codes

AppointmentStatusesGetByIds