description |
---|
This API endpoint allows communities with a large number of penal codes to set them easily with a single API call. |
{% hint style="warning" %} This API endpoint requires the Standard version of Sonoran CAD or higher. For more information, see our pricing page. {% endhint %}
{% swagger baseUrl="https://api.sonorancad.com" path="/general/set_penal_codes" method="post" summary="Set Penal Codes" %} {% swagger-description %} This API endpoint allows communities with a large number of penal codes to set them easily with a single API call. {% endswagger-description %}
{% swagger-parameter in="body" name="id" type="string" %} Your community's ID {% endswagger-parameter %}
{% swagger-parameter in="body" name="key" type="string" %} Your community's API Key {% endswagger-parameter %}
{% swagger-parameter in="body" name="type" type="string" %} SET_PENAL_CODES {% endswagger-parameter %}
{% swagger-parameter in="body" name="data" type="array" %} Array of request objects {% endswagger-parameter %}
{% swagger-response status="200" description="A successful call will be met with the following response:" %}
PENAL CODES SET!
{% endswagger-response %}
{% swagger-response status="400" description="The following 400 errors may be sent in response:" %}
INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY
{% endswagger-response %} {% endswagger %}
{
"id": "YOUR_COMMUNITY_ID",
"key": "YOUR_API_KEY",
"type": "SET_PENAL_CODES",
"data": [
{
"code": "(2)06",
"type": "Felony",
"title": "Armed Robbery",
"bondType": "Federal Bail Bond",
"jailTime": "5-10 Years",
"bondAmount": 20000
},
{
"code": "(2)07",
"type": "Felony",
"title": "Murder",
"bondType": "Federal Bail Bond",
"jailTime": "5-50 Years",
"bondAmount": 100000
}
]
}
Your penal codes must be sent as a JSON object array in the exact format shown. Depending on how your community's penal codes are structure, you may want to write a script to automate this formatting. Then, send your penal codes via API with something like Postman.