Difference between revisions of "API Method FaxOemPop"
From Updox API
(Created page with " == Description == The following code samples describe the processes involved in retrieving fax messages from a Practice's queue. == Prerequisites == {{PreReq Vendor C...") |
|||
Line 23: | Line 23: | ||
{{Core Method Header - CSharp}} | {{Core Method Header - CSharp}} | ||
{{Json FaxOemPop Block - CSharp}} | {{Json FaxOemPop Block - CSharp}} | ||
− | {{Json Auth Block - | + | {{Json Auth Block - Account - CSharp}} |
{{Core Method Footer - CSharp|faxOemPop|faxOemPop}} | {{Core Method Footer - CSharp|faxOemPop|faxOemPop}} | ||
Line 38: | Line 38: | ||
{{Json RequestBlock Header- Java}} | {{Json RequestBlock Header- Java}} | ||
{{Json FaxOemPop Block - Java}} | {{Json FaxOemPop Block - Java}} | ||
− | {{Json Auth Block - | + | {{Json Auth Block - Account - Java}} |
{{Json RequestBlock Footer - Java}} | {{Json RequestBlock Footer - Java}} | ||
Revision as of 07:36, 24 July 2014
Contents |
Description
The following code samples describe the processes involved in retrieving fax messages from a Practice's queue.
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 { lastRetrievedFaxId = "123", auth = new { applicationId = "vendorId", applicationPassword = "vendorPassword", accountId = "accountId", userId = "" } }); string url = "https://updoxqa.com/io/faxOemPop"; 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 |
import com.fasterxml.jackson.databind.JsonNode; 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.util.HashMap; import java.util.Map; public class UpdoxTest { public void TalkToUpdox() throws Exception { String uri = "https://updoxqa.com/io/faxOemPop"; 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(); Map<String,String> authData = new HashMap(); messageData.put("lastRetrievedFaxId","123"); authData.put("applicationId", "vendorId"); authData.put("applicationPassword", "vendorPassword"); authData.put("accountId", "accountId"); messageData.put("auth", authData); 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
{ "auth": { "applicationId": "vendorId", "applicationPassword": "vendorPassword", "accountId": "accountId", "userId": "" } }
HTTP Response Status
200 OK
Response JSON
{ "endOfQueue": false, "messageId": 1787, "received": 1396640136000, "from": "7877460048", "to": "8663664129", "attachments": [ { "fileName": "fax176357386.pdf_page-1.png", "mimeType": "image/png", "content": "iVBORw0KGgo...AKfUw~N" } ] }
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
|
---|