Difference between revisions of "API Method UserCreate"
From Updox API
(→Relevant Response Codes) |
(→Relevant Response Codes) |
||
Line 71: | Line 71: | ||
== Relevant Response Codes == | == Relevant Response Codes == | ||
{{Response Codes Table Header}} | {{Response Codes Table Header}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 16:38, 21 November 2013
Contents |
Description
The following code samples describe the processes involved in managing a User acount.
Prerequisites
1 This API call requires Vendor-level credentials. The credentials should be populated into the applicationId
and applicationPassword
fields of the auth
block:
{ ... "auth": { "applicationId": "vendorId", "applicationPassword": "vendorPassword", "accountId": "", "userId": "" } }
2 This API call requires a Practice/Account-level identifier. The identifier should be populated into the accountId
field of the auth
block:
{
...
"auth": {
"applicationId": "vendorId",
"applicationPassword": "vendorPassword",
"accountId": "practiceId",
"userId": ""
}
}
Code Samples
Language | Source Code Examples |
---|---|
C# | public void TalkToUpdox() { string json = new JavaScriptSerializer().Serialize(new { userId = "newUserId", loginId = "newLoginId", loginPassword = "password", firstName = "Ima", // required middleName" = "Joy", lastName = "Usertino", // required address1 = "94 N. High St", address2 = "Suite 100", city = "Dublin", state = "OH", postal = "43017", timeZone = "America/Chicago", active = "true", //recommended, defaults to "false" provider = "false", directAddress = "practiceuser", auth = new { applicationId = "vendorId", applicationPassword = "vendorPassword", accountId = "accountId", userId = "" } }); string url = "https://updoxqa.com/io/userCreate"; SendReceiveJSON(json, url); } private void SendReceiveJSON(string json, string url) { var httpWebRequest = WebRequest.Create(url); httpWebRequest.ContentType = "application/json"; httpWebRequest.Method = "POST"; using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream())) { streamWriter.Write(json); streamWriter.Flush(); streamWriter.Close(); var httpResponse = (HttpWebResponse) httpWebRequest.GetResponse(); using (var streamReader = new StreamReader(httpResponse.GetResponseStream())) { var result = streamReader.ReadToEnd(); } } } |
Java |
public void TalkToUpdox() throws Exception { String uri = "https://updoxqa.com/io/userCreate"; ObjectMapper mapper = new ObjectMapper(); Map<String,Object> messageData = BuildMessage(); String jsonData = mapper.writeValueAsString(messageData); HttpResponse httpResponse = SendReceiveJSON(jsonData, uri); HttpEntity responseEntity = httpResponse.getEntity(); String response = EntityUtils.toString(responseEntity); JsonNode actualObj = mapper.readTree(response); System.out.println(actualObj.get("responseCode")); System.out.println(actualObj.get("responseMessage")); } private Map<String,Object> BuildMessage() throws Exception { Map<String,Object> messageData = new HashMap(); messageData.put("loginId","newLoginId"); messageData.put("loginPassword","password"); messageData.put("firstName", "Ima"); // required messageData.put("middleName", "Joy"); messageData.put("lastName", "Usertino"); // required messageData.put("address1", "94 N. High St"); messageData.put("address2", "Suite 100"); messageData.put("city", "Dublin"); messageData.put("state", "OH"); messageData.put("postal", "43017"); messageData.put("timeZone", "America/Chicago"); messageData.put("active","true"); // recommended, defaults to "false" messageData.put("provider", "false"); messageData.put("directAddress", "practiceuser"); authData.put("applicationId", "vendorId"); authData.put("applicationPassword", "vendorPassword"); authData.put("accountId", "accountId"); return messageData; } private HttpResponse SendReceiveJSON(String jsonData, String uri) throws Exception { HttpClient httpClient = new DefaultHttpClient(); HttpResponse response = null; StringEntity params = new StringEntity(jsonData); try { HttpPost request = new HttpPost(uri); request.addHeader("content-type", "application/json"); request.setEntity(params); response = httpClient.execute(request); } catch (Exception ex) { // handle exception here } finally { httpClient.getConnectionManager().shutdown(); } return response; } |
Messages
Destination Address
Request JSON
{
"userId": "newUserId", "loginId": "newLoginId", "loginPassword": "password", "firstName": "Iam", "middleName": "Joy", "lastName": "Usertino", "address1": "94 N High Street", "address2": "Suite 100", "city": "Dublin", "state": "OH", "postal": "43017", "timeZone": "America/Chicago", "active": "true", "provider": "false", "directAddress": "practiceuser", "auth": { "applicationId": "vendorId", "applicationPassword": "vendorPassword", "accountId": "accountId", "userId": "" }
}
HTTP Response Status
200 OK
Response JSON
{ "successful": true, "responseMessage": "OK", "responseCode": 2000, "userId": "newUserId", "action": "create" }
Relevant Response Codes
In addition to the General Error Set, this method may return the following values in the responseCode
and responseMessage
fields:
responseCode
|
responseMessage
|
---|