Mark43 for Developers: API Guide
Introduction
Welcome to Mark43 for Developers
__ __ _
\ \ / / | |
\ \ /\ / /__| | ___ ___ _ __ ___ ___
\ \/ \/ / _ \ |/ __/ _ \| '_ ` _ \ / _ \
\ /\ / __/ | (_| (_) | | | | | | __/
\/ \/ \___|_|\___\___/|_| |_| |_|\___|
Mark43 is proud to partner with location providers, community engagement software, and other law enforcement technologies to help us bring cloud-first, data-driven technology to public safety.
By using Mark43 API, you accept our Developer Terms of Use Agreement.
Base URL
The base URL of Mark43 API is: https://department.mark43.com/partnerships/api
.
The API provides a set of endpoints, each with its own unique path.
Authentication
Based on REST principles, Mark43 API Endpoints support authentication with secure API tokens using the standard HTTP Basic Authorization Header. This header must be attached to every request made to the Mark43 system. Contact your Mark43 Technical Services Representative for more information.
Response Structure
Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Mark43 API uses the appropriate HTTP verbs for each action:
GET |
Retrieves resources |
POST |
Creates resources |
PUT |
Changes and/or replaces resources or collections |
DELETE |
Deletes resources |
All response data is returned as a JSON object with the following overall structure:
{
"data": {},
"success": true,
"error": "Error message if success is false"
}
data |
Object | Contains created or retrieved objects |
success |
Boolean | Indicates whether the request was successful |
error |
String | Populated with a corresponding error message if the request was unsuccessful |
Response Status Codes
Mark43 API uses the response status codes defined in RFC 2616 and RFC 6586.
Associated Records Endpoints
Associated Records Endpoints
allow for the creation and retrieval of Associated Records in Mark43 RMS.
Associated Records are records/reports that are linked to a Mark43 report with a different Report Number.
These can be records/reports that exist outside an agency's jurisdiction (e.g., an Arrest Report from a neighboring agency),
or within (e.g., multiple Offense/Incident Reports for burglaries committed by the same suspect).
For details on person, organization, item, and location object creation, see Additional Model Information.
GET: Associated Records According to REN
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/associated_records/external_links \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/associated_records/external_links");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/associated_records/external_links',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/associated_records/external_links', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/associated_records/external_links HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/associated_records/external_links', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/associated_records/external_links',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/associated_records/external_links", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/associated_records/external_links";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/associated_records/external_links
Retrieves existing Associated Records links for all reports under provided Reporting Event Numbers (RENs).
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
reporting_event_numbers | query | array[string] | false | Reporting Event Numbers for which Associated Records should be returned |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Associated Records According to REN
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/associated_records/external_links?reporting_event_numbers=string \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/associated_records/external_links?reporting_event_numbers=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/associated_records/external_links',
params: {
'reporting_event_numbers' => 'array[string]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/associated_records/external_links', params={
'reporting_event_numbers': [
"string"
]
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/associated_records/external_links?reporting_event_numbers=string HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/associated_records/external_links', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
{
"externalId": "string",
"externalSystem": "string",
"reasonForAssociation": "string",
"reasonForAssociationOther": "string",
"sourceId": "string",
"sourceSystemName": "string",
"sourceSystemOther": "string",
"url": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/associated_records/external_links?reporting_event_numbers=string',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/associated_records/external_links", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/associated_records/external_links";
string json = @"[
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""reasonForAssociation"": ""string"",
""reasonForAssociationOther"": ""string"",
""sourceId"": ""string"",
""sourceSystemName"": ""string"",
""sourceSystemOther"": ""string"",
""url"": ""string""
}
]";
ExternalReportExternalLink content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalReportExternalLink content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalReportExternalLink content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/associated_records/external_links
Creates Associated Records links for reports with specified Reporting Event Numbers (RENs).
Body parameter
[
{
"externalId": "string",
"externalSystem": "string",
"reasonForAssociation": "string",
"reasonForAssociationOther": "string",
"sourceId": "string",
"sourceSystemName": "string",
"sourceSystemOther": "string",
"url": "string"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
reporting_event_numbers | query | array[string] | true | Reporting Event Numbers of reports to which ExternalReportExternalLinks should be added |
report_types | query | array[string] | false | Types of reports to which ExternalReportExternalLinks should be added |
custom_report_type_names | query | array[string] | false | Name(s) of the Custom Report Type |
body | body | ExternalReportExternalLink | true | ExternalReportExternalLinks to be created |
Allowable Values
Parameter | Value |
---|---|
report_types | ARREST |
report_types | CITATION |
report_types | CUSTODIAL_PROPERTY |
report_types | CUSTOM |
report_types | FIELD_CONTACT |
report_types | IMPOUND |
report_types | MISSING_PERSONS |
report_types | OFFENSE |
report_types | SUPPLEMENT |
report_types | TOW_VEHICLE |
report_types | TRAFFIC_CRASH |
report_types | USE_OF_FORCE |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Associated Records According to Report ID
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids?report_ids=0 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids?report_ids=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids',
params: {
'report_ids' => 'array[integer]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids', params={
'report_ids': [
0
]
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids?report_ids=0 HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
{
"externalId": "string",
"externalSystem": "string",
"reasonForAssociation": "string",
"reasonForAssociationOther": "string",
"sourceId": "string",
"sourceSystemName": "string",
"sourceSystemOther": "string",
"url": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids?report_ids=0',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/associated_records/external_links/report_ids";
string json = @"[
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""reasonForAssociation"": ""string"",
""reasonForAssociationOther"": ""string"",
""sourceId"": ""string"",
""sourceSystemName"": ""string"",
""sourceSystemOther"": ""string"",
""url"": ""string""
}
]";
ExternalReportExternalLink content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalReportExternalLink content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalReportExternalLink content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/associated_records/external_links/report_ids
Creates Associated Records links for reports with specified Mark43 Report IDs.
Body parameter
[
{
"externalId": "string",
"externalSystem": "string",
"reasonForAssociation": "string",
"reasonForAssociationOther": "string",
"sourceId": "string",
"sourceSystemName": "string",
"sourceSystemOther": "string",
"url": "string"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
report_ids | query | array[integer] | true | Mark43 IDs of reports to which ExternalReportExternalLinks should be added |
body | body | ExternalReportExternalLink | true | ExternalReportExternalLinks to be created |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
Attachment Endpoints
Attachment Endpoints
allow for the creation and retrieval of attachments in Mark43 RMS.
Attachments, such as image and audio files, can be added to or retrieved from:
- Reports
- Item Profiles
- Person Profiles
POST: File Attachments
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/attachments/files?entity_id=0&entity_type=ITEM_PROFILE&link_type=FINGERPRINT \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/attachments/files?entity_id=0&entity_type=ITEM_PROFILE&link_type=FINGERPRINT");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/attachments/files',
params: {
'entity_id' => 'integer(int64)',
'entity_type' => 'string',
'link_type' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/attachments/files', params={
'entity_id': '0', 'entity_type': 'ITEM_PROFILE', 'link_type': 'FINGERPRINT'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/attachments/files?entity_id=0&entity_type=ITEM_PROFILE&link_type=FINGERPRINT HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/attachments/files', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"my-file": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/attachments/files?entity_id=0&entity_type=ITEM_PROFILE&link_type=FINGERPRINT',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/attachments/files", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/attachments/files";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/attachments/files
Creates file attachments that can be added to reports, item profiles, and person profiles.
Body parameter
my-file: string
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
entity_id | query | integer(int64) | true | ID of associated entity |
entity_type | query | string | true | Type of associated entity |
link_type | query | string | true | Link between attachment and associated entity |
body | body | object | false | none |
» my-file | body | string(binary) | false | none |
Allowable Values
Parameter | Value |
---|---|
entity_type | ITEM_PROFILE |
entity_type | PERSON_PROFILE |
entity_type | REPORT |
entity_type | TRAFFIC_CRASH |
link_type | FINGERPRINT |
link_type | REPORT_ATTACHMENT |
link_type | IDENTIFYING_MARK |
link_type | PERSON_PROFILE_ATTACHMENT |
link_type | ITEM_PROFILE_ATTACHMENT |
link_type | TRAFFIC_CRASH_ATTACHMENT |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Image Attachments
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/attachments/images?entity_id=0&entity_type=ITEM_PROFILE&link_type=MUGSHOT \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/attachments/images?entity_id=0&entity_type=ITEM_PROFILE&link_type=MUGSHOT");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/attachments/images',
params: {
'entity_id' => 'integer(int64)',
'entity_type' => 'string',
'link_type' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/attachments/images', params={
'entity_id': '0', 'entity_type': 'ITEM_PROFILE', 'link_type': 'MUGSHOT'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/attachments/images?entity_id=0&entity_type=ITEM_PROFILE&link_type=MUGSHOT HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/attachments/images', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"my-file": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/attachments/images?entity_id=0&entity_type=ITEM_PROFILE&link_type=MUGSHOT',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/attachments/images", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/attachments/images";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/attachments/images
Creates image attachments that can be added to reports, item profiles, and person profiles.
Body parameter
my-file: string
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
entity_id | query | integer(int64) | true | ID of associated entity |
entity_type | query | string | true | Type of associated entity |
link_type | query | string | true | Link between attachment and associated entity |
body | body | object | false | none |
» my-file | body | string(binary) | false | none |
Allowable Values
Parameter | Value |
---|---|
entity_type | ITEM_PROFILE |
entity_type | PERSON_PROFILE |
entity_type | REPORT |
entity_type | TRAFFIC_CRASH |
link_type | MUGSHOT |
link_type | FINGERPRINT |
link_type | REPORT_ATTACHMENT |
link_type | PERSON_PROFILE_ATTACHMENT |
link_type | ITEM_PROFILE_PHOTO |
link_type | ITEM_PROFILE_ATTACHMENT |
link_type | TRAFFIC_CRASH_ATTACHMENT |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Search and Retrieve Attachments
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/attachments/search?entity_type=ITEM_PROFILE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/attachments/search?entity_type=ITEM_PROFILE");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/attachments/search',
params: {
'entity_type' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/attachments/search', params={
'entity_type': 'ITEM_PROFILE'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/attachments/search?entity_type=ITEM_PROFILE HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/attachments/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
0
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/attachments/search?entity_type=ITEM_PROFILE',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/attachments/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/attachments/search";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/attachments/search
Searches for and retrieves attachments according to Entity Id, Entity Type, and Link Type.
Body parameter
[
0
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
entity_type | query | string | true | Type of associated entity |
link_types | query | array[string] | false | Link between attachment and associated entity |
body | body | array[integer] | true | Set of Mark43 entity IDs |
Allowable Values
Parameter | Value |
---|---|
entity_type | ITEM_PROFILE |
entity_type | PERSON_PROFILE |
entity_type | REPORT |
entity_type | TRAFFIC_CRASH |
entity_type | WARRANT |
link_types | MUGSHOT |
link_types | FINGERPRINT |
link_types | REPORT_ATTACHMENT |
link_types | IDENTIFYING_MARK |
link_types | PERSON_PROFILE_ATTACHMENT |
link_types | COURT_ORDER_ATTACHMENT |
link_types | ITEM_PROFILE_PHOTO |
link_types | ITEM_PROFILE_ATTACHMENT |
link_types | TRAFFIC_CRASH_ATTACHMENT |
link_types | WARRANT_ATTACHMENT |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Output File Stream Attachments
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}
URL obj = new URL("https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}',
params: {
}
p JSON.parse(result)
import requests
r = requests.get('https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}')
print(r.json())
GET https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id} HTTP/1.1
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
fetch('https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/attachments/stream/{file_id}";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/attachments/stream/{file_id}
Retrieves output file stream attachments according to file ID.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
file_id | path | integer(int64) | true | Attachment file ID |
Responses
Status | Meaning | Description | Model |
---|---|---|---|
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
default | Default | Successful operation | None |
GET: Attachments by ID
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/attachments/{attachment_id} \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/attachments/{attachment_id} HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/attachments/{attachment_id}";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/attachments/{attachment_id}
Retrieves attachments according to attachment ID.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
attachment_id | path | integer(int64) | true | Attachment ID |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
CAD Configuration Endpoints
CAD Configuration Endpoints
allow for the retrieval of unit and station configuration settings.
GET: Configuration Data for All Stations
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/configuration/stations \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/configuration/stations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/configuration/stations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/configuration/stations', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/configuration/stations HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/configuration/stations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/configuration/stations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/configuration/stations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/configuration/stations";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/configuration/stations
Retrieves station configuration settings.
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Configuration Data for Unit States
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/configuration/unit_states";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/configuration/unit_states
Retrieves unit state configuration settings.
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Latest Unit Status for Provided Units
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses?unit_id=0 \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses?unit_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses',
params: {
'unit_id' => 'array[integer]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses', params={
'unit_id': [
0
]
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses?unit_id=0 HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses?unit_id=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/configuration/unit_statuses";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/configuration/unit_statuses
Retrieves the latest unit status information for the provided Mark43 unit IDs.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
unit_id | query | array[integer] | true | List of Mark43 unit IDs |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Configuration Data for All Units
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/configuration/units \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/configuration/units");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/configuration/units',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/configuration/units', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/configuration/units HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/configuration/units', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/configuration/units',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/configuration/units", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/configuration/units";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/configuration/units
Retrieves the configuration settings for all units within a department.
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Configuration Data for specified units
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/configuration/units \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/configuration/units");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/configuration/units',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/configuration/units', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/configuration/units HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/configuration/units', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
0
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/configuration/units',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/configuration/units", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/configuration/units";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/configuration/units
Retrieves the configuration settings for specified units
Body parameter
[
0
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | array[integer] | false | none |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
CAD Event Endpoints
CAD Event Endpoints
allow for the creation and retrieval of CAD Events.
For details on person, organization, item, and location object creation, see Additional Model Information.
POST: CAD Event
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"additionalInfos": [
{
"additionalInfoType": "string",
"author": {},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}
],
"agencyCode": "string",
"agencyId": 0,
"alarmLevel": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventId": 0,
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callForServiceCode": "string",
"callTaker": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"callTakerStationId": "string",
"callerName": "string",
"callerPhoneNumber": "string",
"communicationType": "string",
"disposition": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventLabels": [
{
"cautionLevel": "string",
"externalId": "string",
"externalSystem": "string",
"name": "string",
"priority": "string"
}
],
"eventPriority": "string",
"eventReceivedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketUnitAndMembers": [
{
"externalId": "string",
"externalSystem": "string",
"isPrimaryOnEvent": true,
"unitCallSign": "string",
"unitDispatchNumber": "string",
"unitMember": {},
"unitType": "string"
}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"firstUnitEnrouteDateutc": "2019-08-24T14:15:22Z",
"involvedPeople": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"involvedPersons": [
{
"additionalDetails": {},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {},
"emergencyContacts": [],
"employmentHistories": [],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {},
"homeAddresses": [],
"identifyingMarks": [],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [],
"otherIdentifiers": {},
"personAttributes": [],
"personGangTrackings": [],
"personInjuries": [],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {},
"workAddresses": []
}
],
"involvedUnits": [
{
"activeDateUtc": "2019-08-24T14:15:22Z",
"additionalUnitTypes": [],
"agencyCode": "string",
"agencyOri": "string",
"agencyType": "POLICE",
"comments": "string",
"dispatchAreaId": 0,
"dispatchAreaOverrideId": 0,
"equipmentType": [],
"expirationDateUtc": "2019-08-24T14:15:22Z",
"externalId": "string",
"externalSystem": "string",
"isMemberRequired": true,
"isPrimary": true,
"isTemporary": true,
"radioIds": [],
"stationId": 0,
"stationName": "strin",
"stationOverrideId": 0,
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"tagNumber": "string",
"unitCallSign": "string",
"unitStatuses": [],
"unitType": "string",
"users": []
}
],
"involvedVehicles": [
{
"additionalDetails": {},
"allowCreationWithoutVinOrPlate": true,
"barcodeValues": [],
"bodyStyle": "string",
"bodyStyleDescription": "string",
"category": "string",
"categoryFullName": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"declaredValueUnknown": true,
"description": "string",
"externalId": "string",
"externalSystem": "string",
"forfeitureValue": 0,
"insurancePolicyNumber": "string",
"insuranceProvider": "string",
"intakePerson": "string",
"isBiohazard": true,
"isImpounded": true,
"isInPoliceCustody": true,
"itemAttributes": [],
"licensePlateNumber": "string",
"linkedNames": [],
"make": "string",
"makeNcicCode": "string",
"mark43Id": 0,
"masterId": 0,
"measurement": "string",
"mileage": 0,
"model": "string",
"modelNcicCode": "string",
"otherIdentifiers": {},
"ownerNotified": true,
"primaryColor": "string",
"propertyStatus": "string",
"quantity": 0,
"reasonForCustody": "string",
"recoveredAddress": {},
"recoveredByOther": "string",
"recoveredDateUtc": "2019-08-24T14:15:22Z",
"recoveringOfficer": {},
"registrationState": "string",
"registrationType": "string",
"registrationYear": 0,
"secondaryColor": "string",
"serialNumber": "string",
"size": "string",
"statementOfFacts": "string",
"statusDateUtc": "2019-08-24T14:15:22Z",
"storageFacility": "string",
"storageLocation": "string",
"towingCompany": "string",
"towingCompanyOther": "string",
"towingLocation": "string",
"towingNumber": "string",
"type": "string",
"value": 0,
"vehicleRecoveryType": "string",
"vehicleSearchConsentedTo": true,
"vehicleSearched": true,
"vinNumber": "string",
"yearOfManufacture": 0
}
],
"lastEventClearingComments": "string",
"narrative": "string",
"proQaDeterminantCode": "string",
"radioChannels": [
{
"externalId": "string",
"externalSystem": "string",
"radioChannel": {},
"type": "string"
}
],
"reportingEventNumber": "string",
"reportingEventNumbers": [
{
"agencyCode": "string",
"agencyId": 0,
"agencyOri": "string",
"externalId": "string",
"externalSystem": "string",
"reportingEventNumber": "string"
}
],
"reportingParties": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"reportingPartyLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"reportingPartyNotes": "string",
"reportingPartyPhoneNumber": "string",
"reportingPerson": {
"additionalDetails": {
"property1": "string",
"property2": "string"
},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {
"property1": "string",
"property2": "string"
},
"emergencyContacts": [
{}
],
"employmentHistories": [
{}
],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"homeAddresses": [
{}
],
"identifyingMarks": [
{}
],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [
"string"
],
"otherIdentifiers": {
"property1": "string",
"property2": "string"
},
"personAttributes": [
{}
],
"personGangTrackings": [
{}
],
"personInjuries": [
{}
],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {
"property1": "string",
"property2": "string"
},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [
{}
],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"workAddresses": [
{}
]
},
"secondaryEventType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event";
string json = @"{
""additionalInfos"": [
{
""additionalInfoType"": ""string"",
""author"": {},
""externalId"": ""string"",
""externalSystem"": ""string"",
""text"": ""string""
}
],
""agencyCode"": ""string"",
""agencyId"": 0,
""alarmLevel"": ""string"",
""assignedAgencyOri"": ""string"",
""cadAgencyEventNumber"": ""string"",
""cadCommonEventId"": 0,
""cadCommonEventNumber"": ""string"",
""callDateUtc"": ""2019-08-24T14:15:22Z"",
""callForServiceCode"": ""string"",
""callTaker"": {
""actingRank"": ""string"",
""badgeNumber"": ""string"",
""branch"": ""string"",
""bureau"": ""string"",
""cityIdNumber"": ""string"",
""currentAssignmentDate"": ""2019-08-24T14:15:22Z"",
""currentDutyStatus"": ""string"",
""currentDutyStatusDate"": ""2019-08-24"",
""dateHired"": ""2019-08-24"",
""dateOfBirth"": ""2019-08-24"",
""departmentAgencyId"": 0,
""division"": ""string"",
""employeePhoneNumbers"": [
""string""
],
""employeeTypeAbbrev"": ""string"",
""externalCadId"": ""string"",
""externalHrId"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""firstName"": ""string"",
""gender"": ""string"",
""height"": 0,
""isDisabled"": true,
""isSsoUser"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""mark43UserAccountRoleId"": 0,
""mark43UserGroup"": ""CALL_TAKER"",
""middleName"": ""string"",
""mobileId"": ""string"",
""officerEmploymentType"": ""string"",
""personnelUnit"": ""string"",
""primaryEmail"": ""string"",
""race"": ""string"",
""rank"": ""string"",
""roles"": [
""string""
],
""signatureId"": 0,
""skills"": [
""string""
],
""ssn"": ""string"",
""startDateUtc"": ""2019-08-24T14:15:22Z"",
""stateIdNumber"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""trainingAbbreviations"": [
""string""
],
""trainingIdNumber"": ""string"",
""updatedDateUtc"": ""2019-08-24T14:15:22Z"",
""weight"": 0,
""yearsOfExperience"": 0
},
""callTakerStationId"": ""string"",
""callerName"": ""string"",
""callerPhoneNumber"": ""string"",
""communicationType"": ""string"",
""disposition"": ""string"",
""e911EventNumber"": ""string"",
""eventClosedDateUtc"": ""2019-08-24T14:15:22Z"",
""eventLabels"": [
{
""cautionLevel"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""name"": ""string"",
""priority"": ""string""
}
],
""eventPriority"": ""string"",
""eventReceivedDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStartDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStatus"": ""string"",
""eventType"": ""string"",
""externalCadTicketUnitAndMembers"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""isPrimaryOnEvent"": true,
""unitCallSign"": ""string"",
""unitDispatchNumber"": ""string"",
""unitMember"": {},
""unitType"": ""string""
}
],
""externalId"": ""string"",
""externalLocation"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""externalSystem"": ""string"",
""firstUnitArrivalDateUtc"": ""2019-08-24T14:15:22Z"",
""firstUnitDispatchDateUtc"": ""2019-08-24T14:15:22Z"",
""firstUnitEnrouteDateutc"": ""2019-08-24T14:15:22Z"",
""involvedPeople"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""involvementType"": ""string"",
""note"": ""string"",
""personProfile"": {},
""phoneNumber"": ""string""
}
],
""involvedPersons"": [
{
""additionalDetails"": {},
""build"": ""string"",
""citizenship"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""dateOfBirth"": ""2019-08-24"",
""dateOfBirthRangeEnd"": ""2019-08-24"",
""dateOfBirthRangeStart"": ""2019-08-24"",
""dateOfDeath"": ""2019-08-24T14:15:22Z"",
""declaredDateOfDeath"": ""2019-08-24"",
""description"": ""string"",
""email"": ""string"",
""emailType"": ""string"",
""emails"": {},
""emergencyContacts"": [],
""employmentHistories"": [],
""ethnicity"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""eyeColor"": ""string"",
""facialHair"": ""string"",
""fbiNumber"": ""string"",
""firstName"": ""string"",
""hairColor"": ""string"",
""hairLength"": ""string"",
""hairStyle"": ""string"",
""hasNoFixedHomeAddress"": true,
""height"": 0,
""homeAddress"": {},
""homeAddresses"": [],
""identifyingMarks"": [],
""involvement"": ""INVOLVED_PERSON_IN_REPORT"",
""involvementSequenceNumber"": 0,
""isDateOfBirthUnknown"": true,
""isJuvenile"": true,
""isNonDisclosureRequest"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""licenseState"": ""string"",
""licenseStatus"": ""string"",
""licenseType"": ""string"",
""maritalStatus"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""maxHeight"": 0,
""maxWeight"": 0,
""middleName"": ""string"",
""minHeight"": 0,
""minWeight"": 0,
""mugshotWebServerFilePath"": ""string"",
""needsInterpreter"": true,
""nickname"": ""string"",
""nicknames"": [],
""otherIdentifiers"": {},
""personAttributes"": [],
""personGangTrackings"": [],
""personInjuries"": [],
""phoneNumber"": ""string"",
""phoneNumberType"": ""string"",
""phoneNumbers"": {},
""placeOfBirth"": ""string"",
""race"": ""string"",
""residentStatus"": ""string"",
""schoolHistories"": [],
""sex"": ""string"",
""skinTone"": ""string"",
""ssn"": ""string"",
""stateIdNumber"": ""string"",
""stateOfBirth"": ""string"",
""subjectType"": ""string"",
""subjectTypeDescription"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""vision"": ""string"",
""weight"": 0,
""workAddress"": {},
""workAddresses"": []
}
],
""involvedUnits"": [
{
""activeDateUtc"": ""2019-08-24T14:15:22Z"",
""additionalUnitTypes"": [],
""agencyCode"": ""string"",
""agencyOri"": ""string"",
""agencyType"": ""POLICE"",
""comments"": ""string"",
""dispatchAreaId"": 0,
""dispatchAreaOverrideId"": 0,
""equipmentType"": [],
""expirationDateUtc"": ""2019-08-24T14:15:22Z"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""isMemberRequired"": true,
""isPrimary"": true,
""isTemporary"": true,
""radioIds"": [],
""stationId"": 0,
""stationName"": ""strin"",
""stationOverrideId"": 0,
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""tagNumber"": ""string"",
""unitCallSign"": ""string"",
""unitStatuses"": [],
""unitType"": ""string"",
""users"": []
}
],
""involvedVehicles"": [
{
""additionalDetails"": {},
""allowCreationWithoutVinOrPlate"": true,
""barcodeValues"": [],
""bodyStyle"": ""string"",
""bodyStyleDescription"": ""string"",
""category"": ""string"",
""categoryFullName"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""declaredValueUnknown"": true,
""description"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""forfeitureValue"": 0,
""insurancePolicyNumber"": ""string"",
""insuranceProvider"": ""string"",
""intakePerson"": ""string"",
""isBiohazard"": true,
""isImpounded"": true,
""isInPoliceCustody"": true,
""itemAttributes"": [],
""licensePlateNumber"": ""string"",
""linkedNames"": [],
""make"": ""string"",
""makeNcicCode"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""measurement"": ""string"",
""mileage"": 0,
""model"": ""string"",
""modelNcicCode"": ""string"",
""otherIdentifiers"": {},
""ownerNotified"": true,
""primaryColor"": ""string"",
""propertyStatus"": ""string"",
""quantity"": 0,
""reasonForCustody"": ""string"",
""recoveredAddress"": {},
""recoveredByOther"": ""string"",
""recoveredDateUtc"": ""2019-08-24T14:15:22Z"",
""recoveringOfficer"": {},
""registrationState"": ""string"",
""registrationType"": ""string"",
""registrationYear"": 0,
""secondaryColor"": ""string"",
""serialNumber"": ""string"",
""size"": ""string"",
""statementOfFacts"": ""string"",
""statusDateUtc"": ""2019-08-24T14:15:22Z"",
""storageFacility"": ""string"",
""storageLocation"": ""string"",
""towingCompany"": ""string"",
""towingCompanyOther"": ""string"",
""towingLocation"": ""string"",
""towingNumber"": ""string"",
""type"": ""string"",
""value"": 0,
""vehicleRecoveryType"": ""string"",
""vehicleSearchConsentedTo"": true,
""vehicleSearched"": true,
""vinNumber"": ""string"",
""yearOfManufacture"": 0
}
],
""lastEventClearingComments"": ""string"",
""narrative"": ""string"",
""proQaDeterminantCode"": ""string"",
""radioChannels"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""radioChannel"": {},
""type"": ""string""
}
],
""reportingEventNumber"": ""string"",
""reportingEventNumbers"": [
{
""agencyCode"": ""string"",
""agencyId"": 0,
""agencyOri"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""reportingEventNumber"": ""string""
}
],
""reportingParties"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""involvementType"": ""string"",
""note"": ""string"",
""personProfile"": {},
""phoneNumber"": ""string""
}
],
""reportingPartyLocation"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""reportingPartyNotes"": ""string"",
""reportingPartyPhoneNumber"": ""string"",
""reportingPerson"": {
""additionalDetails"": {
""property1"": ""string"",
""property2"": ""string""
},
""build"": ""string"",
""citizenship"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""dateOfBirth"": ""2019-08-24"",
""dateOfBirthRangeEnd"": ""2019-08-24"",
""dateOfBirthRangeStart"": ""2019-08-24"",
""dateOfDeath"": ""2019-08-24T14:15:22Z"",
""declaredDateOfDeath"": ""2019-08-24"",
""description"": ""string"",
""email"": ""string"",
""emailType"": ""string"",
""emails"": {
""property1"": ""string"",
""property2"": ""string""
},
""emergencyContacts"": [
{}
],
""employmentHistories"": [
{}
],
""ethnicity"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""eyeColor"": ""string"",
""facialHair"": ""string"",
""fbiNumber"": ""string"",
""firstName"": ""string"",
""hairColor"": ""string"",
""hairLength"": ""string"",
""hairStyle"": ""string"",
""hasNoFixedHomeAddress"": true,
""height"": 0,
""homeAddress"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""homeAddresses"": [
{}
],
""identifyingMarks"": [
{}
],
""involvement"": ""INVOLVED_PERSON_IN_REPORT"",
""involvementSequenceNumber"": 0,
""isDateOfBirthUnknown"": true,
""isJuvenile"": true,
""isNonDisclosureRequest"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""licenseState"": ""string"",
""licenseStatus"": ""string"",
""licenseType"": ""string"",
""maritalStatus"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""maxHeight"": 0,
""maxWeight"": 0,
""middleName"": ""string"",
""minHeight"": 0,
""minWeight"": 0,
""mugshotWebServerFilePath"": ""string"",
""needsInterpreter"": true,
""nickname"": ""string"",
""nicknames"": [
""string""
],
""otherIdentifiers"": {
""property1"": ""string"",
""property2"": ""string""
},
""personAttributes"": [
{}
],
""personGangTrackings"": [
{}
],
""personInjuries"": [
{}
],
""phoneNumber"": ""string"",
""phoneNumberType"": ""string"",
""phoneNumbers"": {
""property1"": ""string"",
""property2"": ""string""
},
""placeOfBirth"": ""string"",
""race"": ""string"",
""residentStatus"": ""string"",
""schoolHistories"": [
{}
],
""sex"": ""string"",
""skinTone"": ""string"",
""ssn"": ""string"",
""stateIdNumber"": ""string"",
""stateOfBirth"": ""string"",
""subjectType"": ""string"",
""subjectTypeDescription"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""vision"": ""string"",
""weight"": 0,
""workAddress"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""workAddresses"": [
{}
]
},
""secondaryEventType"": ""string""
}";
ExternalCadEvent content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalCadEvent content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalCadEvent content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event
Creates a CAD Event in the Unassigned Events dispatch queue.
Body parameter
{
"additionalInfos": [
{
"additionalInfoType": "string",
"author": {},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}
],
"agencyCode": "string",
"agencyId": 0,
"alarmLevel": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventId": 0,
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callForServiceCode": "string",
"callTaker": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"callTakerStationId": "string",
"callerName": "string",
"callerPhoneNumber": "string",
"communicationType": "string",
"disposition": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventLabels": [
{
"cautionLevel": "string",
"externalId": "string",
"externalSystem": "string",
"name": "string",
"priority": "string"
}
],
"eventPriority": "string",
"eventReceivedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketUnitAndMembers": [
{
"externalId": "string",
"externalSystem": "string",
"isPrimaryOnEvent": true,
"unitCallSign": "string",
"unitDispatchNumber": "string",
"unitMember": {},
"unitType": "string"
}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"firstUnitEnrouteDateutc": "2019-08-24T14:15:22Z",
"involvedPeople": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"involvedPersons": [
{
"additionalDetails": {},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {},
"emergencyContacts": [],
"employmentHistories": [],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {},
"homeAddresses": [],
"identifyingMarks": [],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [],
"otherIdentifiers": {},
"personAttributes": [],
"personGangTrackings": [],
"personInjuries": [],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {},
"workAddresses": []
}
],
"involvedUnits": [
{
"activeDateUtc": "2019-08-24T14:15:22Z",
"additionalUnitTypes": [],
"agencyCode": "string",
"agencyOri": "string",
"agencyType": "POLICE",
"comments": "string",
"dispatchAreaId": 0,
"dispatchAreaOverrideId": 0,
"equipmentType": [],
"expirationDateUtc": "2019-08-24T14:15:22Z",
"externalId": "string",
"externalSystem": "string",
"isMemberRequired": true,
"isPrimary": true,
"isTemporary": true,
"radioIds": [],
"stationId": 0,
"stationName": "strin",
"stationOverrideId": 0,
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"tagNumber": "string",
"unitCallSign": "string",
"unitStatuses": [],
"unitType": "string",
"users": []
}
],
"involvedVehicles": [
{
"additionalDetails": {},
"allowCreationWithoutVinOrPlate": true,
"barcodeValues": [],
"bodyStyle": "string",
"bodyStyleDescription": "string",
"category": "string",
"categoryFullName": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"declaredValueUnknown": true,
"description": "string",
"externalId": "string",
"externalSystem": "string",
"forfeitureValue": 0,
"insurancePolicyNumber": "string",
"insuranceProvider": "string",
"intakePerson": "string",
"isBiohazard": true,
"isImpounded": true,
"isInPoliceCustody": true,
"itemAttributes": [],
"licensePlateNumber": "string",
"linkedNames": [],
"make": "string",
"makeNcicCode": "string",
"mark43Id": 0,
"masterId": 0,
"measurement": "string",
"mileage": 0,
"model": "string",
"modelNcicCode": "string",
"otherIdentifiers": {},
"ownerNotified": true,
"primaryColor": "string",
"propertyStatus": "string",
"quantity": 0,
"reasonForCustody": "string",
"recoveredAddress": {},
"recoveredByOther": "string",
"recoveredDateUtc": "2019-08-24T14:15:22Z",
"recoveringOfficer": {},
"registrationState": "string",
"registrationType": "string",
"registrationYear": 0,
"secondaryColor": "string",
"serialNumber": "string",
"size": "string",
"statementOfFacts": "string",
"statusDateUtc": "2019-08-24T14:15:22Z",
"storageFacility": "string",
"storageLocation": "string",
"towingCompany": "string",
"towingCompanyOther": "string",
"towingLocation": "string",
"towingNumber": "string",
"type": "string",
"value": 0,
"vehicleRecoveryType": "string",
"vehicleSearchConsentedTo": true,
"vehicleSearched": true,
"vinNumber": "string",
"yearOfManufacture": 0
}
],
"lastEventClearingComments": "string",
"narrative": "string",
"proQaDeterminantCode": "string",
"radioChannels": [
{
"externalId": "string",
"externalSystem": "string",
"radioChannel": {},
"type": "string"
}
],
"reportingEventNumber": "string",
"reportingEventNumbers": [
{
"agencyCode": "string",
"agencyId": 0,
"agencyOri": "string",
"externalId": "string",
"externalSystem": "string",
"reportingEventNumber": "string"
}
],
"reportingParties": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"reportingPartyLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"reportingPartyNotes": "string",
"reportingPartyPhoneNumber": "string",
"reportingPerson": {
"additionalDetails": {
"property1": "string",
"property2": "string"
},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {
"property1": "string",
"property2": "string"
},
"emergencyContacts": [
{}
],
"employmentHistories": [
{}
],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"homeAddresses": [
{}
],
"identifyingMarks": [
{}
],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [
"string"
],
"otherIdentifiers": {
"property1": "string",
"property2": "string"
},
"personAttributes": [
{}
],
"personGangTrackings": [
{}
],
"personInjuries": [
{}
],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {
"property1": "string",
"property2": "string"
},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [
{}
],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"workAddresses": [
{}
]
},
"secondaryEventType": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | ExternalCadEvent | true | CAD Event to be created |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: CAD Additional Information
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/additional_info \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/additional_info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/additional_info',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/additional_info', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/additional_info HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/additional_info', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"additionalInfoType": "string",
"author": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/additional_info',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/additional_info", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/additional_info";
string json = @"{
""additionalInfoType"": ""string"",
""author"": {
""actingRank"": ""string"",
""badgeNumber"": ""string"",
""branch"": ""string"",
""bureau"": ""string"",
""cityIdNumber"": ""string"",
""currentAssignmentDate"": ""2019-08-24T14:15:22Z"",
""currentDutyStatus"": ""string"",
""currentDutyStatusDate"": ""2019-08-24"",
""dateHired"": ""2019-08-24"",
""dateOfBirth"": ""2019-08-24"",
""departmentAgencyId"": 0,
""division"": ""string"",
""employeePhoneNumbers"": [
""string""
],
""employeeTypeAbbrev"": ""string"",
""externalCadId"": ""string"",
""externalHrId"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""firstName"": ""string"",
""gender"": ""string"",
""height"": 0,
""isDisabled"": true,
""isSsoUser"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""mark43UserAccountRoleId"": 0,
""mark43UserGroup"": ""CALL_TAKER"",
""middleName"": ""string"",
""mobileId"": ""string"",
""officerEmploymentType"": ""string"",
""personnelUnit"": ""string"",
""primaryEmail"": ""string"",
""race"": ""string"",
""rank"": ""string"",
""roles"": [
""string""
],
""signatureId"": 0,
""skills"": [
""string""
],
""ssn"": ""string"",
""startDateUtc"": ""2019-08-24T14:15:22Z"",
""stateIdNumber"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""trainingAbbreviations"": [
""string""
],
""trainingIdNumber"": ""string"",
""updatedDateUtc"": ""2019-08-24T14:15:22Z"",
""weight"": 0,
""yearsOfExperience"": 0
},
""externalId"": ""string"",
""externalSystem"": ""string"",
""text"": ""string""
}";
ExternalCadAdditionalInfo content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalCadAdditionalInfo content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalCadAdditionalInfo content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/additional_info
Creates additional information to be added to a CAD Event according to Agency Event ID or Agency Event Number. The Event ID or Event Number must be provided.
Body parameter
{
"additionalInfoType": "string",
"author": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
agency_event_id | query | integer(int64) | false | Agency Event ID for which additional information is created |
agency_event_number | query | string | false | Agency Event Number for which additional information is created |
body | body | ExternalCadAdditionalInfo | false | Additional information to create |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Scheduled CAD Events for department
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/event/scheduled \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/event/scheduled', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/event/scheduled HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/event/scheduled', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/event/scheduled
Retrieves scheduled CAD events for the department id of the requesting api token.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start_date_utc | query | string | false | start of the range, must be provided in UTC timezone |
end_date_utc | query | string | false | end of the range, must be provided in UTC timezone |
size | query | integer(int32) | false | pagination size |
from | query | integer(int32) | false | pagination from |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Schedule CAD Event
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled?start_date_utc=string \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled?start_date_utc=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled',
params: {
'start_date_utc' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/scheduled', params={
'start_date_utc': 'string'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled?start_date_utc=string HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/scheduled', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"additionalInfos": [
{
"additionalInfoType": "string",
"author": {},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}
],
"agencyCode": "string",
"agencyId": 0,
"alarmLevel": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventId": 0,
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callForServiceCode": "string",
"callTaker": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"callTakerStationId": "string",
"callerName": "string",
"callerPhoneNumber": "string",
"communicationType": "string",
"disposition": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventLabels": [
{
"cautionLevel": "string",
"externalId": "string",
"externalSystem": "string",
"name": "string",
"priority": "string"
}
],
"eventPriority": "string",
"eventReceivedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketUnitAndMembers": [
{
"externalId": "string",
"externalSystem": "string",
"isPrimaryOnEvent": true,
"unitCallSign": "string",
"unitDispatchNumber": "string",
"unitMember": {},
"unitType": "string"
}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"firstUnitEnrouteDateutc": "2019-08-24T14:15:22Z",
"involvedPeople": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"involvedPersons": [
{
"additionalDetails": {},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {},
"emergencyContacts": [],
"employmentHistories": [],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {},
"homeAddresses": [],
"identifyingMarks": [],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [],
"otherIdentifiers": {},
"personAttributes": [],
"personGangTrackings": [],
"personInjuries": [],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {},
"workAddresses": []
}
],
"involvedUnits": [
{
"activeDateUtc": "2019-08-24T14:15:22Z",
"additionalUnitTypes": [],
"agencyCode": "string",
"agencyOri": "string",
"agencyType": "POLICE",
"comments": "string",
"dispatchAreaId": 0,
"dispatchAreaOverrideId": 0,
"equipmentType": [],
"expirationDateUtc": "2019-08-24T14:15:22Z",
"externalId": "string",
"externalSystem": "string",
"isMemberRequired": true,
"isPrimary": true,
"isTemporary": true,
"radioIds": [],
"stationId": 0,
"stationName": "strin",
"stationOverrideId": 0,
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"tagNumber": "string",
"unitCallSign": "string",
"unitStatuses": [],
"unitType": "string",
"users": []
}
],
"involvedVehicles": [
{
"additionalDetails": {},
"allowCreationWithoutVinOrPlate": true,
"barcodeValues": [],
"bodyStyle": "string",
"bodyStyleDescription": "string",
"category": "string",
"categoryFullName": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"declaredValueUnknown": true,
"description": "string",
"externalId": "string",
"externalSystem": "string",
"forfeitureValue": 0,
"insurancePolicyNumber": "string",
"insuranceProvider": "string",
"intakePerson": "string",
"isBiohazard": true,
"isImpounded": true,
"isInPoliceCustody": true,
"itemAttributes": [],
"licensePlateNumber": "string",
"linkedNames": [],
"make": "string",
"makeNcicCode": "string",
"mark43Id": 0,
"masterId": 0,
"measurement": "string",
"mileage": 0,
"model": "string",
"modelNcicCode": "string",
"otherIdentifiers": {},
"ownerNotified": true,
"primaryColor": "string",
"propertyStatus": "string",
"quantity": 0,
"reasonForCustody": "string",
"recoveredAddress": {},
"recoveredByOther": "string",
"recoveredDateUtc": "2019-08-24T14:15:22Z",
"recoveringOfficer": {},
"registrationState": "string",
"registrationType": "string",
"registrationYear": 0,
"secondaryColor": "string",
"serialNumber": "string",
"size": "string",
"statementOfFacts": "string",
"statusDateUtc": "2019-08-24T14:15:22Z",
"storageFacility": "string",
"storageLocation": "string",
"towingCompany": "string",
"towingCompanyOther": "string",
"towingLocation": "string",
"towingNumber": "string",
"type": "string",
"value": 0,
"vehicleRecoveryType": "string",
"vehicleSearchConsentedTo": true,
"vehicleSearched": true,
"vinNumber": "string",
"yearOfManufacture": 0
}
],
"lastEventClearingComments": "string",
"narrative": "string",
"proQaDeterminantCode": "string",
"radioChannels": [
{
"externalId": "string",
"externalSystem": "string",
"radioChannel": {},
"type": "string"
}
],
"reportingEventNumber": "string",
"reportingEventNumbers": [
{
"agencyCode": "string",
"agencyId": 0,
"agencyOri": "string",
"externalId": "string",
"externalSystem": "string",
"reportingEventNumber": "string"
}
],
"reportingParties": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"reportingPartyLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"reportingPartyNotes": "string",
"reportingPartyPhoneNumber": "string",
"reportingPerson": {
"additionalDetails": {
"property1": "string",
"property2": "string"
},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {
"property1": "string",
"property2": "string"
},
"emergencyContacts": [
{}
],
"employmentHistories": [
{}
],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"homeAddresses": [
{}
],
"identifyingMarks": [
{}
],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [
"string"
],
"otherIdentifiers": {
"property1": "string",
"property2": "string"
},
"personAttributes": [
{}
],
"personGangTrackings": [
{}
],
"personInjuries": [
{}
],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {
"property1": "string",
"property2": "string"
},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [
{}
],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"workAddresses": [
{}
]
},
"secondaryEventType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled?start_date_utc=string',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled";
string json = @"{
""additionalInfos"": [
{
""additionalInfoType"": ""string"",
""author"": {},
""externalId"": ""string"",
""externalSystem"": ""string"",
""text"": ""string""
}
],
""agencyCode"": ""string"",
""agencyId"": 0,
""alarmLevel"": ""string"",
""assignedAgencyOri"": ""string"",
""cadAgencyEventNumber"": ""string"",
""cadCommonEventId"": 0,
""cadCommonEventNumber"": ""string"",
""callDateUtc"": ""2019-08-24T14:15:22Z"",
""callForServiceCode"": ""string"",
""callTaker"": {
""actingRank"": ""string"",
""badgeNumber"": ""string"",
""branch"": ""string"",
""bureau"": ""string"",
""cityIdNumber"": ""string"",
""currentAssignmentDate"": ""2019-08-24T14:15:22Z"",
""currentDutyStatus"": ""string"",
""currentDutyStatusDate"": ""2019-08-24"",
""dateHired"": ""2019-08-24"",
""dateOfBirth"": ""2019-08-24"",
""departmentAgencyId"": 0,
""division"": ""string"",
""employeePhoneNumbers"": [
""string""
],
""employeeTypeAbbrev"": ""string"",
""externalCadId"": ""string"",
""externalHrId"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""firstName"": ""string"",
""gender"": ""string"",
""height"": 0,
""isDisabled"": true,
""isSsoUser"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""mark43UserAccountRoleId"": 0,
""mark43UserGroup"": ""CALL_TAKER"",
""middleName"": ""string"",
""mobileId"": ""string"",
""officerEmploymentType"": ""string"",
""personnelUnit"": ""string"",
""primaryEmail"": ""string"",
""race"": ""string"",
""rank"": ""string"",
""roles"": [
""string""
],
""signatureId"": 0,
""skills"": [
""string""
],
""ssn"": ""string"",
""startDateUtc"": ""2019-08-24T14:15:22Z"",
""stateIdNumber"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""trainingAbbreviations"": [
""string""
],
""trainingIdNumber"": ""string"",
""updatedDateUtc"": ""2019-08-24T14:15:22Z"",
""weight"": 0,
""yearsOfExperience"": 0
},
""callTakerStationId"": ""string"",
""callerName"": ""string"",
""callerPhoneNumber"": ""string"",
""communicationType"": ""string"",
""disposition"": ""string"",
""e911EventNumber"": ""string"",
""eventClosedDateUtc"": ""2019-08-24T14:15:22Z"",
""eventLabels"": [
{
""cautionLevel"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""name"": ""string"",
""priority"": ""string""
}
],
""eventPriority"": ""string"",
""eventReceivedDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStartDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStatus"": ""string"",
""eventType"": ""string"",
""externalCadTicketUnitAndMembers"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""isPrimaryOnEvent"": true,
""unitCallSign"": ""string"",
""unitDispatchNumber"": ""string"",
""unitMember"": {},
""unitType"": ""string""
}
],
""externalId"": ""string"",
""externalLocation"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""externalSystem"": ""string"",
""firstUnitArrivalDateUtc"": ""2019-08-24T14:15:22Z"",
""firstUnitDispatchDateUtc"": ""2019-08-24T14:15:22Z"",
""firstUnitEnrouteDateutc"": ""2019-08-24T14:15:22Z"",
""involvedPeople"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""involvementType"": ""string"",
""note"": ""string"",
""personProfile"": {},
""phoneNumber"": ""string""
}
],
""involvedPersons"": [
{
""additionalDetails"": {},
""build"": ""string"",
""citizenship"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""dateOfBirth"": ""2019-08-24"",
""dateOfBirthRangeEnd"": ""2019-08-24"",
""dateOfBirthRangeStart"": ""2019-08-24"",
""dateOfDeath"": ""2019-08-24T14:15:22Z"",
""declaredDateOfDeath"": ""2019-08-24"",
""description"": ""string"",
""email"": ""string"",
""emailType"": ""string"",
""emails"": {},
""emergencyContacts"": [],
""employmentHistories"": [],
""ethnicity"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""eyeColor"": ""string"",
""facialHair"": ""string"",
""fbiNumber"": ""string"",
""firstName"": ""string"",
""hairColor"": ""string"",
""hairLength"": ""string"",
""hairStyle"": ""string"",
""hasNoFixedHomeAddress"": true,
""height"": 0,
""homeAddress"": {},
""homeAddresses"": [],
""identifyingMarks"": [],
""involvement"": ""INVOLVED_PERSON_IN_REPORT"",
""involvementSequenceNumber"": 0,
""isDateOfBirthUnknown"": true,
""isJuvenile"": true,
""isNonDisclosureRequest"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""licenseState"": ""string"",
""licenseStatus"": ""string"",
""licenseType"": ""string"",
""maritalStatus"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""maxHeight"": 0,
""maxWeight"": 0,
""middleName"": ""string"",
""minHeight"": 0,
""minWeight"": 0,
""mugshotWebServerFilePath"": ""string"",
""needsInterpreter"": true,
""nickname"": ""string"",
""nicknames"": [],
""otherIdentifiers"": {},
""personAttributes"": [],
""personGangTrackings"": [],
""personInjuries"": [],
""phoneNumber"": ""string"",
""phoneNumberType"": ""string"",
""phoneNumbers"": {},
""placeOfBirth"": ""string"",
""race"": ""string"",
""residentStatus"": ""string"",
""schoolHistories"": [],
""sex"": ""string"",
""skinTone"": ""string"",
""ssn"": ""string"",
""stateIdNumber"": ""string"",
""stateOfBirth"": ""string"",
""subjectType"": ""string"",
""subjectTypeDescription"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""vision"": ""string"",
""weight"": 0,
""workAddress"": {},
""workAddresses"": []
}
],
""involvedUnits"": [
{
""activeDateUtc"": ""2019-08-24T14:15:22Z"",
""additionalUnitTypes"": [],
""agencyCode"": ""string"",
""agencyOri"": ""string"",
""agencyType"": ""POLICE"",
""comments"": ""string"",
""dispatchAreaId"": 0,
""dispatchAreaOverrideId"": 0,
""equipmentType"": [],
""expirationDateUtc"": ""2019-08-24T14:15:22Z"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""isMemberRequired"": true,
""isPrimary"": true,
""isTemporary"": true,
""radioIds"": [],
""stationId"": 0,
""stationName"": ""strin"",
""stationOverrideId"": 0,
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""tagNumber"": ""string"",
""unitCallSign"": ""string"",
""unitStatuses"": [],
""unitType"": ""string"",
""users"": []
}
],
""involvedVehicles"": [
{
""additionalDetails"": {},
""allowCreationWithoutVinOrPlate"": true,
""barcodeValues"": [],
""bodyStyle"": ""string"",
""bodyStyleDescription"": ""string"",
""category"": ""string"",
""categoryFullName"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""declaredValueUnknown"": true,
""description"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""forfeitureValue"": 0,
""insurancePolicyNumber"": ""string"",
""insuranceProvider"": ""string"",
""intakePerson"": ""string"",
""isBiohazard"": true,
""isImpounded"": true,
""isInPoliceCustody"": true,
""itemAttributes"": [],
""licensePlateNumber"": ""string"",
""linkedNames"": [],
""make"": ""string"",
""makeNcicCode"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""measurement"": ""string"",
""mileage"": 0,
""model"": ""string"",
""modelNcicCode"": ""string"",
""otherIdentifiers"": {},
""ownerNotified"": true,
""primaryColor"": ""string"",
""propertyStatus"": ""string"",
""quantity"": 0,
""reasonForCustody"": ""string"",
""recoveredAddress"": {},
""recoveredByOther"": ""string"",
""recoveredDateUtc"": ""2019-08-24T14:15:22Z"",
""recoveringOfficer"": {},
""registrationState"": ""string"",
""registrationType"": ""string"",
""registrationYear"": 0,
""secondaryColor"": ""string"",
""serialNumber"": ""string"",
""size"": ""string"",
""statementOfFacts"": ""string"",
""statusDateUtc"": ""2019-08-24T14:15:22Z"",
""storageFacility"": ""string"",
""storageLocation"": ""string"",
""towingCompany"": ""string"",
""towingCompanyOther"": ""string"",
""towingLocation"": ""string"",
""towingNumber"": ""string"",
""type"": ""string"",
""value"": 0,
""vehicleRecoveryType"": ""string"",
""vehicleSearchConsentedTo"": true,
""vehicleSearched"": true,
""vinNumber"": ""string"",
""yearOfManufacture"": 0
}
],
""lastEventClearingComments"": ""string"",
""narrative"": ""string"",
""proQaDeterminantCode"": ""string"",
""radioChannels"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""radioChannel"": {},
""type"": ""string""
}
],
""reportingEventNumber"": ""string"",
""reportingEventNumbers"": [
{
""agencyCode"": ""string"",
""agencyId"": 0,
""agencyOri"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""reportingEventNumber"": ""string""
}
],
""reportingParties"": [
{
""externalId"": ""string"",
""externalSystem"": ""string"",
""involvementType"": ""string"",
""note"": ""string"",
""personProfile"": {},
""phoneNumber"": ""string""
}
],
""reportingPartyLocation"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""reportingPartyNotes"": ""string"",
""reportingPartyPhoneNumber"": ""string"",
""reportingPerson"": {
""additionalDetails"": {
""property1"": ""string"",
""property2"": ""string""
},
""build"": ""string"",
""citizenship"": ""string"",
""contextId"": 0,
""contextType"": ""WARRANT"",
""contextualId"": 0,
""dateOfBirth"": ""2019-08-24"",
""dateOfBirthRangeEnd"": ""2019-08-24"",
""dateOfBirthRangeStart"": ""2019-08-24"",
""dateOfDeath"": ""2019-08-24T14:15:22Z"",
""declaredDateOfDeath"": ""2019-08-24"",
""description"": ""string"",
""email"": ""string"",
""emailType"": ""string"",
""emails"": {
""property1"": ""string"",
""property2"": ""string""
},
""emergencyContacts"": [
{}
],
""employmentHistories"": [
{}
],
""ethnicity"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""eyeColor"": ""string"",
""facialHair"": ""string"",
""fbiNumber"": ""string"",
""firstName"": ""string"",
""hairColor"": ""string"",
""hairLength"": ""string"",
""hairStyle"": ""string"",
""hasNoFixedHomeAddress"": true,
""height"": 0,
""homeAddress"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""homeAddresses"": [
{}
],
""identifyingMarks"": [
{}
],
""involvement"": ""INVOLVED_PERSON_IN_REPORT"",
""involvementSequenceNumber"": 0,
""isDateOfBirthUnknown"": true,
""isJuvenile"": true,
""isNonDisclosureRequest"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""licenseState"": ""string"",
""licenseStatus"": ""string"",
""licenseType"": ""string"",
""maritalStatus"": ""string"",
""mark43Id"": 0,
""masterId"": 0,
""maxHeight"": 0,
""maxWeight"": 0,
""middleName"": ""string"",
""minHeight"": 0,
""minWeight"": 0,
""mugshotWebServerFilePath"": ""string"",
""needsInterpreter"": true,
""nickname"": ""string"",
""nicknames"": [
""string""
],
""otherIdentifiers"": {
""property1"": ""string"",
""property2"": ""string""
},
""personAttributes"": [
{}
],
""personGangTrackings"": [
{}
],
""personInjuries"": [
{}
],
""phoneNumber"": ""string"",
""phoneNumberType"": ""string"",
""phoneNumbers"": {
""property1"": ""string"",
""property2"": ""string""
},
""placeOfBirth"": ""string"",
""race"": ""string"",
""residentStatus"": ""string"",
""schoolHistories"": [
{}
],
""sex"": ""string"",
""skinTone"": ""string"",
""ssn"": ""string"",
""stateIdNumber"": ""string"",
""stateOfBirth"": ""string"",
""subjectType"": ""string"",
""subjectTypeDescription"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""vision"": ""string"",
""weight"": 0,
""workAddress"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""workAddresses"": [
{}
]
},
""secondaryEventType"": ""string""
}";
ExternalCadEvent content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalCadEvent content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalCadEvent content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/scheduled
Schedules a CAD Event to be created at the specified time
Body parameter
{
"additionalInfos": [
{
"additionalInfoType": "string",
"author": {},
"externalId": "string",
"externalSystem": "string",
"text": "string"
}
],
"agencyCode": "string",
"agencyId": 0,
"alarmLevel": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventId": 0,
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callForServiceCode": "string",
"callTaker": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [
"string"
],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [
"string"
],
"signatureId": 0,
"skills": [
"string"
],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [
"string"
],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"callTakerStationId": "string",
"callerName": "string",
"callerPhoneNumber": "string",
"communicationType": "string",
"disposition": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventLabels": [
{
"cautionLevel": "string",
"externalId": "string",
"externalSystem": "string",
"name": "string",
"priority": "string"
}
],
"eventPriority": "string",
"eventReceivedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketUnitAndMembers": [
{
"externalId": "string",
"externalSystem": "string",
"isPrimaryOnEvent": true,
"unitCallSign": "string",
"unitDispatchNumber": "string",
"unitMember": {},
"unitType": "string"
}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"firstUnitEnrouteDateutc": "2019-08-24T14:15:22Z",
"involvedPeople": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"involvedPersons": [
{
"additionalDetails": {},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {},
"emergencyContacts": [],
"employmentHistories": [],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {},
"homeAddresses": [],
"identifyingMarks": [],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [],
"otherIdentifiers": {},
"personAttributes": [],
"personGangTrackings": [],
"personInjuries": [],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {},
"workAddresses": []
}
],
"involvedUnits": [
{
"activeDateUtc": "2019-08-24T14:15:22Z",
"additionalUnitTypes": [],
"agencyCode": "string",
"agencyOri": "string",
"agencyType": "POLICE",
"comments": "string",
"dispatchAreaId": 0,
"dispatchAreaOverrideId": 0,
"equipmentType": [],
"expirationDateUtc": "2019-08-24T14:15:22Z",
"externalId": "string",
"externalSystem": "string",
"isMemberRequired": true,
"isPrimary": true,
"isTemporary": true,
"radioIds": [],
"stationId": 0,
"stationName": "strin",
"stationOverrideId": 0,
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"tagNumber": "string",
"unitCallSign": "string",
"unitStatuses": [],
"unitType": "string",
"users": []
}
],
"involvedVehicles": [
{
"additionalDetails": {},
"allowCreationWithoutVinOrPlate": true,
"barcodeValues": [],
"bodyStyle": "string",
"bodyStyleDescription": "string",
"category": "string",
"categoryFullName": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"declaredValueUnknown": true,
"description": "string",
"externalId": "string",
"externalSystem": "string",
"forfeitureValue": 0,
"insurancePolicyNumber": "string",
"insuranceProvider": "string",
"intakePerson": "string",
"isBiohazard": true,
"isImpounded": true,
"isInPoliceCustody": true,
"itemAttributes": [],
"licensePlateNumber": "string",
"linkedNames": [],
"make": "string",
"makeNcicCode": "string",
"mark43Id": 0,
"masterId": 0,
"measurement": "string",
"mileage": 0,
"model": "string",
"modelNcicCode": "string",
"otherIdentifiers": {},
"ownerNotified": true,
"primaryColor": "string",
"propertyStatus": "string",
"quantity": 0,
"reasonForCustody": "string",
"recoveredAddress": {},
"recoveredByOther": "string",
"recoveredDateUtc": "2019-08-24T14:15:22Z",
"recoveringOfficer": {},
"registrationState": "string",
"registrationType": "string",
"registrationYear": 0,
"secondaryColor": "string",
"serialNumber": "string",
"size": "string",
"statementOfFacts": "string",
"statusDateUtc": "2019-08-24T14:15:22Z",
"storageFacility": "string",
"storageLocation": "string",
"towingCompany": "string",
"towingCompanyOther": "string",
"towingLocation": "string",
"towingNumber": "string",
"type": "string",
"value": 0,
"vehicleRecoveryType": "string",
"vehicleSearchConsentedTo": true,
"vehicleSearched": true,
"vinNumber": "string",
"yearOfManufacture": 0
}
],
"lastEventClearingComments": "string",
"narrative": "string",
"proQaDeterminantCode": "string",
"radioChannels": [
{
"externalId": "string",
"externalSystem": "string",
"radioChannel": {},
"type": "string"
}
],
"reportingEventNumber": "string",
"reportingEventNumbers": [
{
"agencyCode": "string",
"agencyId": 0,
"agencyOri": "string",
"externalId": "string",
"externalSystem": "string",
"reportingEventNumber": "string"
}
],
"reportingParties": [
{
"externalId": "string",
"externalSystem": "string",
"involvementType": "string",
"note": "string",
"personProfile": {},
"phoneNumber": "string"
}
],
"reportingPartyLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"reportingPartyNotes": "string",
"reportingPartyPhoneNumber": "string",
"reportingPerson": {
"additionalDetails": {
"property1": "string",
"property2": "string"
},
"build": "string",
"citizenship": "string",
"contextId": 0,
"contextType": "WARRANT",
"contextualId": 0,
"dateOfBirth": "2019-08-24",
"dateOfBirthRangeEnd": "2019-08-24",
"dateOfBirthRangeStart": "2019-08-24",
"dateOfDeath": "2019-08-24T14:15:22Z",
"declaredDateOfDeath": "2019-08-24",
"description": "string",
"email": "string",
"emailType": "string",
"emails": {
"property1": "string",
"property2": "string"
},
"emergencyContacts": [
{}
],
"employmentHistories": [
{}
],
"ethnicity": "string",
"externalId": "string",
"externalSystem": "string",
"eyeColor": "string",
"facialHair": "string",
"fbiNumber": "string",
"firstName": "string",
"hairColor": "string",
"hairLength": "string",
"hairStyle": "string",
"hasNoFixedHomeAddress": true,
"height": 0,
"homeAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"homeAddresses": [
{}
],
"identifyingMarks": [
{}
],
"involvement": "INVOLVED_PERSON_IN_REPORT",
"involvementSequenceNumber": 0,
"isDateOfBirthUnknown": true,
"isJuvenile": true,
"isNonDisclosureRequest": true,
"lastName": "string",
"licenseNumber": "string",
"licenseState": "string",
"licenseStatus": "string",
"licenseType": "string",
"maritalStatus": "string",
"mark43Id": 0,
"masterId": 0,
"maxHeight": 0,
"maxWeight": 0,
"middleName": "string",
"minHeight": 0,
"minWeight": 0,
"mugshotWebServerFilePath": "string",
"needsInterpreter": true,
"nickname": "string",
"nicknames": [
"string"
],
"otherIdentifiers": {
"property1": "string",
"property2": "string"
},
"personAttributes": [
{}
],
"personGangTrackings": [
{}
],
"personInjuries": [
{}
],
"phoneNumber": "string",
"phoneNumberType": "string",
"phoneNumbers": {
"property1": "string",
"property2": "string"
},
"placeOfBirth": "string",
"race": "string",
"residentStatus": "string",
"schoolHistories": [
{}
],
"sex": "string",
"skinTone": "string",
"ssn": "string",
"stateIdNumber": "string",
"stateOfBirth": "string",
"subjectType": "string",
"subjectTypeDescription": "string",
"suffix": "string",
"title": "string",
"vision": "string",
"weight": 0,
"workAddress": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"workAddresses": [
{}
]
},
"secondaryEventType": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start_date_utc | query | string | true | Date/time for the CAD Event Start Date in UTC |
frequency_type | query | string | false | The rate at which the event should be routinely created. Defaults to ONCE if not provided |
body | body | ExternalCadEvent | true | CAD Event to be scheduled for creation |
Allowable Values
Parameter | Value |
---|---|
frequency_type | ONCE |
frequency_type | HOURLY |
frequency_type | DAILY |
frequency_type | WEEKLY |
frequency_type | MONTHLY |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Update Scheduled CAD Event Agency
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency?scheduled_event_id=0&agency_code=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency?scheduled_event_id=0&agency_code=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency',
params: {
'scheduled_event_id' => 'integer(int64)',
'agency_code' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency', params={
'scheduled_event_id': '0', 'agency_code': 'string'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency?scheduled_event_id=0&agency_code=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency?scheduled_event_id=0&agency_code=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/agency";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/scheduled/update/agency
Updates an existing Scheduled CAD Event to be created for the provided agency
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
scheduled_event_id | query | integer(int64) | true | The database id of the event to update the schedule of |
agency_code | query | string | true | The code of the agency to update the event to use |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Update Scheduled CAD Event CFS Type
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs?scheduled_event_id=0&call_for_service_type_code=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs?scheduled_event_id=0&call_for_service_type_code=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs',
params: {
'scheduled_event_id' => 'integer(int64)',
'call_for_service_type_code' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs', params={
'scheduled_event_id': '0', 'call_for_service_type_code': 'string'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs?scheduled_event_id=0&call_for_service_type_code=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs?scheduled_event_id=0&call_for_service_type_code=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/cfs";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/scheduled/update/cfs
Updates an existing Scheduled CAD Event to use the provided Call For Service Type
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
scheduled_event_id | query | integer(int64) | true | The database id of the event to update the schedule of |
call_for_service_type_code | query | string | true | The code of the Call For Service type to update the event to use |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Update Scheduled CAD Event Location
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location?scheduled_event_id=0 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location?scheduled_event_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location',
params: {
'scheduled_event_id' => 'integer(int64)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location', params={
'scheduled_event_id': '0'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location?scheduled_event_id=0 HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '{
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location?scheduled_event_id=0',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/location";
string json = @"{
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
}";
ExternalLocation content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalLocation content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalLocation content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/scheduled/update/location
Schedules a CAD Event to be created at the specified time
Body parameter
{
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
scheduled_event_id | query | integer(int64) | true | The database id of the event to update the schedule of |
body | body | ExternalLocation | true | The location to update the scheduled cad event with |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Update Scheduled CAD Event Time
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule?scheduled_event_id=0&start_date_utc=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule?scheduled_event_id=0&start_date_utc=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule',
params: {
'scheduled_event_id' => 'integer(int64)',
'start_date_utc' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule', params={
'scheduled_event_id': '0', 'start_date_utc': 'string'
}, headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule?scheduled_event_id=0&start_date_utc=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule?scheduled_event_id=0&start_date_utc=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/event/scheduled/update/reschedule";
await PostAsync(null, url);
}
/// Performs a POST Request
public async Task PostAsync(undefined content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(undefined content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad/event/scheduled/update/reschedule
Reschedules an existing CAD Event to be created at a newly specified time and frequency
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
scheduled_event_id | query | integer(int64) | true | The database id of the event to update the schedule of |
start_date_utc | query | string | true | Date/time for the CAD Event Start Date in UTC |
frequency_type | query | string | false | The rate at which the event should be routinely created. Defaults to ONCE if not provided |
Allowable Values
Parameter | Value |
---|---|
frequency_type | ONCE |
frequency_type | HOURLY |
frequency_type | DAILY |
frequency_type | WEEKLY |
frequency_type | MONTHLY |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: CAD Events
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/events?start_date_utc=string&end_date_utc=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/events?start_date_utc=string&end_date_utc=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/events',
params: {
'start_date_utc' => 'string',
'end_date_utc' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/events', params={
'start_date_utc': 'string', 'end_date_utc': 'string'
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/events?start_date_utc=string&end_date_utc=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/events', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/events?start_date_utc=string&end_date_utc=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/events", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/events";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/events
Retrieves CAD Events created within a specified date/time range.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start_date_utc | query | string | true | Beginning of date/time range for CAD Event Start Date in UTC |
end_date_utc | query | string | true | End of date/time range for CAD Event End Date in UTC |
from | query | integer(int32) | false | Number of records to skip for paginated results |
size | query | integer(int32) | false | Max size of results set to return. Default & max value: 25 |
agency_type | query | array[string] | false | Agency type filter |
agency_code | query | array[string] | false | Agency code filter |
include_unit_status_history_data | query | boolean | false | Include optional unit status history data |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Active CAD Events
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/events/active \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/events/active");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/events/active',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/events/active', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/events/active HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/events/active', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/events/active',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/events/active", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/events/active";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/events/active
Retrieves currently active CAD events
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
include_unit_status_history_data | query | boolean | false | Include optional unit status history data |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: CAD Events by Event IDs
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad/events/ids?cad_event_ids=0 \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad/events/ids?cad_event_ids=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad/events/ids',
params: {
'cad_event_ids' => 'array[integer]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad/events/ids', params={
'cad_event_ids': [
0
]
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad/events/ids?cad_event_ids=0 HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad/events/ids', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad/events/ids?cad_event_ids=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad/events/ids", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad/events/ids";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad/events/ids
Retrieves CAD Events according to their Mark43 CAD Event IDs.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
cad_event_ids | query | array[integer] | true | Mark43 Cad Event IDs |
include_unit_status_history_data | query | boolean | false | Include optional unit status history data |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
CAD Ticket Endpoints
This CAD Ticket Endpoint
allows for the creation of CAD tickets.
For details on person, organization, item, and location object creation, see Additional Model Information.
GET: CAD Ticket by Agency Event Number
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cad_tickets?agency_event_numbers=string&department_id=0 \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad_tickets?agency_event_numbers=string&department_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cad_tickets',
params: {
'agency_event_numbers' => 'array[string]',
'department_id' => 'integer(int64)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cad_tickets', params={
'agency_event_numbers': [
"string"
], 'department_id': '0'
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cad_tickets?agency_event_numbers=string&department_id=0 HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cad_tickets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad_tickets?agency_event_numbers=string&department_id=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cad_tickets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad_tickets";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cad_tickets
Get CAD ticket for a particular agency event numbers.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
agency_event_numbers | query | array[string] | true | Agency Event Numbers to search for |
hydrate_tickets | query | boolean | false | If true, hydrates comments, units, and locations onto the tickets |
department_id | query | integer(int64) | true | Department ID |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Create CAD Tickets
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cad_tickets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cad_tickets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cad_tickets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cad_tickets', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cad_tickets HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cad_tickets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
{
"agencyCode": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callerName": "string",
"callerPhoneNumber": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketComments": [
{}
],
"externalCadTicketUnitAndMembers": [
{}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"fmsEventNumber": "string",
"involvedPersons": [
{}
],
"involvedVehicles": [
{}
],
"reportingEventNumber": "string",
"secondaryEventType": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cad_tickets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cad_tickets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cad_tickets";
string json = @"[
{
""agencyCode"": ""string"",
""assignedAgencyOri"": ""string"",
""cadAgencyEventNumber"": ""string"",
""cadCommonEventNumber"": ""string"",
""callDateUtc"": ""2019-08-24T14:15:22Z"",
""callerName"": ""string"",
""callerPhoneNumber"": ""string"",
""e911EventNumber"": ""string"",
""eventClosedDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStartDateUtc"": ""2019-08-24T14:15:22Z"",
""eventStatus"": ""string"",
""eventType"": ""string"",
""externalCadTicketComments"": [
{}
],
""externalCadTicketUnitAndMembers"": [
{}
],
""externalId"": ""string"",
""externalLocation"": {
""additionalDescription"": ""string"",
""apartmentNumber"": ""string"",
""category"": ""string"",
""city"": ""string"",
""classifyFlag"": true,
""country"": ""string"",
""county"": ""string"",
""crossStreet1"": ""string"",
""crossStreet2"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""fireSubdivision1"": ""string"",
""fireSubdivision2"": ""string"",
""fireSubdivision3"": ""string"",
""fireSubdivision4"": ""string"",
""fireSubdivision5"": ""string"",
""fullAddress"": ""string"",
""ignoreValidations"": true,
""latitude"": 0,
""levelName"": ""string"",
""levelType"": ""string"",
""locationPropertyType"": ""string"",
""longitude"": 0,
""medicalSubdivision1"": ""string"",
""medicalSubdivision2"": ""string"",
""medicalSubdivision3"": ""string"",
""medicalSubdivision4"": ""string"",
""medicalSubdivision5"": ""string"",
""placeName"": ""string"",
""resolveLocationFlag"": true,
""state"": ""string"",
""statePlaneX"": 0,
""statePlaneY"": 0,
""statePlaneZone"": ""string"",
""streetAddress"": ""string"",
""streetName"": ""string"",
""streetNumber"": ""string"",
""subPremise"": ""string"",
""subdivision1"": ""string"",
""subdivision2"": ""string"",
""subdivision3"": ""string"",
""subdivision4"": ""string"",
""subdivision5"": ""string"",
""unitName"": ""string"",
""unitType"": ""string"",
""zip"": ""string""
},
""externalSystem"": ""string"",
""firstUnitArrivalDateUtc"": ""2019-08-24T14:15:22Z"",
""firstUnitDispatchDateUtc"": ""2019-08-24T14:15:22Z"",
""fmsEventNumber"": ""string"",
""involvedPersons"": [
{}
],
""involvedVehicles"": [
{}
],
""reportingEventNumber"": ""string"",
""secondaryEventType"": ""string""
}
]";
ExternalCadTicket content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalCadTicket content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalCadTicket content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cad_tickets
Creates CAD tickets.
Body parameter
[
{
"agencyCode": "string",
"assignedAgencyOri": "string",
"cadAgencyEventNumber": "string",
"cadCommonEventNumber": "string",
"callDateUtc": "2019-08-24T14:15:22Z",
"callerName": "string",
"callerPhoneNumber": "string",
"e911EventNumber": "string",
"eventClosedDateUtc": "2019-08-24T14:15:22Z",
"eventStartDateUtc": "2019-08-24T14:15:22Z",
"eventStatus": "string",
"eventType": "string",
"externalCadTicketComments": [
{}
],
"externalCadTicketUnitAndMembers": [
{}
],
"externalId": "string",
"externalLocation": {
"additionalDescription": "string",
"apartmentNumber": "string",
"category": "string",
"city": "string",
"classifyFlag": true,
"country": "string",
"county": "string",
"crossStreet1": "string",
"crossStreet2": "string",
"externalId": "string",
"externalSystem": "string",
"fireSubdivision1": "string",
"fireSubdivision2": "string",
"fireSubdivision3": "string",
"fireSubdivision4": "string",
"fireSubdivision5": "string",
"fullAddress": "string",
"ignoreValidations": true,
"latitude": 0,
"levelName": "string",
"levelType": "string",
"locationPropertyType": "string",
"longitude": 0,
"medicalSubdivision1": "string",
"medicalSubdivision2": "string",
"medicalSubdivision3": "string",
"medicalSubdivision4": "string",
"medicalSubdivision5": "string",
"placeName": "string",
"resolveLocationFlag": true,
"state": "string",
"statePlaneX": 0,
"statePlaneY": 0,
"statePlaneZone": "string",
"streetAddress": "string",
"streetName": "string",
"streetNumber": "string",
"subPremise": "string",
"subdivision1": "string",
"subdivision2": "string",
"subdivision3": "string",
"subdivision4": "string",
"subdivision5": "string",
"unitName": "string",
"unitType": "string",
"zip": "string"
},
"externalSystem": "string",
"firstUnitArrivalDateUtc": "2019-08-24T14:15:22Z",
"firstUnitDispatchDateUtc": "2019-08-24T14:15:22Z",
"fmsEventNumber": "string",
"involvedPersons": [
{}
],
"involvedVehicles": [
{}
],
"reportingEventNumber": "string",
"secondaryEventType": "string"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
hard_insert | query | boolean | false | If true, performs hard insert on CAD tickets (Delete + Insert) |
require_dob_for_master_profile_creation | query | boolean | false | If true, then a date of birth (DOB) is required for creation of a Master Profile |
require_name_identifier_for_master_profile_creation | query | boolean | false | If true, then a Name Identifier (driver license number or social security number) is required for creation of a Master Profile |
search_existing_master_persons_by_name | query | boolean | false | If true, match to existing Master Profile by Name and any one of the following: DOB, Driver's License Number, SSN, Name Identifier; else require Name, DOB, and an additional Identifier to match |
body | body | ExternalCadTicket | true | CAD tickets to be created |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
Case Management Endpoints
Case Management Endpoints
allow agencies that use the Mark43 Case Management Module to interact with case information.
For details on person, organization, item, and location object creation, see Additional Model Information.
GET: Cases by Reporting Event Numbers
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cases?reporting_event_numbers=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cases?reporting_event_numbers=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cases',
params: {
'reporting_event_numbers' => 'array[string]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cases', params={
'reporting_event_numbers': [
"string"
]
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cases?reporting_event_numbers=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cases', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cases?reporting_event_numbers=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cases", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cases";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cases
Retrieves cases based on Reporting Event Numbers (RENs).
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
reporting_event_numbers | query | array[string] | true | Reporting Event Numbers to be returned |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Case Notes
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/cases/notes/{case_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/cases/notes/{case_id} HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const inputBody = '[
{
"author": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [],
"signatureId": 0,
"skills": [],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"content": "string",
"externalId": "string",
"externalSystem": "string",
"title": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cases/notes/{case_id}";
string json = @"[
{
""author"": {
""actingRank"": ""string"",
""badgeNumber"": ""string"",
""branch"": ""string"",
""bureau"": ""string"",
""cityIdNumber"": ""string"",
""currentAssignmentDate"": ""2019-08-24T14:15:22Z"",
""currentDutyStatus"": ""string"",
""currentDutyStatusDate"": ""2019-08-24"",
""dateHired"": ""2019-08-24"",
""dateOfBirth"": ""2019-08-24"",
""departmentAgencyId"": 0,
""division"": ""string"",
""employeePhoneNumbers"": [],
""employeeTypeAbbrev"": ""string"",
""externalCadId"": ""string"",
""externalHrId"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""firstName"": ""string"",
""gender"": ""string"",
""height"": 0,
""isDisabled"": true,
""isSsoUser"": true,
""lastName"": ""string"",
""licenseNumber"": ""string"",
""mark43UserAccountRoleId"": 0,
""mark43UserGroup"": ""CALL_TAKER"",
""middleName"": ""string"",
""mobileId"": ""string"",
""officerEmploymentType"": ""string"",
""personnelUnit"": ""string"",
""primaryEmail"": ""string"",
""race"": ""string"",
""rank"": ""string"",
""roles"": [],
""signatureId"": 0,
""skills"": [],
""ssn"": ""string"",
""startDateUtc"": ""2019-08-24T14:15:22Z"",
""stateIdNumber"": ""string"",
""suffix"": ""string"",
""title"": ""string"",
""trainingAbbreviations"": [],
""trainingIdNumber"": ""string"",
""updatedDateUtc"": ""2019-08-24T14:15:22Z"",
""weight"": 0,
""yearsOfExperience"": 0
},
""content"": ""string"",
""externalId"": ""string"",
""externalSystem"": ""string"",
""title"": ""string""
}
]";
ExternalCaseNote content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(ExternalCaseNote content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(ExternalCaseNote content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
POST /external/cases/notes/{case_id}
Adds case notes to a case.
Body parameter
[
{
"author": {
"actingRank": "string",
"badgeNumber": "string",
"branch": "string",
"bureau": "string",
"cityIdNumber": "string",
"currentAssignmentDate": "2019-08-24T14:15:22Z",
"currentDutyStatus": "string",
"currentDutyStatusDate": "2019-08-24",
"dateHired": "2019-08-24",
"dateOfBirth": "2019-08-24",
"departmentAgencyId": 0,
"division": "string",
"employeePhoneNumbers": [],
"employeeTypeAbbrev": "string",
"externalCadId": "string",
"externalHrId": "string",
"externalId": "string",
"externalSystem": "string",
"firstName": "string",
"gender": "string",
"height": 0,
"isDisabled": true,
"isSsoUser": true,
"lastName": "string",
"licenseNumber": "string",
"mark43UserAccountRoleId": 0,
"mark43UserGroup": "CALL_TAKER",
"middleName": "string",
"mobileId": "string",
"officerEmploymentType": "string",
"personnelUnit": "string",
"primaryEmail": "string",
"race": "string",
"rank": "string",
"roles": [],
"signatureId": 0,
"skills": [],
"ssn": "string",
"startDateUtc": "2019-08-24T14:15:22Z",
"stateIdNumber": "string",
"suffix": "string",
"title": "string",
"trainingAbbreviations": [],
"trainingIdNumber": "string",
"updatedDateUtc": "2019-08-24T14:15:22Z",
"weight": 0,
"yearsOfExperience": 0
},
"content": "string",
"externalId": "string",
"externalSystem": "string",
"title": "string"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
case_id | path | integer(int64) | true | Case ID |
body | body | ExternalCaseNote | true | Case note information |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
413 | Payload Too Large | Request body is too large | None |
422 | Unprocessable Entity | Invalid entity | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Updated Cases
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/cases/updated?start_date_utc=string&end_date_utc=string \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/cases/updated?start_date_utc=string&end_date_utc=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/cases/updated',
params: {
'start_date_utc' => 'string',
'end_date_utc' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/cases/updated', params={
'start_date_utc': 'string', 'end_date_utc': 'string'
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/cases/updated?start_date_utc=string&end_date_utc=string HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/cases/updated', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/cases/updated?start_date_utc=string&end_date_utc=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/cases/updated", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/cases/updated";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/cases/updated
Retrieves cases that have been updated within a given date/time range.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start_date_utc | query | string | true | Start of date/time range for case updated date in UTC |
end_date_utc | query | string | true | End of date/time range for case updated date in UTC |
from | query | integer(int32) | false | Number of records to skip for paginated results. Default value: 0 |
size | query | integer(int32) | false | Max size of results set to return. Default & max value: 25 |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
Department User Endpoints
Department User Endpoints
allow for the retrieval and updating of department user profiles.
For details on person, organization, item, and location object creation, see Additional Model Information.
GET: All Department Users
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/users \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/users', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/users HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/users', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/users',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/users";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/users
Retrieves the user profiles of all personnel within a given department. Returned results include biographical information, roles, and date hired. For comprehensive user profiles, use GET external/users/full.
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Full User Profile Information
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/users/full \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/users/full");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/users/full',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/users/full', headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/users/full HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/users/full', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/users/full',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/users/full", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/users/full";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/users/full
Retrieves the full user profiles for all personnel within a given department. Returned results include biographical information, division, rank, personnel unit, current duty status, and more.
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
GET: Department Users by ID
Code samples
# You can also use wget
curl -X GET https://department.mark43.com/partnerships/api/external/users/ids?user_ids=0 \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/users/ids?user_ids=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://department.mark43.com/partnerships/api/external/users/ids',
params: {
'user_ids' => 'array[integer]'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://department.mark43.com/partnerships/api/external/users/ids', params={
'user_ids': [
0
]
}, headers = headers)
print(r.json())
GET https://department.mark43.com/partnerships/api/external/users/ids?user_ids=0 HTTP/1.1
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://department.mark43.com/partnerships/api/external/users/ids', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
const headers = {
'Accept':'application/json'
};
fetch('https://department.mark43.com/partnerships/api/external/users/ids?user_ids=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://department.mark43.com/partnerships/api/external/users/ids", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://department.mark43.com/partnerships/api/external/users/ids";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
GET /external/users/ids
Retrieves a collection of user profiles according to their Mark43 IDs.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
user_ids | query | array[integer] | true | Mark43 IDs of the users being requested |
Example responses
Responses
Status | Meaning | Description | Model |
---|---|---|---|
200 | OK | Successful operation | None |
304 | Not Modified | Not modified | None |
400 | Bad Request | Bad arguments to this resource | None |
401 | Unauthorized | Unauthorized access to this operation | None |
403 | Forbidden | Insufficient permissions to perform this operation | None |
404 | Not Found | Could not find resource | None |
500 | Internal Server Error | Internal server error | None |
Response Schema
POST: Upsert/Replace User Information
Code samples
# You can also use wget
curl -X POST https://department.mark43.com/partnerships/api/external/users/upsert \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
URL obj = new URL("https://department.mark43.com/partnerships/api/external/users/upsert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = RestClient.post 'https://department.mark43.com/partnerships/api/external/users/upsert',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('https://department.mark43.com/partnerships/api/external/users/upsert', headers = headers)
print(r.json())
POST https://department.mark43.com/partnerships/api/external/users/upsert HTTP/1.1
Content-Type: application/json
Accept: application/json
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://department.mark43.com/partnerships/api/external/users/upsert', array(
'headers'