apiary.apib

FORMAT: 1A
HOST: https://cpdp.docs.apiary.io/

# CPDP

CPDP is a simple API serving the CPDP website version 2 (not the same as api version) now live at https://beta.cpdp.co. It includes two main portions: CMS and data tool.

**Conventions**:

- Property name is in snake case: `field_name` instead of `fieldName`

## CMS Page [/cms-pages/{page_id}/]

+ Parameters
    + page_id (string) - ID of the Page that look like a slug

### Get CMS page content [GET]

**Properties**:

- `fields` is an array of fields. Each fields has `name`, `type` and `value`. `value` is an opaque object that should be only of interest to whatever module that deal with it directly. As such it's content might violate some of conventions followed elsewhere such as having property name be in snake case.

+ Response 200 (application/json)

        {
            "fields": [
                {
                    "name": "vftg_date",
                    "type": "date",
                    "value": "2016-10-07"
                },
                {
                    "name": "vftg_link",
                    "type": "link",
                    "value": "https://google.com"
                },
                {
                    "name": "vftg_content",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "5gia1",
                                "text": "Real Independence for Police Oversight Agencies",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "collaborate_header",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "5gia1",
                                "text": "Collaborate With Us.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "collaborate_content",
                    "type": "multiline_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a4b9s",
                                "text": "We are collecting and publishing information that sheds light on police misconduct.",
                                "type": "unstyled"
                            },
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a4b9z",
                                "text": "If you have documents or datasets you would like to publish, please email us, or learn more.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "about_header",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a89s0",
                                "text": "About",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "about_content",
                    "type": "multiline_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a9sn8",
                                "text": "The Citizens Police Data Project houses police disciplinary information obtained from the City of Chicago..",
                                "type": "unstyled"
                            },
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a9sn5",
                                "text": "The information and stories we have collected here are intended as a resource for public oversight. Our aim is to create a new model of accountability between officers and citizens.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                }
            ]
        }

### Partial update CMS page content [PATCH]

This api require an api access token set in `Authorization` header. To get an api access token, use **Sign In** api.

+ Request (application/json)

    + Headers

            Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

    + Body

            {
                "fields": [
                    {
                        "name": "collaborate_header",
                        "type": "plain_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "5gia1",
                                    "text": "Collaborate With Us.",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    },
                    {
                        "name": "collaborate_content",
                        "type": "multiline_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9s",
                                    "text": "We are collecting and publishing information that sheds light on police misconduct.",
                                    "type": "unstyled"
                                },
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9z",
                                    "text": "If you have documents or datasets you would like to publish, please email us, or learn more.",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    }
                ]
            }

+ Response 200 (application/json)

            {
                "fields": [
                {
                    "name": "vftg_date",
                    "type": "date",
                    "value": "2016-10-07"
                },
                {
                    "name": "vftg_link",
                    "type": "link",
                    "value": "https://google.com"
                },
                {
                    "name": "vftg_content",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "5gia1",
                                "text": "Real Independence for Police Oversight Agencies",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "collaborate_header",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "5gia1",
                                "text": "Collaborate With Us.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "collaborate_content",
                    "type": "multiline_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a4b9s",
                                "text": "We are collecting and publishing information that sheds light on police misconduct.",
                                "type": "unstyled"
                            },
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a4b9z",
                                "text": "If you have documents or datasets you would like to publish, please email us, or learn more.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "about_header",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a89s0",
                                "text": "About",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                },
                {
                    "name": "about_content",
                    "type": "multiline_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a9sn8",
                                "text": "The Citizens Police Data Project houses police disciplinary information obtained from the City of Chicago..",
                                "type": "unstyled"
                            },
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "a9sn5",
                                "text": "The information and stories we have collected here are intended as a resource for public oversight. Our aim is to create a new model of accountability between officers and citizens.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                }
            ]
        }

+ Request (application/json)

        {
            "fields": [
                {
                    "name": "collaborate_header",
                    "type": "plain_text",
                    "value": {
                        "blocks": [
                            {
                                "data": {},
                                "depth": 0,
                                "entityRanges": [],
                                "inlineStyleRanges": [],
                                "key": "5gia1",
                                "text": "Collaborate With Us.",
                                "type": "unstyled"
                            }
                        ],
                        "entityMap": {}
                    }
                }
            ]
        }

+ Response 401 (application/json)

    + Headers

            WWW-Authenticate: Token

## Sign In [/users/sign-in/]

### Sign in and get an api access token [POST]

+ Request (application/json)

        {
            "username": "admin",
            "password": "admin@123"
        }

+ Response 200 (application/json)

        {
            "apiAccessToken": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
        }

+ Request (application/json)

        {
            "username": "incorrectname",
            "password": "password"
        }

+ Response 400 (application/json)

        {
            "message": "Sorry, you’ve entered an incorrect name."
        }

+ Request (application/json)

        {
            "username": "admin",
            "password": "incorrect"
        }

+ Response 400 (application/json)

        {
            "message": "You’ve entered an incorrect password."
        }

## Forgot password [/users/forgot-password/]

### Forgot password [POST]

+ Request (application/json)

        {
            "email": "admin@domain.com"
        }

+ Response 200 (application/json)

        {
            "message": "Please check your email for a password reset link."
        }

+ Request (application/json)

        {
            "email": "unregistered@email.co"
        }

+ Response 400 (application/json)

        {
            "message": "Sorry, there’s no account registered with this email address."
        }

### Partial Update report [PATCH]

This api require an api access token set in `Authorization` header. To get an api access token, use **Sign In** api.

+ Request (application/json)

    + Headers

            Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

    + Body

            {
                "fields": [
                    {
                        "name": "title",
                        "type": "plain_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "5gia1",
                                    "text": "Commentary: Chicago's police crisis fall on all of us",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    },
                    {
                        "name": "excerpt",
                        "type": "multiline_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9s",
                                    "text": "The “few bad apples” theory of police violence posits that a small portion of the police force is ill-intentioned or inclined to misconduct or violence, while the majority of officers are good cops. Until recently, this theory was difficult for civilians to investigate, but department data on complaints against officers obtained through a legal challenge shows that police misconduct in Chicago is overwhelmingly the product of a small fraction of officers and that it may be possible to identify those officers and reduce misconduct.",
                                    "type": "unstyled"
                                },
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9z",
                                    "text": "This far-reaching data set, a product of the nonprofit Invisible Institute’s Citizens Police Data Project, comprehensively covers nearly five years of complaints against Chicago police officers. Each of the 28,588 records in the database offers a detailed account of the incident, including information on the accused officer, the complainant, the type of alleged misconduct, and whether the complaint was found legitimate by an internal investigation.",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    }
                ]
            }

+ Response 200 (application/json)

            {
                "id": 1,
                "fields": [
                    {
                        "name": "title",
                        "type": "plain_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "5gia1",
                                    "text": "Commentary: Chicago's police crisis",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    },
                    {
                        "name": "excerpt",
                        "type": "multiline_text",
                        "value": {
                            "blocks": [
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9s",
                                    "text": "The “few bad apples” theory of police violence posits that a small portion of the police force is ill-intentioned or inclined to misconduct or violence, while the majority of officers are good cops. Until recently, this theory was difficult for civilians to investigate, but department data on complaints against officers obtained through a legal challenge shows that police misconduct in Chicago is overwhelmingly the product of a small fraction of officers and that it may be possible to identify those officers and reduce misconduct.",
                                    "type": "unstyled"
                                },
                                {
                                    "data": {},
                                    "depth": 0,
                                    "entityRanges": [],
                                    "inlineStyleRanges": [],
                                    "key": "a4b9z",
                                    "text": "This far-reaching data set, a product of the nonprofit Invisible Institute’s Citizens Police Data Project, comprehensively covers nearly five years of complaints against Chicago police officers. Each of the 28,588 records in the database offers a detailed account of the incident, including information on the accused officer, the complainant, the type of alleged misconduct, and whether the complaint was found legitimate by an internal investigation.",
                                    "type": "unstyled"
                                }
                            ],
                            "entityMap": {}
                        }
                    },
                    {
                        "name": "publication",
                        "type": "string",
                        "value": "New York Times"
                    },
                    {
                        "name": "publish_date",
                        "type": "date",
                        "value": "2016-09-23"
                    },
                    {
                        "name": "author",
                        "type": "string",
                        "value": "Edgar Sterling"
                    },
                    {
                        "name": "officers",
                        "type": "officers_list",
                        "value": [
                            {
                                "id": 123,
                                "full_name": "Edgar Davis",
                                "allegation_count": 14,
                                "v1_url": "http://cpdb.co/officer/edgar/123",
                                "gender": "Male",
                                "race": "White"
                            }
                        ]
                    }
                ]

        }

## Analytic events [/events/]

### Create Event [POST]

+ Request (application/json)

    + Body

            {
                "name": "some-click",
                "data": {
                    "id": 12,
                    "title": "How accurate is the data?",
                    "timestamp": "2017-01-23T03:11:53Z"
                }
            }

+ Response 201

## Officer summary [/officers/{officer_id}/summary]

### Get Officer Summary (include bio, metrics, and yearly percentiles) [GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

        {
            "id": 1,
            "unit": {
                "id": 1,
                "unit_name": "001",
                "description": "Unit 001"
            },
            "date_of_appt": "2015-09-23",
            "date_of_resignation": "2017-09-23",
            "active": "Active",
            "rank": "NA",
            "race": "White",
            "badge": "12345",
            "historic_badges": ["22", "33"],
            "historic_units": [
              {
                "id": 1,
                "unit_name": "001",
                "description": "Unit 001"
              },
              {
                "id": 2,
                "unit_name": "002",
                "description": "Unit 002"
              }
            ],
            "gender": "Male",
            "birth_year": 1951,
            "allegation_count": 90,
            "civilian_compliment_count": 0,
            "discipline_count": 0,
            "honorable_mention_count": 1,
            "honorable_mention_percentile": "88.777",
            "sustained_count": 4,
            "complaint_records": {
                "count": 27,
                "sustained_count": 0,
                "facets": [
                    {
                        "name": "category",
                        "entries": [
                            {
                                "name": "Illegal Search",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": "Use of Force",
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "race"
                        "entries": [
                            {
                                "name": "White",
                                "count": 7,
                                "sustained_count": 0
                            },
                            {
                                "name": null,
                                "count": 20,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "age",
                        "entries": [
                            {
                                "name": "18",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": "20",
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "gender",
                        "entries": [
                            {
                                "name": "Famale",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": null,
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    }
                ]
            },
            "percentile_trr": "0.000",
            "percentile_allegation": "58.446",
            "current_salary": 100000,
            "trr_count": 14,
            "major_award_count": 46,
            "complaint_records": {
                "count": 27,
                "sustained_count": 0,
                "facets": [
                    {
                        "name": "category",
                        "entries": [
                            {
                                "name": "Illegal Search",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": "Use of Force",
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "race"
                        "entries": [
                            {
                                "name": "White",
                                "count": 7,
                                "sustained_count": 0
                            },
                            {
                                "name": null,
                                "count": 20,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "age",
                        "entries": [
                            {
                                "name": "18",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": "20",
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "gender",
                        "entries": [
                            {
                                "name": "Famale",
                                "count": 20,
                                "sustained_count": 0
                            },
                            {
                                "name": null,
                                "count": 7,
                                "sustained_count": 0
                            }
                        ]
                    }
                ]
            },
            "percentiles": [
                {
                    "officer_id": 1,
                    "year": 2016,
                    "percentile_trr": "0.000",
                    "percentile_allegation": "76.282",
                    "percentile_allegation_civilian": "79.479",
                    "percentile_allegation_internal": "0.000"
                },
                {
                    "officer_id": 1,
                    "year": 2017,
                    "percentile_trr": "0.000",
                    "percentile_allegation": "58.446",
                    "percentile_allegation_civilian": "63.044",
                    "percentile_allegation_internal": "0.000"
                }
            ]
        }

## Officer timeline minimap [/officers/{officer_id}/timeline-minimap]

### Get Officer timeline minimap [GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

        [
            {
                "kind": "cr",
                "year": 2016
            },
            {
                "kind": "trr",
                "year": 2015
            }
        ]

## Officer coaccusals [/officers/{officer_id}/coaccusals]

### Get Officer coaccusals [GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

        {
            "id": "8562",
            "coaccusals": [
                {
                    "id": 1,
                    "full_name": "Officer 1",
                    "complaint_count": 2,
                    "sustained_count": 1,
                    "race": "White",
                    "gender": "Male",
                    "birth_year": 1950,
                    "coaccusal_count": 2,
                    "rank": "Police Officer",
                    "percentile_trr": "94.0000",
                    "percentile_allegation_internal": "95.0000",
                    "percentile_allegation_civilian": "91.0000",
                    "percentile_allegation": "94.0000",
                }, {
                    "id": 2,
                    "full_name": "Officer 2",
                    "complaint_count": 1,
                    "sustained_count": 1,
                    "race": "Black",
                    "gender": "Male",
                    "birth_year": 1970,
                    "coaccusal_count": 1,
                    "rank": "Police Officer",
                    "percentile_trr": "82.0000",
                    "percentile_allegation_internal": "71.0000",
                    "percentile_allegation_civilian": "98.0000",
                    "percentile_allegation": "95.0000",
                }
            ]
        }

## Officer timeline items list [/officers/{officer_id}/timeline-items/{?offset,limit}]

### Get Officer timeline items list [GET]

+ Parameters
    + officer_id (number) - number ID of the officer
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
            "count": 20,
            "previous": null,
            "next": "http://cpdp.co/officers/123/timeline-items/?offset=20"
            "results": [
                {
                    "kind": "YEAR",
                    "crs": 2,
                    "year": 2016,
                    "trrs": 0,
                    "salary": 46492.96
                },
                {
                    "kind": "CR",
                    "crid": "307965",
                    "category": "Illegal Search",
                    "subcategory": "Search of premise/vehicle without warrant",
                    "finding": "Unfounded",
                    "coaccused": 4,
                    "date": "2016-08-24"
                },
                {
                    "kind": "UNIT_CHANGE",
                    "unit_name": "003",
                    "date": "2016-08-24"
                },
                {
                    "kind": "JOINED",
                    "date": "2012-08-24"
                }
            ]
        }

## Officer new timeline items list [/officers/{officer_id}/new-timeline-items]

### Get Officer new timeline items list [GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

        [{
            "date": "2011-09-23",
            "kind": "FORCE",
            "taser": "true",
            "firearm_used": "false",
            "unit_name": "001",
            "rank": "Police Officer",
            "point": {
                "lon": 16.5,
                "lat": 67.8
            }
        }, {
            "date": "2011-08-23",
            "kind": "CR",
            "crid": "123456",
            "category": "category",
            "subcategory": "sub category",
            "finding": "Unfounded",
            "outcome": "Unknown",
            "coaccused": 4,
            "unit_name": "001",
            "rank": "Police Officer",
            "point": {
                "lon": 35.8,
                "lat": 76.8
            },
            "victims": [{
                "gender": "Male",
                "race": "White",
                "age": 34
            }, {
                "gender": "Female",
                "race": "Black",
                "age": 42
            }]
        }, {
            "date": "2011-03-23",
            "kind": "AWARD",
            "award_type": "Honorable Mention",
            "unit_name": "001",
            "rank": "Police Officer"
        }, {
            "date": "2010-01-01",
            "kind": "UNIT_CHANGE",
            "unit_name": "001",
            "rank": "Police Officer"
        }, {
            "date": "2000-01-01",
            "kind": "JOINED",
            "unit_name": "",
            "rank": "Police Officer"
        }]

## Top Officers by allegation [/officers/top-by-allegation/]

### List Officer Cards based on top 1% complaint percentile, sort by descending [GET]

+ Response 200 (application/json)

        [
            {
                "id": 8658,
                "visual_token_background_color": "#90b1f5",
                "full_name": "Corey Flagg",
                "complaint_count": 67,
                "sustained_count": 5,
                "birth_year": 1970,
                "race": "Black",
                "gender": "Male",
                "rank": "Police Officer",
                "percentile_trr": "0.000",
                "percentile_allegation": "99.995",
                "percentile_allegation_civilian": "99.990",
                "percentile_allegation_internal": "99.795"
            },
            {
                "id": 13788,
                "visual_token_background_color": "#90b1f5",
                "full_name": "Broderick Jones",
                "complaint_count": 69,
                "sustained_count": 8,
                "birth_year": 1971,
                "race": "Black",
                "gender": "Male",
                "rank": "Detective",
                "percentile_trr": "0.000",
                "percentile_allegation": "99.990",
                "percentile_allegation_civilian": "99.995",
                "percentile_allegation_internal": "90.565"
            }
        ]

## Officer create zip file [/officers/{officer_id}/create-zip-file/]

### Create zip file from excel and pdf files then save it on S3[GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

## Officer request download [/officers/{officer_id}/request-download/{?with-docs}]

### Get the url to the officer zip file[GET]

+ Parameters
    + officer_id (number) - number ID of the officer
    + with-docs (string, optional) - should the zip file contain docs or not
        + Default: `false`

+ Response 200 (application/text)

        "https://officer-content-staging.s3.amazonaws.com/zip_with_docs/Jerome_Finnigan_with_docs.zip"

## Officer Mobile [/mobile/officers/{officer_id}/]

### Get Officer Summary (include yearly percentiles) [GET]

+ Parameters
    + officer_id (number) - number ID of the officer

+ Response 200 (application/json)

        {
            "officer_id": 1,
            "full_name": "Robert Anderson",
            "percentiles": [
                {
                    "officer_id": 1,
                    "year": 2016,
                    "percentile_trr": "0.000",
                    "percentile_allegation": "76.282",
                    "percentile_allegation_civilian": "79.479",
                    "percentile_allegation_internal": "0.000"
                },
                {
                    "officer_id": 1,
                    "year": 2017,
                    "percentile_trr": "0.000",
                    "percentile_allegation": "58.446",
                    "percentile_allegation_civilian": "63.044",
                    "percentile_allegation_internal": "0.000"
                }
            ],
            "unit": {
              "unit_id": 2,
              "unit_name": "001",
              "description": "District 001"
            },
            "date_of_appt": "1992-01-02",
            "active": true,
            "rank": "Police Officer",
            "race": "White",
            "birth_year": 1965,
            "badge": "19675",
            "historic_badges": [
              "8137"
            ],
            "gender": "Male",
            "allegation_count": 125,
            "percentile_trr": "0.000",
            "percentile_allegation": "58.446",
            "honorable_mention_count": 29,
            "sustained_count": 0,
            "discipline_count": 0,
            "civilian_compliment_count": 8,
            "trr_count": 24,
            "major_award_count": 0,
            "honorable_mention_percentile": 75.5604
        }

## TRR [/trr/{trr_id}/]

### Get TRR [GET]

+ Parameters
    + trr_id (number) - number ID of Use of Force Report

+ Response 200 (application/json)
        {
            "id": 781,
            "officer": {
                "id": 583,
                "full_name": "Robert Anderson",
                "gender": "Male",
                "race": "White",
                "rank": 'Detective',
                "appointed_date": "2000-10-10",
                "birth_year": 1973,
                "resignation_date": "2008-03-26",
                "unit": {
                    "unit_name": "253",
                    "description": "Targeted Response Unit"
                },
                "percentile_allegation_civilian": 92.7014,
                "percentile_allegation_internal": 0.0,
                "percentile_trr": 76.9689
            },
            "officer_in_uniform": true,
            "officer_assigned_beat": "4682E",
            "officer_on_duty": true,
            "subject_race": "BLACK",
            "subject_gender": "Male",
            "subject_age": 27,
            "force_category": "Other",
            "force_types": [
                "Physical Force - Stunning",
                "Verbal Commands",
                "Member Presence"
            ],
            "date_of_incident": "2004-04-23",
            "location_type": "Street",
            "address": "11XX 79Th St",
            "beat": 612,
            "point": {
                "lat": 41.7508596,
                "lng": -87.6533166
            }
        }

## TRR Documents [/trr/{trr_id}/request-document/]

### Request document [POST]

+ Parameters
    + trr_id (number) - number ID of TRR

+ Request (application/json)

        {
            "email": "asdf@example.com"
        }

+ Response 200 (application/json)

        {
            "trr_id": "293928",
            "message": "Thanks for subscribing"
        }

+ Request (application/json)

        {
            "email": "already_used@example.com"
        }

+ Response 200 (application/json)

        {
            "trr_id": "293928",
            "message": "Email already added"
        }

+ Request (application/json)

        {
            "email": "malformed email"
        }

+ Response 400 (application/json)

        {
            "message": "Please enter a valid email"
        }

## TRR Mobile [/mobile/trr/{trr_id}/]

### Get TRR [GET]

+ Parameters
    + trr_id (number) - number ID of Use of Force Report

+ Response 200 (application/json)
        {
            "id": 781,
            "officer": {
                "id": 583,
                "full_name": "Robert Anderson",
                "gender": "Male",
                "race": "White",
                "appointed_date": "2000-10-10",
                "birth_year": 1973,
                "resignation_date": "2008-03-26",
                "unit": {
                    "unit_name": "253",
                    "description": "Targeted Response Unit"
                },
                "percentile_allegation_civilian": 92.7014,
                "percentile_allegation_internal": 0.0,
                "percentile_trr": 76.9689
            },
            "officer_in_uniform": true,
            "officer_assigned_beat": "4682E",
            "officer_on_duty": true,
            "subject_race": "BLACK",
            "subject_gender": "Male",
            "subject_age": 27,
            "force_category": "Other",
            "force_types": [
                "Physical Force - Stunning",
                "Verbal Commands",
                "Member Presence"
            ],
            "date_of_incident": "2004-04-23",
            "location_type": "Street",
            "address": "11XX 79Th St",
            "beat": 612,
            "point": {
                "lat": 41.7508596,
                "lng": -87.6533166
            }
        }

## Mobile TRR Documents [/mobile/trr/{trr_id}/request-document/]

### Request document [POST]

+ Parameters
    + trr_id (number) - number ID of TRR

+ Request (application/json)

        {
            "email": "asdf@example.com"
        }

+ Response 200 (application/json)

        {
            "trr_id": "293928",
            "message": "Thanks for subscribing"
        }

+ Request (application/json)

        {
            "email": "already_used@example.com"
        }

+ Response 200 (application/json)

        {
            "trr_id": "293928",
            "message": "Email already added"
        }

+ Request (application/json)

        {
            "email": "malformed email"
        }

+ Response 400 (application/json)

        {
            "message": "Please enter a valid email"
        }

## Complaint summaries [/cr/complaint-summaries/]

### List recent updated Summary of CR [GET]

+ Response 200 (application/json)

        [
            {
                "crid": "1080158",
                "category_names": [
                    "Unknown"
                ],
                "incident_date": "2016-04-18",
                "summary": "Officer A was off-duty and inside her residence when she reportedly ..."
            },
            {
                "crid": "1079959",
                "category_names": [
                    "Unknown"
                ],
                "incident_date": "2016-04-05",
                "summary": "Subject and the off-duty Officer A had a motor vehicle accident in which Subject ..."
            }
        ]

## CR [/mobile/cr/{crid}/]

### Get CR [GET]

+ Parameters
    + crid (number) - number ID of Allegation

+ Response 200 (application/json)

        {
            "crid": "12345",
            'most_common_category': {
                'category': 'Operation/Personnel Violations',
                'allegation_name': 'NEGLECT OF DUTY/CONDUCT UNBECOMING - ON DUTY'
            },
            "coaccused": [
                {
                    "id": 123,
                    "full_name": "Robert O'Niell",
                    "final_outcome": "Reprimand",
                    "final_finding": "Sustained",
                    "race": "Asian",
                    "gender": "Male",
                    "rank": "Police Officer",
                    "birth_year": "1975",
                    "category": "Operation/Personnel Violations",
                    "percentile_allegation": "99.8610",
                    "percentile_allegation_civilian": "99.8810",
                    "percentile_allegation_internal": "80.5690",
                    "percentile_trr": "92.1100",
                },
                {
                    "id": 456,
                    "full_name": "Alex Foo",
                    "final_outcome": "Unknown",
                    "final_finding": "Sustained",
                    "race": "White",
                    "gender": "Male",
                    "rank": "Detective",
                    "birth_year": "1980",
                    "category": "Operation/Personnel Violations",
                    "percentile_allegation": "99.8610",
                    "percentile_allegation_civilian": "99.8810",
                    "percentile_allegation_internal": "80.5690",
                    "percentile_trr": "92.1100",
                }
            ],
            "complainants": [
                {
                    "race": "White",
                    "gender": "Male",
                    "age": 18
                },
                {
                    "race": "Black",
                    "gender": "Female",
                    "age": 20
                }
            ],
            "victims": [
                {
                    "race": "Black",
                    "gender": "Male",
                    "age": 53
                },
                {
                    "race": "Black",
                    "gender": "Female",
                    "age": 20
                }
            ],
            "summary": "Lorem ipsum dolor.",
            "point": {
                "lon": -87.664606,
                "lat": 41.68731
            },
            "incident_date": "2002-02-28",
            "start_date": "2002-02-30",
            "end_date": "2002-04-21",
            "address": "3510 Michigan Ave, Chicago, IL 60653",
            "location": "Police Building",
            "beat": "23",
            "involvements": [
                {
                    "officer_id": 1,
                    "involved_type": "investigator",
                    "full_name": "Lauren Skol",
                    "badge": "CPD",
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                },
                {
                    "officer_id": 2,
                    "involved_type": "police_witness",
                    "full_name": "Raymond Piwinicki",
                    "allegation_count": 10,
                    "sustained_count": 3,
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                },
                {
                    "officer_id": 3,
                    "involved_type": "police_witness",
                    "full_name": "German Felix",
                    "allegation_count": 10,
                    "sustained_count": 3,
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                }
            ],
            "attachments": [
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "video",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                },
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "audio",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                },
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "document",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                }
            ]
        }

## CR Mobile Documents [/mobile/cr/{crid}/request-document/]

### Request document [POST]

+ Parameters
    + crid (number) - number ID of Allegation

+ Request (application/json)

        {
            "email": "asdf@example.com"
        }

+ Response 200 (application/json)

        {
            "crid": "293928",
            "message": "Thanks for subscribing"
        }

+ Request (application/json)

        {
            "email": "already_used@example.com"
        }

+ Response 200 (application/json)

        {
            "crid": "293928",
            "message": "Email already added"
        }

+ Request (application/json)

        {
            "email": "malformed email"
        }

+ Response 400 (application/json)

        {
            "message": "Please enter a valid email"
        }

## CR [/cr/{crid}/]

### Get CR [GET]

+ Parameters
    + crid (number) - number ID of Allegation

+ Response 200 (application/json)

        {
            "crid": "12345",
            'most_common_category': {
                'category': 'Operation/Personnel Violations',
                'allegation_name': 'NEGLECT OF DUTY/CONDUCT UNBECOMING - ON DUTY'
            },
            "coaccused": [
                {
                    "id": 123,
                    "full_name": "Robert O'Niell",
                    "gender": "Male",
                    "race": "White",
                    "birth_year": 1975,
                    "complaint_count": 43,
                    "sustained_count": 1,
                    "final_outcome": "Reprimand",
                    "final_finding": "Sustained",
                    "recommended_outcome": "10 Day Suspension",
                    "category": "Operation/Personnel Violations",
                    "percentile_allegation": "99.8610",
                    "percentile_allegation_civilian": "99.8810",
                    "percentile_allegation_internal": "80.5690",
                    "percentile_trr": "92.1100",
                },
                {
                    "id": 456,
                    "full_name": "Alex Foo",
                    "gender": "Male",
                    "race": "Black",
                    "birth_year": 1980,
                    "complaint_count": 23,
                    "sustained_count": 0,
                    "final_outcome": "Unknown",
                    "final_finding": "Sustained",
                    "category": "Operation/Personnel Violations",
                    "percentile_allegation": "99.8610",
                    "percentile_allegation_civilian": "99.8810",
                    "percentile_allegation_internal": "80.5690",
                    "percentile_trr": "92.1100",
                }
            ],
            "complainants": [
                {
                    "race": "White",
                    "gender": "Male",
                    "age": 18
                },
                {
                    "race": "Black",
                    "gender": "Female",
                    "age": 20
                }
            ],
            "victims": [
                {
                    "race": "Black",
                    "gender": "Male",
                    "age": 53
                },
                {
                    "race": "Black",
                    "gender": "Female",
                    "age": 20
                }
            ],
            "summary": "Lorem ipsum dolor.",
            "point": {
                "lon": -87.664606,
                "lat": 41.68731
            },
            "incident_date": "2002-02-28",
            "start_date": "2002-02-30",
            "end_date": "2002-04-21",
            "address": "3510 Michigan Ave, Chicago, IL 60653",
            "location": "Police Building",
            "beat": "23",
            "involvements": [
                {
                    "officer_id": 1,
                    "involved_type": "investigator",
                    "full_name": "Lauren Skol",
                    "badge": "CPD",
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                },
                {
                    "officer_id": 2,
                    "involved_type": "police_witness",
                    "full_name": "Raymond Piwinicki",
                    "allegation_count": 10,
                    "sustained_count": 3,
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                },
                {
                    "officer_id": 3,
                    "involved_type": "police_witness",
                    "full_name": "German Felix",
                    "allegation_count": 10,
                    "sustained_count": 3,
                    "percentile_allegation_civilian": 99.881,
                    "percentile_allegation_internal": 80.569,
                    "percentile_trr": 92.110
                }
            ],
            "attachments": [
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "video",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                },
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "audio",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                },
                {
                    "title": "CHI - R-00001275 Red",
                    "file_type": "document",
                    "url": "http://foo.com",
                    "preview_image_url": "http://foo.com/bar.jpg"
                }
            ]
        }

## Related Complaints [/cr/{crid}/related-complaints/{?match,distance,offset,limit}]

### Get related complaints [GET]

+ Parameters
    + crid (number, required) - number ID of Allegation
    + match (enum[string], required) - whether the related complaints have similar categories or similar officers
        + Members
            + `categories`
            + `officers`
    + distance (enum[string], required) - distance from where this incident happen
        + Members
            + `0.5mi`
            + `1mi`
            + `2.5mi`
            + `5mi`
            + `10mi`
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
            "count": 1,
            "previous": null,
            "next": null
            "results": [
                {
                    "crid": "838409",
                    "complainants": [{
                        "race": "White",
                        "gender": "Male",
                        "age": 18
                    }],
                    "coaccused": [
                        "R. Piwnicki",
                        "T. Parker"
                    ],
                    "category_names": [
                        "False Arrest",
                        "Use Of Force"
                    ],
                    "point": {
                        "lat": 84.343,
                        "lon": 1.3434
                    }
                    "incident_date": "2016-02-23"
                }
            ]
        }

## Search Aliases [/aliases/{aliasType}/{id}/]

### Update search aliases for a search result [POST]

+ Parameters
    + aliasType (string) - Can be officer/neighborhood/community/report/unit
    + id (number) - Primary key of search result

+ Request (application/json)

        {
            aliases: ["foo", "bar"]
        }

+ Response 200 (application/json)

        {
            "message": "Aliases successfully updated",
            "aliases": ["foo", "bar"]
        }

+ Request (application/json)

        {
            aliases: ["an alias that is absolutely way too long"]
        }

+ Response 400 (application/json)

        {
            "message": {
                "aliases": ["Ensure this field has no more than 20 characters."]
            }
        }

## CR Documents [/cr/{crid}/request-document/]

### Request document [POST]

+ Parameters
    + crid (number) - number ID of Allegation

+ Request (application/json)

        {
            "email": "asdf@example.com"
        }

+ Response 200 (application/json)

        {
            "crid": "293928",
            "message": "Thanks for subscribing"
        }

+ Request (application/json)

        {
            "email": "already_used@example.com"
        }

+ Response 200 (application/json)

        {
            "crid": "293928",
            "message": "Email already added"
        }

+ Request (application/json)

        {
            "email": "malformed email"
        }

+ Response 400 (application/json)

        {
            "message": "Please enter a valid email"
        }

## CR new documents [/cr/list-by-new-document]

### List document which has new documents (in document-cloud) [GET]

+ Parameters
    + limit (number) - number of allegations which has new document

+ Response 200 (application/json)
        [
            {
                "crid": "111",
                "latest_document": {
                    "title": "CR document 1",
                    "url": "http://cr-document.com/1",
                    "preview_image_url": "http://preview.com/url",
                    "file_type": "document",
                    "id": "17276"
                },
                "incident_date": "2015-07-19"
            },
            {
                "crid": "112",
                "latest_document": {
                    "title": "CR document 3",
                    "url": "http://cr-document.com/3",
                    "preview_image_url": "http://preview.com/url3",
                    "file_type": "document",
                    "id": "17279"
                },
                "incident_date": "2014-12-07"
            },
        ]

## Unit summary [/units/{unit_id}/summary]

### Get Unit Summary [GET]

+ Parameters
    + unit_id (number) - number ID of the unit

+ Response 200 (application/json)

        {
            "unit_name": "001",
            "member_records": {
                "active_members": 72,
                "total": 156,
                "facets": [
                    {
                        "name": "race",
                        "entries": [
                            {
                                "name": "White",
                                "count": 10
                            },
                            {
                                "name": "Unknown",
                                "count": 1
                            }
                        ]
                    },
                    {
                        "name": "age",
                        "entries": [
                            {
                                "name": "21-30",
                                "count": 10
                            },
                            {
                                "name": "51+",
                                "count": 2
                            }
                        ]
                    },
                    {
                        "name": "gender",
                        "entries": [
                            {
                                "name": "Male",
                                "count": 10
                            },
                            {
                                "name": "Female",
                                "count": 6
                            },
                            {
                                "name": "X",
                                "count": 4
                            },
                            {
                                "name": "Unknown",
                                "count": 2
                            }
                        ]
                    }
                ]
            },
            "complaint_records": {
                "count": 27,
                "sustained_count": 3,
                "facets": [
                    {
                        "name": "category",
                        "entries": [
                            {
                                "name": "Illegal Search",
                                "count": 12,
                                "sustained_count": 2
                            }
                        ]
                    },
                    {
                        "name": "race"
                        "entries": [
                            {
                                "name": "White",
                                "count": 9,
                                "sustained_count": 1
                            }
                        ]
                    },
                    {
                        "name": "age",
                        "entries": [
                            {
                                "name": "21-30",
                                "count": 5,
                                "sustained_count": 0
                            }
                        ]
                    },
                    {
                        "name": "gender",
                        "entries": [
                            {
                                "name": "Female",
                                "count": 2,
                                "sustained_count": 0
                            }
                        ]
                    }
                ]
            }
        }

## Activity grid [/activity-grid/]

### Get activity cards [GET]

+ Response 200 (application/json)

        [
            {
                "id": 1,
                "full_name": "Jerome Finnigan",
                "visual_token_background_color": "#90b1f5",
                "birth_year": 1963,
                "complaint_count": 90,
                "gender": "Male",
                "rank": "Police Officer",
                "race": "White",
                "sustained_count": 4,
                "percentile_trr": "91.696",
                "percentile_allegation": "99.870",
                "percentile_allegation_civilian": "99.895",
                "percentile_allegation_internal": "80.494"
            },
            {
                "id": 2,
                "full_name": "Raymond Piwnicki",
                "visual_token_background_color": "#aec9e8",
                "birth_year": 1963,
                "complaint_count": 89,
                "gender": "Male",
                "rank": "Detective",
                "race": "White",
                "sustained_count": 6,
                "percentile_trr": "91.696",
                "percentile_allegation": "99.870",
                "percentile_allegation_civilian": "99.895",
                "percentile_allegation_internal": "80.494"
            }
        ]

## Search term categories list [/search-term-categories/]

### Get Search term categories [GET]

+ Response 200 (application/json)

        [
            {
                "name": "Geography",
                "items": [
                    {
                        "name": "Police Districts",
                        "description": "A form of division of a geographical area patrolled by a police force",
                        "id": "police-districts",
                        "call_to_action_type": "view_all"
                    }
                ]
            },
            {
                "name": "Officers",
                "items": [
                    {
                        "name": "Officer Name",
                        "description": "Type the name of an officer into the search bar",
                        "id": "officer-name",
                        "call_to_action_type": "plain_text"
                    }
                ]
            },
            {
                "name": "Complaint Categories",
                "items": [
                    {
                        "name": "Conduct Unbecoming",
                        "description": "Search the data tool for Conduct Unbecoming",
                        "id": "conduct-unbecoming",
                        "call_to_action_type": "link",
                        "link": "https://data.cpdp.co/url-mediator/session-builder?cat__category=Conduct%20Unbecoming"
                    }
                ]
            }
        ]

## General search [/v1/suggestion/{term}/?limit={limit}]

+ Parameters
    + term (string) - Search term
    + limit (number) - Django REST framework limit pagination

### Get search results [GET]

+ Response 200 (application/json)

        {
          "NEIGHBORHOOD": [
            {
              "name": "Washington Heights",
              "tags": ["neighborhoods"],
              "url": "https://data.cpdp.co/url-mediator/session-builder?neighborhood=Washington Heights",
              "most_common_complaint": [
                {
                  "count": 104,
                  "id": 204,
                  "name": "Operation/Personnel Violations"
                },
                {
                  "count": 66,
                  "id": 98,
                  "name": "Use Of Force"
                },
                {
                  "count": 53,
                  "id": 71,
                  "name": "Illegal Search"
                }
              ],
              "officers_most_complaint": [
                {
                  "count": 16,
                  "id": 32344,
                  "name": "Brandon Smith"
                },
                {
                  "count": 15,
                  "id": 7199,
                  "name": "Richard Doroniuk"
                },
                {
                  "count": 15,
                  "id": 9115,
                  "name": "Freddie Frazier"
                }
              ],
              "allegation_count": 1081,
              "id": "345"
            },
            {
              "name": "Washington Park",
              "tags": ["neighborhoods"],
              "url": "https://data.cpdp.co/url-mediator/session-builder?neighborhood=Washington Park",
              "most_common_complaint": [
                {
                  "count": 99,
                  "id": 204,
                  "name": "Operation/Personnel Violations"
                },
                {
                  "count": 78,
                  "id": 98,
                  "name": "Use Of Force"
                },
                {
                  "count": 39,
                  "id": 194,
                  "name": "Operation/Personnel Violations"
                }
              ],
              "officers_most_complaint": [
                {
                  "count": 9,
                  "id": 10259,
                  "name": "Daniel Gomez"
                },
                {
                  "count": 9,
                  "id": 32154,
                  "name": "Pablo Mariano"
                },
                {
                  "count": 7,
                  "id": 966,
                  "name": "Stephen Austin"
                }
              ],
              "allegation_count": 903,
              "id": "339"
            }
          ],
          "CO-ACCUSED": [
            {
              "to": "/officer/28416/henry-thomas/",
              "result_extra_information": "Badge # 20455",
              "result_reason": "coaccused with Walter Ware (17626)",
              "id": "AV_JHHFVEEvAIPTOfirI"
            },
            {
              "to": "/officer/32306/geno-rouse/",
              "result_extra_information": "Badge # 2155",
              "result_reason": "coaccused with Walter Ware (17626)",
              "id": "AV_JHHFfEEvAIPTOfirL"
            },
          ],
          "COMMUNITY": [
            {
              "median_income": "$43,990",
              "tags": [ "community" ],
              "allegation_count": 1081,
              "most_common_complaint": [
                {
                  "count": 104,
                  "id": 204,
                  "name": "Operation/Personnel Violations"
                },
                {
                  "count": 66,
                  "id": 98,
                  "name": "Use Of Force"
                },
                {
                  "count": 53,
                  "id": 71,
                  "name": "Illegal Search"
                }
              ],
              "officers_most_complaint": [
                {
                  "count": 16,
                  "id": 32344,
                  "name": "Brandon Smith"
                },
                {
                  "count": 15,
                  "id": 7199,
                  "name": "Richard Doroniuk"
                },
                {
                  "count": 15,
                  "id": 9115,
                  "name": "Freddie Frazier"
                }
              ],
              "name": "Washington Heights",
              "url": "https://data.cpdp.co/url-mediator/session-builder?community=Washington Heights",
              "race_count": [
                {
                  "count": 25968,
                  "race": "Black or African-American"
                },
                {
                  "count": 510,
                  "race": "Other"
                },
                {
                  "count": 351,
                  "race": "White"
                },
                {
                  "count": 287,
                  "race": "Persons of Spanish Language"
                },
                {
                  "count": 0,
                  "race": "Asian"
                }
              ],
              "id": "497"
            },
            {
              "median_income": "$21,869",
              "tags": [ "community" ],
              "allegation_count": 903,
              "most_common_complaint": [
                {
                  "count": 99,
                  "id": 204,
                  "name": "Operation/Personnel Violations"
                },
                {
                  "count": 78,
                  "id": 98,
                  "name": "Use Of Force"
                },
                {
                  "count": 39,
                  "id": 194,
                  "name": "Operation/Personnel Violations"
                }
              ],
              "officers_most_complaint": [
                {
                  "count": 9,
                  "id": 10259,
                  "name": "Daniel Gomez"
                },
                {
                  "count": 9,
                  "id": 32154,
                  "name": "Pablo Mariano"
                },
                {
                  "count": 7,
                  "id": 966,
                  "name": "Stephen Austin"
                }
              ],
              "name": "Washington Park",
              "url": "https://data.cpdp.co/url-mediator/session-builder?community=Washington Park",
              "race_count": [
                {
                  "count": 11595,
                  "race": "Black or African-American"
                },
                {
                  "count": 271,
                  "race": "Other"
                },
                {
                  "count": 158,
                  "race": "Persons of Spanish Language"
                },
                {
                  "count": 48,
                  "race": "White"
                },
                {
                  "count": 9,
                  "race": "Asian"
                }
              ],
              "id": "432"
            }
          ],
          "UNIT": [{
            "tags": [ ],
            "name": "001",
            "description": "District 001",
            "to": "/unit/001/",
            "id": "2"
          }],
          "UNIT > OFFICERS": [{
            "name": "Robert Bullington",
            "to": "/officer/3277/robert-bullington/",
            "tags": [ ],
            "birth_year": 1963,
            "race": "White",
            "gender": "Male",
            "badge": "8684",
            "rank": "Police Officer",
            "unit": {
              "unit_name": "001",
              "description": "District 001",
              "id": 2,
              "long_unit_name": "Unit 001"
            },
            "appointed_date": "1988-11-07",
            "resignation_date": null,
            "allegation_count": 79,
            "sustained_count": 2,
            "trr_count": 0,
            "discipline_count": 1,
            "honorable_mention_count": 13,
            "civilian_compliment_count": 10,
            "major_award_count": 0,
            "honorable_mention_percentile": 63.7869,
            "percentiles": [{
              "percentile_allegation_civilian": "98.5779",
              "year": 2000,
              "id": 3277,
              "percentile_allegation_internal": "0.0000",
              "percentile_allegation": "98.9364"
            }, {
              "percentile_allegation_civilian": "98.8863",
              "year": 2001,
              "id": 3277,
              "percentile_allegation_internal": "0.0000",
              "percentile_allegation": "99.0767"
            }],
            "id": "3277"
          }],
          "OFFICER": [
            {
              "visual_token_background_color": "#90b1f5",
              "result_extra_information": "Badge # 2328",
              "rank": "Sergeant Of Police",
              "sex": "Male",
              "result_reason": "",
              "unit": "005",
              "salary": null,
              "tags": [],
              "to": "/officer/29841/tommy-walker/",
              "race": "Black",
              "id": "29841"
            },
            {
              "visual_token_background_color": "#90b1f5",
              "result_extra_information": "Badge # 1730",
              "rank": "Sergeant Of Police",
              "sex": "Male",
              "result_reason": "",
              "unit": "008",
              "salary": null,
              "tags": [],
              "to": "/officer/29833/corey-walker/",
              "race": "Black",
              "id": "29833"
            },
          ],
          "RANK": [{
            "id": "Chief",
            "name": "Chief",
            "active_officers_count": 12,
            "officers_most_complaints": [{
              "id": 123,
              "name": "John Hollowell",
              "count": 11,
              "percentile_allegation": "76.2821",
              "percentile_allegation_civilian": "79.4791",
              "percentile_allegation_internal": "0.0001"
              "percentile_trr": "99.0001"
            }]
          }],
          CR: [{
            "id": "1054693",
            "crid": "1054693",
            "to": "/complaint/1054693/",
            "incident_date": "2011-10-15",
            "category": "Use Of Force",
            "sub_category": "Civil Suits - Third Party",
            "address": "22XX East 103RD ST, CHICAGO ILLINOIS 60617",
            "victims": [{
              "gender": "Male",
              "race": "Black"
            }],
            "coaccused": [{
              "id": 20661,
              "full_name": "Mark Nottoli",
              "percentile_trr": "88.0064",
              "percentile_allegation_civilian": "94.6432",
              "percentile_allegation_internal": "79.9133"
              "allegation_count": 52
            }],
            "highlight": {
              "summary": [
                "immediate notification by telephone to the operations <em>command</em> and the Independent Police Review Authority (IPRA)"
              ],
              text_content: [
                "the investigation file, the recommendations of <em>Command</em> Channel Review and the Chief of the Bureau of Internal",
                "toward a supervisory member on or off duty”). <em>Command</em> Channel Review -- the District Commander and Deputy",
              ]
            }
          }]
        }

## Specific type search [/v1/suggestion/{term}/single/{?contentType,offset,limit}]

+ Parameters
    + term (string) - Search term
    + contentType (string) - Data content type (OFFICER, UNIT, COMMUNITY, NEIGHBORHOOD, CO-ACCUSED, UNIT > OFFICERS)
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

### Get search results [GET]

+ Response 200 (application/json)

        {
          "count": 2,
          "previous": null,
          "next": null,
          "results": [
            {
              "text": "Orson Ward",
              "payload": {
                "visual_token_background_color": "#c6d4ec",
                "result_extra_information": "Badge # 13603",
                "rank": "Police Officer",
                "sex": "Male",
                "result_reason": "",
                "unit": "010",
                "salary": null,
                "result_text": "Orson Ward",
                "tags": [],
                "to": "/officer/30022/orson-ward/",
                "race": "Black"
              },
              "id": "30022"
            },
            {
              "text": "Orson Kallenback",
              "payload": {
                "visual_token_background_color": "#f5f4f4",
                "result_extra_information": "",
                "rank": "Police Officer",
                "sex": "Male",
                "result_reason": "",
                "unit": "169",
                "salary": null,
                "result_text": "Orson Kallenback",
                "tags": [],
                "to": "/officer/14026/orson-kallenback/",
                "race": "White"
              },
              "id": "14026"
            }
          ]
        }

## City Summary [/v2/city-summary/]

### Get city summary [GET]

+ Response 200 (application/json)

        {
            "allegation_count": 125735,
            "most_common_complaints": [
                {
                    "name": "Operation/Personnel Violations",
                    "count": 1
                },
                {
                    "name": "Use Of Force",
                    "count": 1
                },
                {
                    "name": "Illegal Search",
                    "count": 1
                },
            ],
            "discipline_count": 6404
        }

## Popup [/v2/popup/]

### Get popup [GET]

+ Response 200 (application/json)

         [
            {
                "name": "unit",
                "page": "officer",
                "title": "Unit",
                "text": "To be updated later"
            },
            {
                "name": "rank",
                "page": "officer",
                "title": "Rank",
                "text": "To be updated later"
            },
            {
                "name": "investigator",
                "page": "complaint",
                "title": "Investigator",
                "text": "To be updated later"
            }
         ]

## Desktop Toast [/v2/toast/]

### Get toast [GET]

+ Response 200 (application/json)

         [
            {
                "name": "OFFICER",
                "template": "**{rank} {full_name}** {age} {race} {gender}, with *{complaint_count} complaints*, *{sustained_count} sustained* {action_type}.",

            },
            {
                "name": "CR",
                "template": "**CR #{crid}** *categorized as {category}* happened in {incident_date} {action_type}.",

            },
            {
                "name": "TRR",
                "template": "**TRR #{id}** *categorized as {force_type}* happened in {incident_date} {action_type}.",
            }
         ]

## Mobile Toast [/v2/mobile/toast/]

### Get toast [GET]

+ Response 200 (application/json)

         [
            {
                "name": "OFFICER",
                "template": "{full_name} {action_type} pinboard",

            },
            {
                "name": "CR",
                "template": "CR #{crid} {action_type} pinboard",

            },
            {
                "name": "TRR",
                "template": "TRR #{id} {action_type} pinboard",
            }
         ]

## Attachments [/attachments/{?match,crid,offset,limit}/]

+ Parameters
    + match (string, optional) - String to match against title and CRID
    + crid (string, optional) - CRID to filter attachments
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

### Get attachments by an unauthenticated user [GET]

+ Response 200 (application/json)

        {
            "count": 2,
            "next": "http://testserver/api/v2/attachment/?limit=2&offset=2",
            "previous": None,
            "results": [
                {
                    "id": 4677,
                    "created_at": "2017-01-14T06:00:01-06:00",
                    "title": "CRID 1051117 CR",
                    "source_type": "DOCUMENTCLOUD",
                    "preview_image_url": "https://assets.documentcloud.org/documents/4769596/pages/CRID-1051117-CR-p1-normal.gif",
                    "crid": "123456",
                    "show": true,
                    "documents_count": 4,
                    "crid": "1051117"
                },
                {
                    "id": 4829,
                    "created_at": "2017-01-14T06:00:01-06:00",
                    "title": "CRID 1064593 CR",
                    "source_type": "DOCUMENTCLOUD",
                    "preview_image_url": "https://assets.documentcloud.org/documents/4769386/pages/CRID-1064593-CR-p1-normal.gif",
                    "crid": "123456",
                    "show": false
                    "documents_count": 3,
                    "crid": "1064593"
                }
            ]
        }

### Get attachments by an authenticated user [GET]

+ Response 200 (application/json)

        {
            "count": 2,
            "next": "http://testserver/api/v2/attachment/?limit=2&offset=2",
            "previous": None,
            "results": [
                {
                    "id": 4677,
                    "created_at": "2017-01-14T06:00:01-06:00",
                    "title": "CRID 1051117 CR",
                    "source_type": "DOCUMENTCLOUD",
                    "preview_image_url": "https://assets.documentcloud.org/documents/4769596/pages/CRID-1051117-CR-p1-normal.gif",
                    "views_count": 1,
                    "downloads_count": 1,
                    "crid": "123456",
                    "show": true,
                    "documents_count": 4,
                    "crid": "1051117"
                },
                {
                    "id": 4829,
                    "created_at": "2017-01-14T06:00:01-06:00",
                    "title": "CRID 1064593 CR",
                    "source_type": "DOCUMENTCLOUD",
                    "preview_image_url": "https://assets.documentcloud.org/documents/4769386/pages/CRID-1064593-CR-p1-normal.gif",
                    "views_count": 2,
                    "downloads_count": 1,
                    "crid": "123456",
                    "show": false
                    "documents_count": 3,
                    "crid": "1064593"
                }
            ]
        }


## Individual Attachment [/attachments/{pk}/]

### Update an attachment [PATCH]

+ Parameters
    + pk (number) - number ID of Attachment

+ Request

        {
            "show": true,
            "title": "New title",
            "text_content": "New text content"
        }

+ Response 200 (application/json)

        {
            "id": 1,
            "show": true,
            "crid": "456",
            "title": "New title",
            "text_content": "New text content",
            "url": "http://foo.com",
            "preview_image_url": "https://assets.documentcloud.org/CRID-456-CR-p1-normal.gif",
            "original_url": "https://www.documentcloud.org/documents/1-CRID-123456-CR.html",
            "created_at": "2017-08-04T09:30:00-05:00",
            "updated_at": "2017-08-05T07:00:01-05:00",
            "crawler_name": "Document Cloud",
            "linked_documents": [],
            "pages": 10,
            "last_updated_by": "Test admin user",
            "views_count": 100,
            "downloads_count": 99,
            "notifications_count": 200,
            "show": true,
        }

### Retrieve an attachment by an authenticated user [GET]

+ Parameters
    + pk (number) - number ID of Attachment


+ Response 200 (application/json)

        {
            "id": "123",
            "crid": "456",
            "title": "CR document",
            "text_content": "CHICAGO POLICE DEPARTMENT RD I HT334604",
            "url": "http://foo.com",
            "preview_image_url": "https://assets.documentcloud.org/CRID-456-CR-p1-normal.gif",
            "original_url": "https://www.documentcloud.org/documents/1-CRID-123456-CR.html",
            "created_at": "2017-08-04T09:30:00-05:00",
            "updated_at": "2017-08-05T07:00:01-05:00",
            "crawler_name": "Document Cloud",
            "linked_documents": [
                {
                    "id": 124,
                    "preview_image_url": "https://assets.documentcloud.org/124/CRID-456-CR-p1-normal.gif",
                },
                {
                    "id": 125,
                    "preview_image_url": "https://assets.documentcloud.org/125/CRID-456-CR-p1-normal.gif",
                }
            ],
            "pages": 10,
            "last_updated_by": "test user",
            "views_count": "100",
            "downloads_count": "99",
            "notifications_count": "200"
        }

### Retrieve an attachment by an unauthenticated user [GET]

+ Parameters
    + pk (number) - number ID of Attachment


+ Response 200 (application/json)

        {
            "id": "123",
            "crid": "456",
            "title": "CR document",
            "text_content": "CHICAGO POLICE DEPARTMENT RD I HT334604",
            "url": "http://foo.com",
            "preview_image_url": "https://assets.documentcloud.org/CRID-456-CR-p1-normal.gif",
            "original_url": "https://www.documentcloud.org/documents/1-CRID-123456-CR.html",
            "created_at": "2017-08-04T09:30:00-05:00",
            "updated_at": "2017-08-05T07:00:01-05:00",
            "crawler_name": "Document Cloud",
            "linked_documents": [
                {
                    "id": "124",
                    "preview_image_url": "https://assets.documentcloud.org/124/CRID-456-CR-p1-normal.gif",
                },
                {
                    "id": "125",
                    "preview_image_url": "https://assets.documentcloud.org/125/CRID-456-CR-p1-normal.gif",
                }
            ],
            "pages": "10",
            "last_updated_by": "test user"
        }

## Retrieve suggestion tags [GET v2/attachments/tags]

+ Response 200 (application/json)

        ['tag1', 'tag2', 'tag3']

## Pinboards [/pinboards/]

### Create a pinboard [POST]

+ Request

        {
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ['123abc'],
            "trr_ids": [1],
            "description": "abc"
        }

+ Response 201 (application/json)

        {
            "id": "5cd06f2b",
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ["123abc"],
            "trr_ids": [1],
            "description": "abc"
        }

### Create a pinboard with some missing item ids [POST]

+ Request

        {
            "title": "My Pinboard",
            "officer_ids": [1, 2, 0, 666],
            "crids": ['123abc', '666zzz'],
            "trr_ids": [0, 1, 5],
            "description": "abc"
        }

+ Response 201 (application/json)

        {
            "id": "5cd06f2b",
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ["123abc"],
            "trr_ids": [1],
            "description": "abc",
            "not_found_items": {
                "officer_ids": [0, 666],
                "crids": ["666zzz"],
                "trr_ids": [0, 5]
            }
        }



## Individual Pinboard [/pinboards/{pk}/]

### Retrieve a pinboard [GET]

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        {
            "id": "5cd06f2b",
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ['123abc'],
            "trr_ids": [1],
            "description": "abc"
        }

### Update a pinboard [PUT]

+ Parameters
    + pk (string) - ID of Pinboard

+ Request

        {
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ['123abc'],
            "trr_ids": [1],
            "description": "abc"
        }

+ Response 200 (application/json)

        {
            "id": "5cd06f2b",
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ['123abc'],
            "trr_ids": [1],
            "description": "abc"
        }

### Remove a pinboard [DELETE]

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200

## Pinboards list [/pinboards/]

### Get all pinboards of current user [GET]

+ Parameters
    + detail (boolean, optional) - return detail pinboard data


+ Response 200 (application/json)
    + detail is false
        ```
            [
                {
                    "id": "5cd06f2b",
                    "title": "My Pinboard 1",
                    "created_at": "2020-04-18",
                    "last_viewed_at": "2020-06-17T03:11:47.384524Z"
                },
                {
                    "id": "962d1e05",
                    "title": "My Pinboard 2",
                    "created_at": "2020-07-18"
                    "last_viewed_at": "2020-06-15T07:08:07.699989Z"
                }
            ]
        ```

    + detail is true
        ```
            [
                {
                    "id": "5cd06f2b",
                    "title": "My Pinboard 1",
                    "created_at": "2020-04-18",
                    "last_viewed_at": "2020-06-16T02:55:33.132359Z",
                    "officer_ids": [1, 2],
                    "crids": ['123abc'],
                    "trr_ids": [1]
                },
                {
                    "id": "962d1e05",
                    "title": "My Pinboard 2",
                    "created_at": "2020-07-18",
                    "last_viewed_at": "2020-06-15T07:09:08.599145Z",
                    "officer_ids": [2, 3],
                    "crids": ['456def'],
                    "trr_ids": [2, 4]
                }
            ]
        ```

## All Pinboards [/pinboards/all/]

### Get all pinboards (authentication required)  [GET]

+ Parameters
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

 + Request
    + Headers

            Authorization: Token ABC123

+ Response 200 (application/json)

        {
            "count": 1112,
            "next": "http://localhost:8000/api/v2/pinboards/all/?limit=20&offset=20",
            "previous": None,
            "results": [
                {
                    allegations_count: 0,
                    created_at: "2019-11-01T09:36:56.978310Z",
                    title: "",
                    description: "",
                    id: "f0e5eba4",
                    officers_count: 1,
                    allegations: [],
                    officers: [
                        {
                            count: 2,
                            id: 5200,
                            name: "Thomas Connor",
                            percentile_allegation: "44.8403",
                            year: 1993
                        }
                    ],
                    trrs: [],
                    trrs_count: 0,
                    child_pinboard_count: 2,
                },
                {
                   "id": "962d1e05",
                    "title": "",
                    "description": "",
                    "created_at": "2019-09-30T10:21:45.864200Z",
                    "officers_count": 4,
                    "allegations_count": 1,
                    "trrs_count": 1,
                    "officers": [
                        {
                            "percentile_allegation": "74.7611",
                            "year": 1993,
                            "id": 5,
                            "name": "Carmen Abbate",
                            "count": 4
                        },
                        {
                            "percentile_allegation_civilian": "58.8524",
                            "percentile_allegation_internal": "0.0000",
                            "percentile_allegation": "49.0044",
                            "year": 2003,
                            "id": 4,
                            "name": "Carmel Abbate",
                            "count": 7
                        },
                        {
                            "percentile_allegation_civilian": "0.0000",
                            "percentile_allegation_internal": "0.0000",
                            "percentile_allegation": "0.0000",
                            "year": 2004,
                            "id": 3,
                            "name": "Daniel Abate",
                            "count": 0
                        },
                        {
                            "percentile_trr": "79.8763",
                            "percentile_allegation_civilian": "61.2069",
                            "percentile_allegation_internal": "76.9384",
                            "percentile_allegation": "61.2357",
                            "year": 2016,
                            "id": 1,
                            "name": "Jeffery Aaron",
                            "count": 6
                        }
                    ],
                    "allegations": [
                        {
                            "crid": "1053673",
                            "category": "False Arrest",
                            "incident_date": "2012-04-26"
                        }
                    ],
                    "trrs": [
                        {
                            "id": 123,
                            "trr_datetime": "2004-02-24",
                            "category": "Physical Force - Holding"
                        }
                    ]
                },
                ...
            ]
        }

## Pinboard complaints [/pinboards/{pk}/complaints]

### Get selected complaints

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                'address': '16XX N TALMAN AVE, CHICAGO IL',
                'coaccused': [{
                    'id': 1,
                    'full_name': 'Jesse Pinkman',
                    'complaint_count': 6,
                    'sustained_count': 5,
                    'birth_year': 1940,
                    'complaint_percentile': 0.0,
                    'recommended_outcome': '11 Day Suspension',
                    'final_outcome': 'Separation',
                    'final_finding': 'Sustained',
                    'category': 'Use Of Force',
                    'disciplined': True,
                    'race': 'White',
                    'gender': 'Male',
                    'rank': 'Sergeant of Police',
                    'percentile': {
                        'year': 2015,
                        'percentile_trr': '3.3000',
                        'percentile_allegation': '0.0000',
                        'percentile_allegation_civilian': '1.1000',
                        'percentile_allegation_internal': '2.2000'
                    },
                }],
                'sub_category': 'Miscellaneous',
                'to': '/complaint/123/',
                'crid': '123',
                'incident_date': '2002-01-01',
                'point': {'lon': -35.5, 'lat': 68.9},
                'most_common_category': 'Use Of Force',
                'victims': [{
                    'gender': 'Female',
                    'race': 'White',
                    'age': 40,
                }]
            },
            {
                'address': '17XX N TALMAN AVE, CHICAGO IL',
                'coaccused': [{
                    'id': 2,
                    'full_name': 'Walter White',
                    'complaint_count': 6,
                    'sustained_count': 5,
                    'birth_year': 1940,
                    'complaint_percentile': 0.0,
                    'recommended_outcome': '10 Day Suspension',
                    'final_outcome': 'Separation',
                    'final_finding': 'Sustained',
                    'category': 'Verbal Abuse',
                    'disciplined': True,
                    'race': 'White',
                    'gender': 'Male',
                    'rank': 'Sergeant of Police',
                    'percentile': {
                        'year': 2015,
                        'percentile_trr': '3.3000',
                        'percentile_allegation': '0.0000',
                        'percentile_allegation_civilian': '1.1000',
                        'percentile_allegation_internal': '2.2000'
                    },
                }],
                'sub_category': 'Miscellaneous',
                'to': '/complaint/124/',
                'crid': '124',
                'incident_date': '2002-01-01',
                'point': {'lon': -35.5, 'lat': 68.9},
                'most_common_category': 'Verbal Abuse',
                'victims': [{
                    'gender': 'Male',
                    'race': 'White',
                    'age': 40,
                }]
            }
        ]

## Pinboard officers [/pinboards/{pk}/officers]

### Get selected officers

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                'id': 123,
                'complaint_count': 20,
                'unit': {
                    'id': 4,
                    'unit_name': '004',
                    'description': 'District 004',
                    'long_unit_name': 'Unit 004',
                },
                'date_of_appt': '2000-01-02',
                'date_of_resignation': '2010-02-03',
                'active': 'Active',
                'rank': 'Sergeant',
                'full_name': 'Michael Flynn',
                'has_unique_name': True,
                'race': 'Black',
                'badge': '456',
                'historic_badges': ['789'],
                'historic_units': [
                    {
                        'id': 4,
                        'unit_name': '004',
                        'description': 'District 004',
                        'long_unit_name': 'Unit 004',
                    },
                    {
                        'id': 5,
                        'unit_name': '005',
                        'description': 'District 005',
                        'long_unit_name': 'Unit 005',
                    }
                ],
                'gender': 'Female',
                'birth_year': 1950,
                'current_salary': 10000,
                'allegation_count': 20,
                'complaint_percentile': 99.99,
                'honorable_mention_count': 3,
                'sustained_count': 4,
                'unsustained_count': 5,
                'discipline_count': 6,
                'civilian_compliment_count': 2,
                'trr_count': 7,
                'major_award_count': 8,
                'honorable_mention_percentile': 88.88,
                'to': '/officer/123/michael-flynn/',
                'url': f'{settings.V1_URL}/officer/michael-flynn/123',
                'tags': ['tag1', 'tag2'],
                'coaccusals': [{
                    'id': 789,
                    'coaccusal_count': 10
                }],
                'percentiles': [
                    {
                        'id': 123,
                        'year': 2002,
                        'percentile_trr': '99.8800',
                        'percentile_allegation_civilian': '77.6600',
                        'percentile_allegation_internal': '66.5500',
                    },
                    {
                        'id': 123,
                        'year': 2003,
                        'percentile_trr': '99.9900',
                        'percentile_allegation': '88.8800',
                        'percentile_allegation_civilian': '77.7700',
                        'percentile_allegation_internal': '66.6600',
                    },
                ]
            }
        ]

## Pinboard trrs [/pinboards/{pk}/trrs]

### Get selected trrs

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                'id': 1,
                'trr_datetime': '2012-01-01',
                'category': 'Impact Weapon',
                'point': {'lon': 1.0, 'lat': 1.0},
                'to': '/trr/1/',
                'taser': False,
                'firearm_used': False,
                'address': '14XX CHICAGO IL 60636',
                'officer': {
                    'id': 1,
                    'full_name': 'Daryl Mack',
                    'complaint_count': 0,
                    'sustained_count': 0,
                    'birth_year': 1975,
                    'complaint_percentile': 99.345,
                    'race': 'White',
                    'gender': 'Male',
                    'rank': 'Police Officer',
                    'percentile': {
                        'percentile_trr': '12.0000',
                        'percentile_allegation_civilian': '98.4344',
                        'percentile_allegation_internal': '99.7840',
                    }
                }
            },
            {
                'id': 2,
                'trr_datetime': '2013-01-01',
                'category': 'Unknown',
                'point': {'lon': 2.0, 'lat': 2.0},
                'to': '/trr/2/',
                'taser': False,
                'firearm_used': False,
                'address': '14XX CHICAGO IL 60636',
                'officer': {
                    'id': 1,
                    'full_name': 'Daryl Mack',
                    'complaint_count': 0,
                    'sustained_count': 0,
                    'birth_year': 1975,
                    'complaint_percentile': 99.345,
                    'race': 'White',
                    'gender': 'Male',
                    'rank': 'Police Officer',
                    'percentile': {
                        'percentile_trr': '12.0000',
                        'percentile_allegation_civilian': '98.4344',
                        'percentile_allegation_internal': '99.7840',
                    }
                }
            }
        ]

## Pinboard relevant documents [/pinboards/{pinboard_id}/relevant-documents/{?offset,limit}]

### Get Pinboard relevant documents list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
          "count": 100,
          "previous": "http://cpdp.co/pinboards/f871a13f/relevant-documents/?",
          "next": "http://cpdp.co/pinboards/f871a13f/relevant-documents/?limit=20&offset=40",
          "results": [
            {
              "id": 1,
              "preview_image_url": "https://assets.documentcloud.org/CRID-1-CR-p1-normal.gif",
              "url": "http://cr-1-document.com/",
              "allegation": {
                  "crid": "1",
                  "category": "Operation/Personnel Violations",
                  "incident_date": "2002-02-21",
                  "coaccused": [{
                      "id": 1,
                      "rank": "Police Officer",
                      "full_name": "Jerome Finnigan",
                      "coaccusal_count": None,
                      "allegation_count": 10,
                      "percentile_trr": "99.9900",
                      "percentile_allegation": "88.8800",
                      "percentile_allegation_civilian": "77.7700",
                      "percentile_allegation_internal": "66.6600",
                  }]
                }
                "point": {"lon": 12.0, "lat": 21.0},
              }
            },
            {
              "preview_image_url": "http://via.placeholder.com/121x157",
              "url": "https://assets.documentcloud.org/documents/5680384/CRID-1083633-CR-CRID-1083633-CR-Tactical.pdf",
              "allegation": {
                "crid": "1079876",
                "category": "Operations/Personnel Violation",
                "incident_date": "2014-05-02",
                "coaccused": [{
                    "id": 1,
                    "rank": "Police Officer",
                    "full_name": "Jerome Finnigan",
                    "coaccusal_count": None,
                    "allegation_count": 10,
                    "percentile_trr": "99.9900",
                    "percentile_allegation": "88.8800",
                    "percentile_allegation_civilian": "77.7700",
                    "percentile_allegation_internal": "66.6600",
                }]
              }
            },
            ...
          ]
        }


## Pinboard relevant coaccusals [/pinboards/{pinboard_id}/relevant-coaccusals/{?offset,limit}]

### Get Pinboard relevant coaccusals list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
          "count": 100,
          "previous": "http://cpdp.co/pinboards/f871a13f/relevant-coaccusals/?",
          "next": "http://cpdp.co/pinboards/f871a13f/relevant-coaccusals/?limit=20&offset=40",
          "results": [{
              "id": 11,
              "full_name": "Jerome Finnigan",
              "date_of_appt": "2000-01-02",
              "date_of_resignation": "2010-02-03",
              "badge": "456",
              "gender": "Female",
              "to": "/officer/11/jerome-finnigan/",
              "birth_year": 1950,
              "race": "Black",
              "rank": "Police Officer",
              "unit": {
                  "id": 4,
                  "unit_name": "004",
                  "description": "District 004",
                  "long_unit_name": "Unit 004"
              },
              "percentile_trr": "11.1100",
              "percentile_allegation": "22.2200",
              "percentile_allegation_civilian": "33.3300",
              "percentile_allegation_internal": "44.4400",
              "allegation_count": 1,
              "civilian_compliment_count": 2,
              "sustained_count": 4,
              "discipline_count": 6,
              "trr_count": 7,
              "major_award_count": 8,
              "honorable_mention_count": 3,
              "honorable_mention_percentile": 88.88,
              "coaccusal_count": 5,
          }, {
              "id": 21,
              "full_name": "Ellis Skol",
              "date_of_appt": "2000-01-02",
              "date_of_resignation": "2010-02-03",
              "badge": "456",
              "gender": "Female",
              "to": "/officer/21/ellis-skol/",
              "birth_year": 1950,
              "race": "Black",
              "rank": "Senior Officer",
              "unit": {
                  "id": 4,
                  "unit_name": "004",
                  "description": "District 004",
                  "long_unit_name": "Unit 004"
              },
              "percentile_trr": "33.3300",
              "percentile_allegation": "44.4400",
              "percentile_allegation_civilian": "55.5500",
              "allegation_count": 1,
              "civilian_compliment_count": 2,
              "sustained_count": 4,
              "discipline_count": 6,
              "trr_count": 7,
              "major_award_count": 8,
              "honorable_mention_count": 3,
              "honorable_mention_percentile": 88.88,
              "coaccusal_count": 4,
            },
            ...
          ]
        }


## Pinboard relevant complaints [/pinboards/{pinboard_id}/relevant-complaints/{?offset,limit}]

### Get Pinboard relevant complaints list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
          "count": 100,
          "previous": "http://cpdp.co/pinboards/f871a13f/relevant-complaints/?",
          "next": "http://cpdp.co/pinboards/f871a13f/relevant-complaints/?limit=20&offset=40",
          "results": [{
              'crid': '2',
              'address': '',
              'category': 'Unknown',
              'incident_date': '2002-02-22',
              'victims': [],
              'point': None,
              'to': '/complaint/2/',
              'sub_category': 'Unknown',
              'coaccused': [{
                  'id': 2,
                  'rank': 'Senior Officer',
                  'full_name': 'Ellis Skol',
                  'coaccusal_count': None,
                  'allegation_count': 1,
                  'percentile': {
                      'year': 2016,
                      'percentile_trr': '33.3300',
                      'percentile_allegation': '44.4400',
                      'percentile_allegation_civilian': '55.5500',
                  },
              }],
          }, {
              'crid': '1',
              'address': '',
              'category': 'Operation/Personnel Violations',
              'incident_date': '2002-02-21',
              'victims': [{
                  'gender': 'Male',
                  'race': 'Black',
                  'age': 35,
              }],
              'point': {'lon': 0.01, 'lat': 0.02},
              'to': '/complaint/1/',
              'sub_category': 'Subcategory',
              'coaccused': [{
                  'id': 99,
                  'rank': 'Detective',
                  'full_name': 'Edward May',
                  'coaccusal_count': None,
                  'allegation_count': 5,
                  'percentile': {
                      'year': 2016,
                  },
              }, {
                  'id': 1,
                  'rank': 'Police Officer',
                  'full_name': 'Jerome Finnigan',
                  'coaccusal_count': None,
                  'allegation_count': 2,
                  'percentile': {
                      'year': 2016,
                      'percentile_trr': '11.1100',
                      'percentile_allegation': '22.2200',
                      'percentile_allegation_civilian': '33.3300',
                      'percentile_allegation_internal': '44.4400',
                  },
              }],
            },
            ...
          ]
        }

## Pinboard complaint summary [/mobile/pinboards/{pk}/complaint-summary]

### Get complaint summary for current pinboard

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                "category": "Use Of Force",
                "count": 134
            },
            {
                "category": "Operation/Personnel Violations",
                "count": 103
            },
            {
                "category": "Traffic",
                "count": 12
            },
            {
                "category": "Criminal Misconduct",
                "count": 11
            },
            {
                "category": null,
                "count": 11
            }
        ]

## Pinboard TRR summary [/mobile/pinboards/{pk}/trr-summary]

### Get TRR summary for current pinboard

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                "force_type": null,
                "count": 331
            },
            {
                "force_type": "Verbal Commands",
                "count": 88
            },
            {
                "force_type": "Physical Force - Stunning",
                "count": 83
            },
            {
                "force_type": "Taser",
                "count": 10
            },
            {
                "force_type": "Chemical",
                "count": 3
            }
        ]

## Pinboard officers summary [/mobile/pinboards/{pk}/officers-summary]

### Get officers summary for current pinboard

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        {
            "race": [
                {
                    "race": "Black",
                    "percentage": 0.31
                },
                {
                    "race": "White",
                    "percentage": 0.58
                },
                {
                    "race": "Hispanic",
                    "percentage": 0.1
                },
                {
                    "race": "Other",
                    "percentage": 0.01
                }
            ],
            "gender": [
                {
                    "gender": "M",
                    "percentage": 0.98
                },
                {
                    "gender": "F",
                    "percentage": 0.02
                },
                {
                    "gender": "Unknown",
                    "percentage": 0.0
                }
            ]
        }

## Pinboard complainants summary [/mobile/pinboards/{pk}/complainants-summary]

### Get complainants summary for current pinboard

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        {
            "race": [
                {
                    "race": "Black",
                    "percentage": 0.7
                },
                {
                    "race": "White",
                    "percentage": 0.13
                },
                {
                    "race": "Hispanic",
                    "percentage": 0.06
                },
                {
                    "race": "Other",
                    "percentage": 0.11
                }
            ],
            "gender": [
                {
                    "gender": "M",
                    "percentage": 0.51
                },
                {
                    "gender": "F",
                    "percentage": 0.45
                },
                {
                    "gender": "Unknown",
                    "percentage": 0.04
                }
            ]
        }

## Pinboard mobile complaints [/mobile/pinboards/{pk}/complaints]

### Get selected complaints

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                "crid": "1000001",
                "incident_date": "2010-01-01",
                "point": {"lon": 1.0, "lat": 1.0},
                "category": "Use Of Force",
            },
            {
                "crid": "1000002",
                "incident_date": "2011-01-01",
                "point": {"lon": 2.0, "lat": 2.0},
                "category": "Verbal Abuse",
            }
        ]

## Pinboard mobile officers [/mobile/pinboards/{pk}/officers]

### Get selected officers

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                "id": 1,
                "full_name": "Daryl Mack",
                "complaint_count": 0,
                "rank": "Police Officer",
                "percentile_trr": "12.0000",
                "percentile_allegation": "99.3450",
                "percentile_allegation_civilian": "98.4344",
                "percentile_allegation_internal": "99.7840",
            },
            {
                "id": 2,
                "full_name": "Ronald Watts",
                "complaint_count": 0,
                "rank": "Detective",
                "percentile_trr": "0.0000",
                "percentile_allegation": "99.5000",
                "percentile_allegation_civilian": "98.4344",
                "percentile_allegation_internal": "99.7840",
            }
        ]

## Pinboard mobile trrs [/mobile/pinboards/{pk}/trrs]

### Get selected trrs

+ Parameters
    + pk (string) - ID of Pinboard

+ Response 200 (application/json)

        [
            {
                'id': 1,
                'trr_datetime': '2012-01-01',
                'category': 'Impact Weapon',
                'point': {'lon': 1.0, 'lat': 1.0},
            },
            {
                'id': 2,
                'trr_datetime': '2013-01-01',
                'category': 'Unknown',
                'point': {'lon': 2.0, 'lat': 2.0},
            }
        ]

## Pinboard mobile relevant documents [/mobile/pinboards/{pinboard_id}/relevant-documents/{?offset,limit}]

### Get Pinboard relevant documents list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
          "count": 100,
          "previous": "http://cpdp.co/pinboards/f871a13f/relevant-documents/?",
          "next": "http://cpdp.co/pinboards/f871a13f/relevant-documents/?limit=20&offset=40",
          "results": [
            'id': 2,
            'preview_image_url': "https://assets.documentcloud.org/CRID-2-CR-p1-normal.gif",
            'url': 'http://cr-2-document.com/',
            'allegation': {
              'crid': '2',
              'category': 'Unknown',
              'incident_date': '2002-02-22',
              'officers': [
                {
                  'id': 4,
                  'rank': 'Senior Police Officer',
                  'full_name': 'Raymond Piwinicki',
                  'coaccusal_count': None,
                  'percentile': {
                      'year': 2016,
                  }
                },
                {
                  'id': 2,
                  'rank': 'Detective',
                  'full_name': 'Edward May',
                  'coaccusal_count': None,
                  'percentile': {
                      'year': 2016,
                      'percentile_trr': '11.1100',
                      'percentile_allegation': '22.2200',
                      'percentile_allegation_civilian': '33.3300',
                      'percentile_allegation_internal': '44.4400',

                  }
                },
              ]
            }
          }, {
            'id': 1,
            'preview_image_url': "https://assets.documentcloud.org/CRID-1-CR-p1-normal.gif",
            'url': 'http://cr-1-document.com/',
            'allegation': {
              'crid': '1',
              'category': 'Operation/Personnel Violations',
              'incident_date': '2002-02-21',
              'officers': [{
                'id': 1,
                'rank': 'Police Officer',
                'full_name': 'Jerome Finnigan',
                'coaccusal_count': None,
                'percentile': {
                    'year': 2016,
                    'percentile_trr': '99.9900',
                    'percentile_allegation': '88.8800',
                    'percentile_allegation_civilian': '77.7700',
                    'percentile_allegation_internal': '66.6600',
                }
              }]
            },
            ...
          ]
        }


## Pinboard mobile relevant coaccusals [/mobile/pinboards/{pinboard_id}/relevant-coaccusals/{?offset,limit}]

### Get Pinboard relevant coaccusals list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

            {
              'id': 11,
              'rank': 'Police Officer',
              'full_name': 'Jerome Finnigan',
              'coaccusal_count': 5,
              'percentile': {
                'year': 2016,
                'percentile_trr': '11.1100',
                'percentile_allegation': '22.2200',
                'percentile_allegation_civilian': '33.3300',
                'percentile_allegation_internal': '44.4400',
              },
            }, {
              'id': 21,
              'rank': 'Senior Officer',
              'full_name': 'Ellis Skol',
              'coaccusal_count': 4,
              'percentile': {
                'year': 2016,
                'percentile_trr': '33.3300',
                'percentile_allegation': '44.4400',
                'percentile_allegation_civilian': '55.5500',
              },
            },
            ...
          ]
        }


## Pinboard mobile relevant complaints [/mobile/pinboards/{pinboard_id}/relevant-complaints/{?offset,limit}]

### Get Pinboard relevant complaints list [GET]

+ Parameters
    + pinboard_id (number) - number ID of the pinboard
    + offset (number, optional) - offset from which to get additional results
        + Default: `0`
    + limit (number, optional) - limit of how many results to return
        + Default: `20`

+ Response 200 (application/json)

        {
          "count": 100,
          "previous": "http://cpdp.co/pinboards/f871a13f/relevant-complaints/?",
          "next": "http://cpdp.co/pinboards/f871a13f/relevant-complaints/?limit=20&offset=40",
          "results": [
            {
              'crid': '2',
              'category': 'Unknown',
              'incident_date': '2002-02-22',
              'officers': [{
                'id': 2,
                'rank': 'Senior Officer',
                'full_name': 'Ellis Skol',
                'coaccusal_count': None,
                'percentile': {
                    'year': 2016,
                    'percentile_trr': '33.3300',
                    'percentile_allegation': '44.4400',
                    'percentile_allegation_civilian': '55.5500',
                },
              }],
              'point': None,
            }, {
              'crid': '1',
              'category': 'Operation/Personnel Violations',
              'incident_date': '2002-02-21',
              'officers': [{
                'id': 99,
                'rank': 'Detective',
                'full_name': 'Edward May',
                'coaccusal_count': None,
                'percentile': {
                    'year': 2016,
                },
              }, {
                'id': 1,
                'rank': 'Police Officer',
                'full_name': 'Jerome Finnigan',
                'coaccusal_count': None,
                'percentile': {
                    'year': 2016,
                    'percentile_trr': '11.1100',
                    'percentile_allegation': '22.2200',
                    'percentile_allegation_civilian': '33.3300',
                    'percentile_allegation_internal': '44.4400',
                },
              }],
              'point': {'lon': 0.01, 'lat': 0.02},
            },
            ...
          ]
        }

## Lastest retrieved pinboard [/pinboards/latest-retrieved-pinboard/]

### Get the lastest retrieved pinboard of the current session

+ Response 200 (application/json)

        {
            "id": "5cd06f2b",
            "title": "My Pinboard",
            "officer_ids": [1, 2],
            "crids": ["123abc"],
            "trr_ids": [1],
            "description": "abc"
        }

## Social graph network data [/social-graph/network/{?officer_ids,unit_id,pinboard_id,complaint_origin,threshold}]

### Get Pinboard relevant complaints list [GET]

+ Parameters
    + We only need to pass one of these parameters:
      + officer_ids (string) - a comma separated list of number ID of the officers
      + unit_id (number) - number ID of the unit
      + pinboard_id (number) - number ID of the pinboard
    + complaint_origin (string, optional) - type of complaint
      + Accepted values: `CIVILIAN`, `OFFICER`, `ALL`
      + Default: `CIVILIAN`
    + threshold (number, optional) - the minimum number of coaccusals officer
      + Accepted values: `1` -> `4`
      + Default: `2`


+ Response 200 (application/json)

        {
          "pinboard_id": "f871a13f",
          "coaccused_data": [
            {
              "officer_id_1": 3663,
              "officer_id_2": 4881,
              "incident_date": "1994-05-24",
              "accussed_count": 2
            },
            {
              "officer_id_1": 3663,
              "officer_id_2": 31945,
              "incident_date": "1998-11-09",
              "accussed_count": 2
            },
            {
              "officer_id_1": 3663,
              "officer_id_2": 31945,
              "incident_date": "1998-12-03",
              "accussed_count": 3
            },
            {
              "officer_id_1": 30209,
              "officer_id_2": 31945,
              "incident_date": "1998-12-03",
              "accussed_count": 2
            },
            {
              "officer_id_1": 3663,
              "officer_id_2": 30209,
              "incident_date": "1998-12-03",
              "accussed_count": 2
            },
            {
              "officer_id_1": 4881,
              "officer_id_2": 31945,
              "incident_date": "2000-04-28",
              "accussed_count": 2
            },
            {
              "officer_id_1": 3663,
              "officer_id_2": 31945,
              "incident_date": "2002-09-28",
              "accussed_count": 4
            },
            {
              "officer_id_1": 3663,
              "officer_id_2": 31945,
              "incident_date": "2002-10-13",
              "accussed_count": 5
            }
          ],
          "officers": [
            {
              "id": 30209,
              "full_name": "Bennie Watson",
              "percentile_trr": "0.0000",
              "percentile_allegation_civilian": "35.4196",
              "percentile_allegation_internal": "83.0449"
            },
            {
              "id": 3663,
              "full_name": "Donnell Calhoun",
              "percentile_allegation_civilian": "87.4780",
              "percentile_allegation_internal": "96.5164"
            },
            {
              "id": 4881,
              "full_name": "Gilbert Cobb",
              "percentile_trr": "0.0000",
              "percentile_allegation_civilian": "85.1838",
              "percentile_allegation_internal": "0.0000"
            },
            {
              "id": 31945,
              "full_name": "Melvin Ector",
              "percentile_trr": "0.0000",
              "percentile_allegation_civilian": "94.1100",
              "percentile_allegation_internal": "61.1521"
            }
          ],
          "list_event": [
            "1994-05-24",
            "1998-11-09",
            "1998-12-03",
            "2000-04-28",
            "2002-09-28",
            "2002-10-13"
          ]
        }

## App config [/app-config/]

### List config [GET]

+ Response 200 (application/json)
        {
            "CONFIG_1": "VALUE 1",
            "CONFIG_2": "VALUE 2",
            "CONFIG_3": "VALUE 3"
        }