Hazard Reports

This page shows how to work with hazard reports and related data.

/HazardReports

HTTP POST Authentication Tokens

Creates a new hazard report.

Input

Field

Type

Constraints

Details

title

String 256

Required

description

String

Required

date

Date

Required

The UTC date that the reported hazard occurred.

importance

Integer 1-5

Required

locations

String 256

Free text list of locations pertaining to the hazard being reported.

tailsAndEquipmentInvolved

String 256

Free text list of tails and other types of vehicles/equipment pertaining to the hazard being reported.

suggestions

String

Potential mitigation and/or preventative measures as suggested by the user reporting the hazard.

contactInformation

String 256

Free form contact information entered by the user.

reportedAnonymously

Boolean

Indicates whether the report should be treated as anonymous. If this value is true, any contact information will be ignored and the report will be associated with the anonymous account.

documents

Array

This field can be null or an empty list. If the list contains items, none of them may be null.

Field	Type	Constraints	Details
fileName	string 256	Required
file	string	Required Encoding Validated	The contents of the file as a base64 encoded string.
title	string 256		If this value is omitted, the file name will be used instead.

Output

Field	Type	Description
id	integer	The identity of the hazard report that was created.

Examples

JavaScript Object Literal - Minimum Required Data

    var obj = {
        title: "A Hazard Report",
        date: "2014-01-1T01:30Z",
        description: "More detail about the report",
        importance: 3
    };

JavaScript Object Literal - Additional Data

    var obj = {
        title: "A Hazard Report",
        date: "2014-01-1T01:30Z",
        description: "More detail about the report",
        importance: 3,
        locations: "Hangar B",
        contactInformation: "Steve at Acme witnessed the incident. His number is 623-555-1234.",
        documents: [{
            fileName: "hello.txt",
            file: "aGVsbG8gd29ybGQh" // "hello world" base64 encoded
        }]
    };

Retrieving the ID of the Created Item

    $.ajax({
        // other properties omitted
        success: function(data){
            console.log(data.id);
        }
    });

API Version 14.1.9203.25207