Site API Information

NOTICE: If you narrow your criteria to one registrant, you will receive additional information, such as conviction, alias, and skin markings.

Results Format

JSON Object and XML Format

• results - number of results
  • object.results for JSON
  • <response><results>n</results></response> for XML
• records
  • object.records for JSON
  • <response><records>item NodeList</records></response> for XML
  Hash() if JSON, item NodeList if XML
  • registrant - registrant id - system identity
  • oci - registrant oci number
  • last_name - registrant's last name
  • first_name - registrant's first name
  • middle_name - registrant's middle name
  • gender - registrant's gender
  • tier - registrant's tier information
  • race - registrant's race
  • hair_color - registrant's hair color
  • eye_color - registrant's eye color
  • height_inches - registrant's height, in inches
  • weight_pounds - registrant's weight, in pounds
  • address - formatted registrant's address
  • line_1 - line 1 of registrant's address
  • line_2 - line 2 of registrant's address
  • city - registrant's city
  • state - registrant's state
  • postal_code - registrant's postal code
  • county - registrant's county of residence
  • birthdate - registrant's date of birth
  • lat - address latitude
  • lon - address longitude
  • victim_minors - number of victims who were minors
  • victim_adults - number of victims who were adults
  • victim_unknown - number of victims who whose age is unknown
  • registrant_cluster - number of other registrants living at this address and/or lat and lon
  • photo - url to registrant's most recent photo
  • convictions - only available when you request 25 or less per page
    when 25 or more registrants are returned this will not be present
    Array() of Hash()es if JSON, item NodeList if XML
    • conviction - conviction text
    • registrant_age - age of registrant at time of offense
    • Victims - 0 to n
      Array() of Hash()es if JSON, item NodeList if XML
      • gender - victim gender
      • age - victim agegroup
  • aliases - only available when you request 25 or less per page
    when 25 or more registrants are returned this will not be present
    Array() of Hash()es if JSON, item NodeList if XML
    • last_name - alias last name
    • first_name - alias first name
    • middle_name - alias middle name
  • skin_markings - only available when you request 25 or less per page
    when 25 or more registrants are returned this will not be present
    Array() if JSON, item NodeList if XML
    • marking value
  • distance - distance from searched location in miles
    only available when a location (user address or lat/lon) is executed
    when non-location lookups occur this will contain the value "Not Available"
  • last_changed - date registrant was updated

Paging

• https://www.iowasexoffender.gov/api/search/results.json?updated=today&per_page=20&page=1
3 new items will be added to the response:
• page - numeric, current page of response
• pages - numeric, total number of pages in response
• onpage - numeric, number of rows on the current page (0-Limit)

If you request 25 or fewer items per page, the conviction, alias, most wanted flag, and skin markings will also be returned.

Sorting

• https://www.iowasexoffender.gov/api/search/results.json?updated=today&sort=last_name&order=desc
• You may sort by:
  • registrant - registrant id - system identity
  • oci - registrant oci number
  • last_name - registrant's last name
  • first_name - registrant's first name
  • middle_name - registrant's middle name
  • gender - registrant's gender
  • height - registrant's height, in inches
  • weight - registrant's weight, in pounds
  • address - registrant's address
  • birthdate - registrant's date of birth
• Order may be desc or asc

Error Format

JSON Object and XML Format

• results - number of results will show 0
  • object.results for JSON
  • <response><results>0</results></response> for XML
• records - will be null
  • object.records for JSON
  • <response><records /></response> for XML
• error - will be present, with a value of 1
  • object.error for JSON
  • <response><error>1</error></response> for XML
• message - will be present, string error message
  • object.message for JSON
  • <response><message>string</message></response> for XML

JavaScript API Prototype (BETA)

Javascript Cross Domain IOWA.SOR API more info hide info

                            <script type="text/javascript" src="https://www.iowasexoffender.gov/js/api.js"></script>
                            <script type="text/javascript">

                                var search = new IOWA.SOR();
                                var criteria = new IOWA.SOR.CRITERIA();

                                criteria.set('city','des moines'); // any item described in the query section may be used
                                
                                criteria.limit(10); // records per "page"
                                criteria.page(1); // default is 1, start on any page


                                // execute search, passing the service url, criteria, and a callback function
                                search.execute('http://www.iowasexoffenders.com/api/search/results.json',criteria, function (response) {

                                    // response contains full response object as described in the api info page
                                    
                                });

                                </script>