Defendant Type

Filter cases by defendant type

Filter by defendant type ID (integer).

GET https://clearinghouse.net/api/v1/case?issue_defendant_type=defendant_type_id

Query Parameters

Name	Type	Description
relief_source_id*	integer	Relief source ID (see list below for list of integers and its mapped values)

Headers

Name	Type	Description
Authorization*	String	Authorization Token XXXXXXXXXXX where XXXXXXXXXXX is the token string

200 Cases successfully retrieved

400: Bad Request No results, key not found, or invalid parameter

\\ Examples of:
\\ No results, key not found, or invalid parameter

\\ No results
\\ Example query endpoint: /api/v1/cases/?case_id=1&case_ongoing=1
["No results for {'case_id': '1', 'case_ongoing': '1'}"]

\\ Key not found
\\ Example query endpoint: /api/v1/cases?test_key=1
["API Error: Key: test_key, Value: 1 not found."]

\\ Example query endpoint: /api/v1/cases/?case_id=xyz
["API Error: zxy is not an integer."]

401 Permission denied

{
    "detail":"Authentication credentials were not provided."
}

Supported defendant type IDs (defendant_type_id):

5283	Housing Authority
5284	Law-enforcement
5289	Jurisdiction-wide
5324	Insurer
5321	Multi-family housing provider
5323	Bank or credit provider
5505	Elementary/Secondary School
5503	College/University
5504	Corrections
5563	Movie Theater or Other Entertainment facility
5561	Restaurant
5287	Sanitation/Public Works
5288	Transportation
5506	Fire
5507	Hospital/Health Department
5285	Parks
5286	Retailer
5322	Single family housing provider

For more information about defendant types, see Defendant-type.

Example

URL

https://clearinghouse.net/api/v1/case?issue_defendant_type=5561

python

import requests

url = "https://clearinghouse.net/api/v1/case?issue_defendant_type=5561"
headers = { 'Authorization': 'Token XXXXXXXXXX',
'User-Agent': 'Chrome v22.2 Linux Ubuntu'
}
response = requests.request("GET", url, headers=headers, data={})

print(response.text)