3.0

REST API with full access to Enquire Objects and meta-data for CRUD operations.

Transaction GET

Get all transactions by Housing Contract, Unit, Individual, or Campaign.

Request

Request URL

https://api2.enquiresolutions.com/v3/Transaction/[?PortalId][&Id][&IndividualId][&HousingContractId][&UnitId][&CampaignId][&TransactionTypeId]

Request parameters

PortalId

number

This is your company Id. You can request this value from EnquireLEADS support when registering for the API.
Id (optional)

number

Id of single transaction
IndividualId (optional)

number

Pull all transactions by individual
HousingContractId (optional)

number

Pull all transactions by housing contract
UnitId (optional)

number

Pull all transactions by unit
CampaignId (optional)

number

Pull all transaction by campaign
TransactionTypeId (optional)

number

Pull all transactions by type. You can find type ID's in Type GET method

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Representations

application/json

[
   {
      "Id":2691,
      "Description":"Entrance Fee",
      "Type":"Entrance Fee",
      "Status":"Paid",
      "Amount":100000,
      "Units":1,
      "DateCreated":"2014-01-30T06:28:52.8675915+00:00",
      "EffectiveDate":"2011-01-30T00:00:00.0000000+00:00",
      "IndividualId":146054,
      "IndividualName":"John Smith",
      "HousingContractId":1234,
      "UnitId":1234,
      "UnitName":"Skilled",
      "Total":"$100,000.00"
   },
   {
      "Id":1231,
      "Description":"Deposit",
      "Type":"Expense",
      "Status":"Paid",
      "Amount":500,
      "Units":1,
      "DateCreated":"2014-01-30T06:30:20.7047224+00:00",
      "EffectiveDate":"2011-01-30T00:00:00.0000000+00:00",
      "IndividualId":146054,
      "IndividualName":"Steven Smith",
      "HousingContractId":1147,
      "UnitId":4601,
      "UnitName":"Skilled",
      "Total":"$500.00"
   }
]

404 Not Found

No transactions found

400 Bad Request

Missing or invalid paramters

Code samples

@ECHO OFF

curl -v -X GET "https://api2.enquiresolutions.com/v3/Transaction/?PortalId={number}&Id={number}&IndividualId={number}&HousingContractId={number}&UnitId={number}&CampaignId={number}&TransactionTypeId={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["PortalId"] = "{number}";
            queryString["Id"] = "{number}";
            queryString["IndividualId"] = "{number}";
            queryString["HousingContractId"] = "{number}";
            queryString["UnitId"] = "{number}";
            queryString["CampaignId"] = "{number}";
            queryString["TransactionTypeId"] = "{number}";
            var uri = "https://api2.enquiresolutions.com/v3/Transaction/?" + 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/Transaction/");

            builder.setParameter("PortalId", "{number}");
            builder.setParameter("Id", "{number}");
            builder.setParameter("IndividualId", "{number}");
            builder.setParameter("HousingContractId", "{number}");
            builder.setParameter("UnitId", "{number}");
            builder.setParameter("CampaignId", "{number}");
            builder.setParameter("TransactionTypeId", "{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
            "PortalId": "{number}",
            "Id": "{number}",
            "IndividualId": "{number}",
            "HousingContractId": "{number}",
            "UnitId": "{number}",
            "CampaignId": "{number}",
            "TransactionTypeId": "{number}",
        };
      
        $.ajax({
            url: "https://api2.enquiresolutions.com/v3/Transaction/?" + $.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/Transaction/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"PortalId={number}",
                         @"Id={number}",
                         @"IndividualId={number}",
                         @"HousingContractId={number}",
                         @"UnitId={number}",
                         @"CampaignId={number}",
                         @"TransactionTypeId={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/Transaction/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'PortalId' => '{number}',
    'Id' => '{number}',
    'IndividualId' => '{number}',
    'HousingContractId' => '{number}',
    'UnitId' => '{number}',
    'CampaignId' => '{number}',
    'TransactionTypeId' => '{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
    'PortalId': '{number}',
    'Id': '{number}',
    'IndividualId': '{number}',
    'HousingContractId': '{number}',
    'UnitId': '{number}',
    'CampaignId': '{number}',
    'TransactionTypeId': '{number}',
})

try:
    conn = httplib.HTTPSConnection('api2.enquiresolutions.com')
    conn.request("GET", "/v3/Transaction/?%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
    'PortalId': '{number}',
    'Id': '{number}',
    'IndividualId': '{number}',
    'HousingContractId': '{number}',
    'UnitId': '{number}',
    'CampaignId': '{number}',
    'TransactionTypeId': '{number}',
})

try:
    conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
    conn.request("GET", "/v3/Transaction/?%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/Transaction/')

query = URI.encode_www_form({
    # Request parameters
    'PortalId' => '{number}',
    'Id' => '{number}',
    'IndividualId' => '{number}',
    'HousingContractId' => '{number}',
    'UnitId' => '{number}',
    'CampaignId' => '{number}',
    'TransactionTypeId' => '{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