Technical Documentation

Expected Knowledge

We assume that you know the following:

• • One of these data formats:

    • XML (see w3schools XML Tutorial for more information)

    • JSON (see http://json.org for more information)

  • At least one programming language (such as one of these):

    • Java

    • C#

    • PHP

    • Python

    • Ruby

  • How to construct HTTP GET requests with query strings

Getting Started

Data Formats

You can start an inquiry at one resource URI: /actors_cases. You choose the data format by appending an extension.

• • For XML the URL starts with /actors_cases.xml

  • For JSON the URL starts with /actors_cases.json

Query String Parameters

To make an inquiry you need to specify some criteria in the query parameters. For example to find information about cases in which David Rifkind has been a party, you can use the fullname parameter. The full URL looks like this:

http://demo-api.doxpop.com/actors_cases.xml?fullname=rifkind,+david

Requesting More Details

Now you have found some cases for David Rifkind you can learn more about one of the cases. In the XML you will find several elements that end with "_uri". These are much like links in a web site. Inside the <charges_uri> element is some text that will lead you to information about the charges filed against the defendant.

You need to construct a full URL from the text in the <charges_uri> element. The URL starts with http://api.doxpop.com (for the demo it starts with http://demo-api.doxpop.com). The next part of the URL is the text you find in the charges_uri element, in this example, /case/18127D107IF04521/charges. Finally, append the data format extension, .xml. The full URL looks like this:

http://demo-api.doxpop.com/case/18127D107IF04521/charges.xml

More Detailed Documentation

You can find detailed documentation of the API at the following links:

• Request reference

• Response Reference

• Sample XML Responses

• Sample JSON Responses

Development and Testing

The API available at https://api.doxpop.com provides access to all the court information available through the Doxpop website. Customers are charged for searches made through the API.

The API is also available at https://demo-api.doxpop.com. All access to the demo API is free of charge. It provides access to about 5% of the information that is available from the production API. Developers who are creating new client applications should use the demo API for all testing.

Both the production and demo APIs use HTTP Basic Authentication over HTTPS. The demo API also allows unencrypted requests over HTTP.

Usernames and Passwords

A client application can access the demo API with "demo" username and "demo" password.

Customers who want to access the production API must contact Doxpop (https://api.doxpop.com/contact.html) to get a username and password. This username can be connected to an existing account used to access the Doxpop web site.

Example Code

Some code samples in Java, Python, and C# are available to download to help you get started.

Third Party Resources

Resources for JSON using Java

• http://code.google.com/p/json-simple/

Resources for REST using Java

• http://www.restlet.org

• http://jersey.java.net

Feedback

Please send any bug reports, feature requests, questions, or comments to api-support@doxpop.com or call 1-866-369-7671 (866-DOXPOP-1) and ask for Jim.