API Reference‎ > ‎People Service‎ > ‎

Resource: `criminalCase`

API Reference > People API

Resource: criminalCase

A specific criminal record associated with a person’s criminal check.

Schema

{
  "_type": "criminalCase",
  "caseNumber": {string},
  "caseDate": {date},
  "caseType": {string},
  "county": {string},
  "state": {string},
  "status": {string},
  "docNumber": {string},
  "comment": {string},
  "notMeFlag": {boolean},
  "datasource": {string},
  "score": {
    "nameFirst": {number},
    "nameMiddle": {number},
    "nameLast": {number},
    "nameSuffix": {number},
    "dobDay": {number},
    "dobMonth": {number},
    "dobYear": {number},
    "totalStrict": {number},
    "totalVariable": {number},
    "total": {number}
  },
  "paroleSentences": [
    {
      "actualEnddate": {date},
      "currentStatus": {string},
      "county": {string},
      "length": {string},
      "scheduledEndDate": {date},
      "startDate": {date},
      "isSexOffender": {boolean},
      "is3gOffender": {boolean},
      "isViolentOffender": {boolean}
    }
  ],
  "prisonSentences": [
    {
      "admittedDate": {date},
      "currentStatus": {string},
      "custody": {
        "type": {string},
        "changeDate": {date}
      },
      "gainTimeGranted": {string},
      "lastGainTime": {date},
      "location": {string},
      "scheduledReleaseDate": {date},
      "sentence": {string}
    }
  ],
  "offenses": [
    {
      "adjudicationWithheld": {boolean},
      "date": {date},
      "caseNumber": {string},
      "caseType": {string},
      "counts": {number},
      "county": {string},
      "description": {string},
      "disposition": {string},
      "maxTerm": {string},
      "minTerm": {string},
      "type": {string},
      "normalizedLevel": {string},
      "sentence": {
        "date": {date},
        "description": {string}
      },
      "appeal": {
        "date": {date},
        "disposition": {string},
        "finalDisposition": {string}
      },
      "arrest": {
        "caseNumber": {string},
        "agency": {string},
        "date": {date},
        "disposition": {string},
        "dispositionDate": {date},
        "level": {string},
        "statute": {string},
        "type": {string}
      },
      "court": {
        "offense": {string},
        "caseNumber": {string},
        "costs": {string},
        "description": {string},
        "disposition": {string},
        "dispositionDate": {date},
        "fine": {string},
        "level": {string},
        "plea": {string},
        "statute": {string},
        "suspendedFine": {string}
      },
      "court_sentence": {
        "jail": {string},
        "probation": {string},
        "suspended": {string}
      }
    }
  ],
  "akas": [
    {
      "fullName": {string},
      "first": {string},
      "last": {string},
      "middle": {string},
      "suffix": {string},
      "prefix": {string}
    }
  ],
  "offender": {
    "id": {string},
    "name": {
      "full": {string},
      "first": {string},
      "last": {string},
      "middle": {string,
      "suffix": {string},
      "prefix": {string}
    },
    "dob": {
      "day": {string},
      "month": {string},
      "year": {string}
    },
    "stateOfBirth": {string},
    "eyes": {string},
    "hair": {string},
    "height": {string},
    "weight": {string},
    "race": {string},
    "sex": {string},
    "skin": {string},
    "address": {
      "streetNumber": {string},
      "streetPredirection": {string},
      "streetName": {string},
      "streetSuffix": {string},
      "streetPostdirection": {string},
      "unitDesignation": {string},
      "unitNumber": {string},
      "streetAddress1": {string},
      "streetAddress2": {string},
      "state": {string},
      "city": {string},
      "zip5": {string},
      "zip4": {string},
      "county": {string},
      "postalCode": {string},
      "stateCityZip": {string}
    }
  },
  "id": {string},
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
criminalCheck Link to the parent criminal check.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes Username of the user associated with the criminal case.
id string path yes ID of the criminal case.

Action: get

Used to fetch information on a specific criminal case.

Response

If successful, a criminalCase resource will be returned in the response body.


Action: put

Used to update a criminal case.

Request

A criminalCase resource is expected in the request body.

Response

If successful, a criminalCase resource will be returned in the response body.


Action: patch

Used to apply a partial update to a criminal case.

Request

A criminalCase resource is expected in the request body.

Response

If successful, a criminalCase resource will be returned in the response body.


Comments