Trendsic Platform Service

<back to all web services

SafetyIncidentCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/safety/incidents
"use strict";
export class SafetyIncident {
    /** @param {{SafetyIncidentID?:number,SafetyIncidentUID?:string,BranchId?:string,ProjectID?:number,IncidentNo?:string,IncidentType?:string,Severity?:string,Status?:string,Title?:string,Location?:string,CrewLabel?:string,Description?:string,ReportedBy?:string,IsRecordable?:boolean,OccurredAt?:string,ClosedAt?:string,SourceRef?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,DaysAgo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SafetyIncidentID;
    /** @type {string} */
    SafetyIncidentUID;
    /** @type {?string} */
    BranchId;
    /** @type {?number} */
    ProjectID;
    /** @type {string} */
    IncidentNo;
    /** @type {string} */
    IncidentType;
    /** @type {string} */
    Severity;
    /** @type {string} */
    Status;
    /** @type {string} */
    Title;
    /** @type {string} */
    Location;
    /** @type {string} */
    CrewLabel;
    /** @type {string} */
    Description;
    /** @type {string} */
    ReportedBy;
    /** @type {boolean} */
    IsRecordable;
    /** @type {?string} */
    OccurredAt;
    /** @type {?string} */
    ClosedAt;
    /** @type {string} */
    SourceRef;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {number} */
    DaysAgo;
}
export class SafetyIncidentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Incident?:SafetyIncident}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SafetyIncident} */
    Incident;
}
export class SafetyIncidentCreateRequest {
    /** @param {{IncidentType?:string,Severity?:string,Title?:string,Location?:string,CrewLabel?:string,Description?:string,ReportedBy?:string,IsRecordable?:boolean,OccurredAt?:string,ProjectID?:number,SourceRef?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    IncidentType;
    /** @type {string} */
    Severity;
    /** @type {string} */
    Title;
    /** @type {string} */
    Location;
    /** @type {string} */
    CrewLabel;
    /** @type {string} */
    Description;
    /** @type {string} */
    ReportedBy;
    /** @type {boolean} */
    IsRecordable;
    /** @type {?string} */
    OccurredAt;
    /** @type {?number} */
    ProjectID;
    /** @type {string} */
    SourceRef;
}

JavaScript SafetyIncidentCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/safety/incidents HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SafetyIncidentCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CrewLabel>String</CrewLabel>
  <Description>String</Description>
  <IncidentType>String</IncidentType>
  <IsRecordable>false</IsRecordable>
  <Location>String</Location>
  <OccurredAt>0001-01-01T00:00:00</OccurredAt>
  <ProjectID>0</ProjectID>
  <ReportedBy>String</ReportedBy>
  <Severity>String</Severity>
  <SourceRef>String</SourceRef>
  <Title>String</Title>
</SafetyIncidentCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SafetyIncidentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Incident>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <ClosedAt>0001-01-01T00:00:00</ClosedAt>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <CrewLabel>String</CrewLabel>
    <DaysAgo>0</DaysAgo>
    <Description>String</Description>
    <IncidentNo>String</IncidentNo>
    <IncidentType>String</IncidentType>
    <IsRecordable>false</IsRecordable>
    <Location>String</Location>
    <OccurredAt>0001-01-01T00:00:00</OccurredAt>
    <ProjectID>0</ProjectID>
    <ReportedBy>String</ReportedBy>
    <SafetyIncidentID>0</SafetyIncidentID>
    <SafetyIncidentUID>00000000-0000-0000-0000-000000000000</SafetyIncidentUID>
    <Severity>String</Severity>
    <SourceRef>String</SourceRef>
    <Status>String</Status>
    <Title>String</Title>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </Incident>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SafetyIncidentResponse>