3.0
API change historyREST API with full access to Enquire Objects and meta-data for CRUD operations.
Request
Request URL
Request parameters
-
number
CaseId of the Individual you want returned
-
number
CommunityId of the Admission requirements you want returned for an Individual
Request headers
Request body
Responses
200 OK
Representations
[
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Sex Offender Registry",
"RequirementDescription":"Sex Offender Registry",
"RequirementDateCreated":"2019-07-11T19:31:15.8000000+00:00",
"CaseId":7898717,
"UserId":114,
"UserName":"Enquire Support",
"DateUpdated":"2019-09-03T20:41:28.9100000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":false,
"AdmissionMetId":9382097,
"ActivityId":48288861,
"ActivityTypeId":8774,
"ActivityTypeName":"Sex Offender Registry",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
},
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Financial Approval",
"RequirementDescription":"Financial Approval",
"RequirementDateCreated":"2019-07-11T19:31:24.9870000+00:00",
"CaseId":7898717,
"UserId":114,
"UserName":"Enquire Support",
"DateUpdated":"2019-09-03T20:41:31.9130000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":false,
"AdmissionMetId":9382098,
"ActivityId":48288862,
"ActivityTypeId":8777,
"ActivityTypeName":"Financial Approval",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
},
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Assessment",
"RequirementDescription":"Assessment",
"RequirementDateCreated":"2019-07-11T19:31:32.0270000+00:00",
"CaseId":7898717,
"UserId":11930,
"UserName":"Erin Hayes Demo",
"DateUpdated":"2019-08-05T16:57:01.8730000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":true,
"AdmissionMetId":9382099,
"ActivityId":48288863,
"ActivityTypeId":8775,
"ActivityTypeName":"Assessment",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
},
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Clinical Approval",
"RequirementDescription":"Clinical Approval",
"RequirementDateCreated":"2019-07-11T19:31:39.3300000+00:00",
"CaseId":7898717,
"UserId":11930,
"UserName":"Erin Hayes Demo",
"DateUpdated":"2019-08-08T17:59:25.8030000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":true,
"AdmissionMetId":9382100,
"ActivityId":48288877,
"ActivityTypeId":8776,
"ActivityTypeName":"Clinical Approval",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
},
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Order Equipment",
"RequirementDescription":"Order Equipment",
"RequirementDateCreated":"2019-07-11T19:31:46.6170000+00:00",
"CaseId":7898717,
"UserId":11930,
"UserName":"Erin Hayes Demo",
"DateUpdated":"2019-08-08T17:59:26.8030000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":true,
"AdmissionMetId":9382101,
"ActivityId":48288878,
"ActivityTypeId":5665,
"ActivityTypeName":"Order Equipment",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
},
{
"CommunityId":1228,
"CommunityName":"Creekside Village",
"RequirementName":"Admissions Paperwork",
"RequirementDescription":"Admissions Paperwork",
"RequirementDateCreated":"2019-07-11T19:31:54.3200000+00:00",
"CaseId":7898717,
"UserId":11930,
"UserName":"Erin Hayes Demo",
"DateUpdated":"2019-08-08T17:59:30.5900000+00:00",
"DateCreated":"2019-08-01T22:26:51.2200000+00:00",
"IsMet":true,
"AdmissionMetId":9382102,
"ActivityId":48288879,
"ActivityTypeId":5664,
"ActivityTypeName":"Admissions Paperwork",
"ActivityResultName":"Completed",
"ActivityResultId":2110,
"Dismiss":false,
"TypeSelect":[
{
"value":2110,
"label":"Completed"
}
]
}
]Code samples
@ECHO OFF
curl -v -X GET "https://api2.enquiresolutions.com/v3/admission?CaseId={number}&CommunityId={number}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["CaseId"] = "{number}";
queryString["CommunityId"] = "{number}";
var uri = "https://api2.enquiresolutions.com/v3/admission?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api2.enquiresolutions.com/v3/admission");
builder.setParameter("CaseId", "{number}");
builder.setParameter("CommunityId", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"CaseId": "{number}",
"CommunityId": "{number}",
};
$.ajax({
url: "https://api2.enquiresolutions.com/v3/admission?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api2.enquiresolutions.com/v3/admission";
NSArray* array = @[
// Request parameters
@"entities=true",
@"CaseId={number}",
@"CommunityId={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api2.enquiresolutions.com/v3/admission');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'CaseId' => '{number}',
'CommunityId' => '{number}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'CaseId': '{number}',
'CommunityId': '{number}',
})
try:
conn = httplib.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/admission?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'CaseId': '{number}',
'CommunityId': '{number}',
})
try:
conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/admission?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api2.enquiresolutions.com/v3/admission')
query = URI.encode_www_form({
# Request parameters
'CaseId' => '{number}',
'CommunityId' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body