Mississippi eCrash PDF Request API Information
Version 1.1 (August 2023)
Download the PDF version 
Endpoint URL
| TEST: |
https://ecrashtest.dps.ms.gov |
| PRODUCTION: |
https://ecrash.dps.ms.gov/ |
This web service exists to provide single document-level access to the PDF version of a known Mississippi crash report (MUCR) created with eCrash.
Authentication
A user name and password will be provided for this service. HTTP Basic Authentication will be used for the request.
Download PDF
POST /api/vendor/pdf/v1
Description
Returns the MUCR PDF of a single crash report based on the search provided search parameters.
Authentication
This method requires HTTP Basic Authentication. Use your issued user name and password for the requesting
agency.
API Details
Request Body Schema
The request body should be a JSON object containing the following properties:
AgencyId (Required) |
string |
The Mississippi LEA # of the requesting agency. |
PersonLastName (Required) |
string |
The last name of a person involved in the crash. |
CaseNumber |
string |
The local or state case number for the crash report. |
CrashDate |
Date |
The date of the crash. |
VehicleId |
string |
The VIN or license plate number of a vehicle involved. |
IncludePhotos |
Boolean |
Indicates whether or not to include the photos page in the returned MUCR PDF. The default
value is false.
|
Important: Either CaseNumber or a combination of CrashDate and VehicleId must be provided for a
request to be valid.
Responses
| 200 |
The response will contain the MUCR PDF matching the supplied search parameters.
Headers
ECrashMS-Id |
The system ID (GUID) for this crash report. |
ETag |
The system row timestamp for this crash report. |
Location |
The URL for the Direct Download PDF for this crash report. |
ECrashMS-AgencyId |
The Mississippi LEA # for this crash report. |
ECrashMS-LocalCaseNumber |
The local case number for this crash report. |
ECrashMS-StateCaseNumber |
The state case number for this crash report. |
|
| 300 |
More than one report matched the specified parameters. |
| 400 |
Insufficient search parameters were supplied. |
| 403 |
Not authorized to download crash report PDFs for this agency. |
| 404 |
No crash report matched the specified search parameters. |
| 451 |
The matching report has not been approved by a supervisor. |
GET /api/vendor/pdf/v1/{id}/photos
Description
Returns the photograph metadata for the given crash report ID.
Authentication
This method requires HTTP Basic Authentication. Use your issued user name and password for the requesting
agency.
API Details
Path Parameters
id (Required) |
string <GUID> |
The ID of the crash report.
|
Responses
| 200 |
The response will contain an array of metadata for photographs (.jpg, .jpeg, .png, and .gif)
attached to the crash report with the supplied id.
Metadata
Id |
GUID |
The ID of the crash report. |
Filename |
string |
The attachment file name. |
Hash |
string |
The hash of the attachment. |
Length |
int |
The size of the attachment in bytes. |
|
| 403 |
Not authorized to download crash report PDFs for this agency. |
| 404 |
No crash report matched the supplied id. |
Get Photo
GET /api/vendor/pdf/v1/{id}/photos/{hash}/{filename}
Description
Returns the matching photograph for the given crash report ID, attachment hash, and attachment
filename.
Authentication
This method requires HTTP Basic Authentication. Use your issued user name and password for the requesting
agency.
API Details
Path Parameters
id (Required) |
string <GUID> |
The ID of the crash report. |
filename (Required) |
string |
The attachment file name. |
hash (Required) |
string |
The hash of the attachment. |
Responses
| 200 |
The response will contain the requested photograph.
Metadata
ETag |
The system row timestamp for this photo attachment. |
|
| 403 |
Not authorized to download crash report PDFs for this agency. |
| 404 |
No crash report matched the supplied id, filename and hash. |
Direct Download PDF
GET /api/vendor/pdf/v1/{id}
Description
Returns the MUCR PDF for the given crash report ID.
Authentication
This method requires HTTP Basic Authentication. Use your issued user name and password for the requesting
agency.
API Details
Path Parameters
id (Required) |
string <GUID> |
The ID of the crash report to download. |
Query String Parameters
includePhotos |
Boolean |
Indicates whether or not to include the photos page in the returned MUCR PDF. The default
value is false.
|
Responses
| 200 |
The response will contain the MUCR PDF matching the supplied id.
Headers
ECrashMS-Id |
The system ID (GUID) for this crash report. |
ETag |
The system row timestamp for this crash report. |
Location |
The URL for the Direct Download PDF for this crash report. |
ECrashMS-AgencyId |
The Mississippi LEA # for this crash report. |
ECrashMS-LocalCaseNumber |
The local case number for this crash report. |
ECrashMS-StateCaseNumber |
The state case number for this crash report. |
|
| 304 |
The matching report is not modified from the supplied row timestamp in the request’s If-None-Match header. No report is returned. |
| 403 |
Not authorized to download crash report PDFs for this agency. |
| 404 |
No crash report matched the supplied id. |
| 451 |
The matching report has not been approved by a supervisor. |
Direct Download Legacy PDF
GET /api/vendor/pdf/v1/legacy/{id}
Description
Returns the legacy MUCR PDF for the given crash report ID.
Authentication
This method requires HTTP Basic Authentication. Use your issued user name and password for the requesting
agency.
API Details
Path Parameters
id (Required) |
int |
The ID of the crash report to download. |
Responses
| 200 |
The response will contain the legacy crash report PDF matching the supplied id.
Headers
Location |
The URL for the Direct Download PDF for this crash report. |
|