Incoming Files
Create Incoming File
Create a new incoming file.
POST
/
api
/
2.0
/
incoming_files
/
Create Incoming File
curl --request POST \
--url https://sandbox.elationemr.com/api/2.0/incoming_files/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"group_name": "<string>",
"practice": 123,
"external_fax_id": "<string>",
"files": [
{
"base64_content": "<string>",
"content_type": "<string>",
"filename": "<string>",
"incoming_file": 123,
"practice": 123
}
],
"images": [
{
"base64_content": "<string>",
"content_type": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"received_date": "2023-11-07T05:31:56Z"
}
],
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"transmit_time": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://sandbox.elationemr.com/api/2.0/incoming_files/"
payload = {
"group_name": "<string>",
"practice": 123,
"external_fax_id": "<string>",
"files": [
{
"base64_content": "<string>",
"content_type": "<string>",
"filename": "<string>",
"incoming_file": 123,
"practice": 123
}
],
"images": [
{
"base64_content": "<string>",
"content_type": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"received_date": "2023-11-07T05:31:56Z"
}
],
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"transmit_time": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
group_name: '<string>',
practice: 123,
external_fax_id: '<string>',
files: [
{
base64_content: '<string>',
content_type: '<string>',
filename: '<string>',
incoming_file: 123,
practice: 123
}
],
images: [
{
base64_content: '<string>',
content_type: '<string>',
incoming_file: 123,
original_extension: '<string>',
original_height: 123,
original_padded: 123,
original_rotation: 123,
original_width: 123,
practice: 123,
received_date: '2023-11-07T05:31:56Z'
}
],
practice_fax: '<string>',
process_complete_time: '2023-11-07T05:31:56Z',
process_start_time: '2023-11-07T05:31:56Z',
received_time: '2023-11-07T05:31:56Z',
transmit_time: '2023-11-07T05:31:56Z'
})
};
fetch('https://sandbox.elationemr.com/api/2.0/incoming_files/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/incoming_files/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'group_name' => '<string>',
'practice' => 123,
'external_fax_id' => '<string>',
'files' => [
[
'base64_content' => '<string>',
'content_type' => '<string>',
'filename' => '<string>',
'incoming_file' => 123,
'practice' => 123
]
],
'images' => [
[
'base64_content' => '<string>',
'content_type' => '<string>',
'incoming_file' => 123,
'original_extension' => '<string>',
'original_height' => 123,
'original_padded' => 123,
'original_rotation' => 123,
'original_width' => 123,
'practice' => 123,
'received_date' => '2023-11-07T05:31:56Z'
]
],
'practice_fax' => '<string>',
'process_complete_time' => '2023-11-07T05:31:56Z',
'process_start_time' => '2023-11-07T05:31:56Z',
'received_time' => '2023-11-07T05:31:56Z',
'transmit_time' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/incoming_files/"
payload := strings.NewReader("{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.elationemr.com/api/2.0/incoming_files/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/incoming_files/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"group_name": "<string>",
"practice": 123,
"created_date": "2023-11-07T05:31:56Z",
"external_fax_id": "<string>",
"file_size": 123,
"files": [
{
"content_type": "<string>",
"filename": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"file_size": 123,
"file_url": "<string>",
"id": 123,
"incoming_file": 123,
"practice": 123
}
],
"from_number": "<string>",
"id": 123,
"images": [
{
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"file_size": 123,
"height": 123,
"id": 123,
"image_url": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"quality_score": 123,
"quality_score_by": 123,
"received_date": "2023-11-07T05:31:56Z",
"rotation": 123,
"sequence": 123,
"width": 123
}
],
"page_count": 123,
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_result": "<string>",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"subject": "<string>",
"to_company": "<string>",
"to_name": "<string>",
"to_number": "<string>",
"transmit_time": "2023-11-07T05:31:56Z"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Maximum string length:
200Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201 - application/json
Maximum string length:
200Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
complete, error, pending, processing Available options:
metrofax, plr, refile, softlinx, user Was this page helpful?
⌘I
Create Incoming File
curl --request POST \
--url https://sandbox.elationemr.com/api/2.0/incoming_files/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"group_name": "<string>",
"practice": 123,
"external_fax_id": "<string>",
"files": [
{
"base64_content": "<string>",
"content_type": "<string>",
"filename": "<string>",
"incoming_file": 123,
"practice": 123
}
],
"images": [
{
"base64_content": "<string>",
"content_type": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"received_date": "2023-11-07T05:31:56Z"
}
],
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"transmit_time": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://sandbox.elationemr.com/api/2.0/incoming_files/"
payload = {
"group_name": "<string>",
"practice": 123,
"external_fax_id": "<string>",
"files": [
{
"base64_content": "<string>",
"content_type": "<string>",
"filename": "<string>",
"incoming_file": 123,
"practice": 123
}
],
"images": [
{
"base64_content": "<string>",
"content_type": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"received_date": "2023-11-07T05:31:56Z"
}
],
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"transmit_time": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
group_name: '<string>',
practice: 123,
external_fax_id: '<string>',
files: [
{
base64_content: '<string>',
content_type: '<string>',
filename: '<string>',
incoming_file: 123,
practice: 123
}
],
images: [
{
base64_content: '<string>',
content_type: '<string>',
incoming_file: 123,
original_extension: '<string>',
original_height: 123,
original_padded: 123,
original_rotation: 123,
original_width: 123,
practice: 123,
received_date: '2023-11-07T05:31:56Z'
}
],
practice_fax: '<string>',
process_complete_time: '2023-11-07T05:31:56Z',
process_start_time: '2023-11-07T05:31:56Z',
received_time: '2023-11-07T05:31:56Z',
transmit_time: '2023-11-07T05:31:56Z'
})
};
fetch('https://sandbox.elationemr.com/api/2.0/incoming_files/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/incoming_files/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'group_name' => '<string>',
'practice' => 123,
'external_fax_id' => '<string>',
'files' => [
[
'base64_content' => '<string>',
'content_type' => '<string>',
'filename' => '<string>',
'incoming_file' => 123,
'practice' => 123
]
],
'images' => [
[
'base64_content' => '<string>',
'content_type' => '<string>',
'incoming_file' => 123,
'original_extension' => '<string>',
'original_height' => 123,
'original_padded' => 123,
'original_rotation' => 123,
'original_width' => 123,
'practice' => 123,
'received_date' => '2023-11-07T05:31:56Z'
]
],
'practice_fax' => '<string>',
'process_complete_time' => '2023-11-07T05:31:56Z',
'process_start_time' => '2023-11-07T05:31:56Z',
'received_time' => '2023-11-07T05:31:56Z',
'transmit_time' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/incoming_files/"
payload := strings.NewReader("{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.elationemr.com/api/2.0/incoming_files/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/incoming_files/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group_name\": \"<string>\",\n \"practice\": 123,\n \"external_fax_id\": \"<string>\",\n \"files\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"filename\": \"<string>\",\n \"incoming_file\": 123,\n \"practice\": 123\n }\n ],\n \"images\": [\n {\n \"base64_content\": \"<string>\",\n \"content_type\": \"<string>\",\n \"incoming_file\": 123,\n \"original_extension\": \"<string>\",\n \"original_height\": 123,\n \"original_padded\": 123,\n \"original_rotation\": 123,\n \"original_width\": 123,\n \"practice\": 123,\n \"received_date\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"practice_fax\": \"<string>\",\n \"process_complete_time\": \"2023-11-07T05:31:56Z\",\n \"process_start_time\": \"2023-11-07T05:31:56Z\",\n \"received_time\": \"2023-11-07T05:31:56Z\",\n \"transmit_time\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"group_name": "<string>",
"practice": 123,
"created_date": "2023-11-07T05:31:56Z",
"external_fax_id": "<string>",
"file_size": 123,
"files": [
{
"content_type": "<string>",
"filename": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"file_size": 123,
"file_url": "<string>",
"id": 123,
"incoming_file": 123,
"practice": 123
}
],
"from_number": "<string>",
"id": 123,
"images": [
{
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"file_size": 123,
"height": 123,
"id": 123,
"image_url": "<string>",
"incoming_file": 123,
"original_extension": "<string>",
"original_height": 123,
"original_padded": 123,
"original_rotation": 123,
"original_width": 123,
"practice": 123,
"quality_score": 123,
"quality_score_by": 123,
"received_date": "2023-11-07T05:31:56Z",
"rotation": 123,
"sequence": 123,
"width": 123
}
],
"page_count": 123,
"practice_fax": "<string>",
"process_complete_time": "2023-11-07T05:31:56Z",
"process_result": "<string>",
"process_start_time": "2023-11-07T05:31:56Z",
"received_time": "2023-11-07T05:31:56Z",
"subject": "<string>",
"to_company": "<string>",
"to_name": "<string>",
"to_number": "<string>",
"transmit_time": "2023-11-07T05:31:56Z"
}