Responses to API requests can be in JSON or XML. Most of the fields in a response contain information from the court. There are a few other kinds of fields.
In the Doxpop API, Uniform Resource Identifier (URI) fields are analogous to links in typical pages as displayed in a web browser. Any field with a name that ends with "_uri" points to a resource that is related to the resource that contains the field. For example, a case resource will have URIs for minutes, charges, and events related to that case.
Client applications can follow a URI by constructing a full URL request from it. The URL begins with https://api.doxpop.com. Next is the text from the URI field. Finally, the desired format of the response (XML or JSON) is appended. For a URI field, "/case/18127D107IF04521/charges", the full URL might be "https://api.doxpop.com/case/18127D107IF04521/charges.json".
Information from our court partners is frequently being sent to Doxpop. Many partners send updates every ten minutes. Some partners send their latest information once a day. Responses to API search requests include the "as_of_timestamp" field to indicate the latest time when Doxpop loaded the most recent data from the partner court. This timestamp is always in UTC.
Examples of URLs and the corresponding responses are available for XML and JSON formats.