Emergency Endpoints
Delete Call
post
https://imperialcad.app/api/1.1/wf/CallDelete
The "911delete" endpoint allows you to delete any currently opened call, using the CallID returned by a create call or 911 request. This will auto-generate a call-note (without audio) on close so the call history does provide context this call was closed outside of the Imperial CAD. (You can only Delete calls via API with the callid returned, This number is not stored or displayed publicly)
Request Data
{
"callId": "Unique-CallID",
"discordid": "Relavent Users Discord ID",
"communityId": "imperial_community_id"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
Call ID {CallID} closed
Create Call
post
https://imperialcad.app/api/1.1/wf/CallCreate
The "CallCreate" endpoint allows you to create a new call, that is treated as a normal opened call within Imperial CAD allowing more options and custom values. The biggest difference from a 911 call is that this call provides no audio alert unless you choose to assign a primary unit using the "users_discordID"
key, Then it will verbally alert to unit in LEO MDC saying .
Request Data
{
"commId": "imperial_community_id",
"users_discordID": "123456789", -- Not required, If provided attaches user to call.
"street": "Test Street",
"cross_street": "Cross Street test",
"postal": "00000",
"city" : "Los Santos",
"county" : "Los Santos County",
"info": "Call Description",
"nature": "Call Nature",
"status": "PENDING", --Either PENDING, ACTIVE, CLOSED
"priority": 2, --this is a number between 1 and 3
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {
"callId": "Unique-10-digit-string",
"callnum": Call-number
}
}
Create 911 Call
post
https://imperialcad.app/api/1.1/wf/911
The "911" endpoint allows you to create a new call, that is treated as a 911 call within Imperial CAD. The biggest difference is this call provides an audio alert "New incoming 911 call" and flashes until at least one unit interacts with the call within the LEO MDC Panel.
Request Data
{
"commId": "imperial_community_id",
"name": "name",
"street": "street",
"cross_street": "Cross Street test",
"info": "Call Description",
"postal": "00000"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {
"callId": "Random-10-digit-string",
"callnum": Call-number
}
}
Attach Call
post
https://imperialcad.app/api/1.1/wf/attachcall
The "attachcall" endpoint allows you to attach any current available unit to any opened call by its call number. This can be fount on the users MDC or in the response of creating a call.
Request Data
{
"commId": "imperial_community_id",
"users_discordID": "user to attach discord ID",
"callnum": number
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {}
}
Create Call Note
post
https://imperialcad.app/api/1.1/wf/callnote
The "callnote" endpoint allows you to attach notes to any users current call, This user must be on a call for this request to work.
Request Data
{
"commId": "imperial_community_id",
"users_discordID": "user to attach discord ID",
"description": "Call Note Here"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {}
}
Check Plate
post
https://imperialcad.app/api/1.1/wf/checkplate
The "checkplate" endpoint allows you to search any vehicle plate that exist within a community, If the plate is invalid you cant search it.
Request Data
{
"plate": "plate",
"communityId": "imperial_community_id"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {
"owner": "Owner Full Name",
"plate_number": "plate",
"stolen": "true or false",
"insurance": "true or false",
"insurance_status": "status",
"business": "true or false",
"reg_status": "status"
}
}
Off Duty
post
https://imperialcad.app/api/1.1/wf/offduty
The "offduty" endpoint allows you to mark any current available unit off duty, and handle the cleanup.
Request Data
{
"commId": "imperial_community_id",
"users_discordID": "user to attach discord ID"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {}
}
Panic
post
https://imperialcad.app/api/1.1/wf/panic
The "panic" endpoint allows you to trigger a server signal that will appear as a panic.
Request Data
{
"commId": "imperial_community_id",
"users_discordID": "user to attach discord ID",
"postal": "postal",
"street": "street"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {}
}
Clear Panic
post
https://imperialcad.app/api/1.1/wf/clearpanic
The "clearpanic" endpoint allows you to clear a community's current panic, This community must have a active panic to run this request. (Does not work for a signal)
Request Data
{
"commId": "imperial_community_id"
}
Request Headers
{
["Content-Type"] = "application/json",
["APIKEY"] = imperialAPI
}
API Response (On 200 Success)
{
"status": "success",
"response": {}
}
More to come, Please leave suggestions in Our Discord!
Last updated
Was this helpful?