AbodeONE

<back to all web services

CreateIncident

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/incidents
CreateIncident Parameters:
NameParameterData TypeRequiredDescription
IncidentTypeIdbodyintNo
BuildingIdbodyintNo
ReportedDtbodyDateTimeNo
OccuredDtbodyDateTimeNo
IncidentTitlebodystringNo
DetailsbodystringNo
LocationbodystringNo
InterventionbodystringNo
FollowupbodystringNo
ReporterbodystringNo
ReportedTobodystringNo
RASignedbodystringNo
CreateIncidentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformIncidentDTONo
ResponseStatusformResponseStatusNo
IncidentDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
IncidentTypeIdformintNo
BuildingIdformintNo
ReportedDtformDateTimeNo
OccuredDtformDateTimeNo
IncidentTitleformstringNo
DetailsformstringNo
LocationformstringNo
InterventionformstringNo
FollowupformstringNo
ReporterformstringNo
ReportedToformstringNo
RASignedformstringNo
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo

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 //incidents HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateIncident xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel.Incidents">
  <BuildingId>0</BuildingId>
  <Details>String</Details>
  <Followup>String</Followup>
  <IncidentTitle>String</IncidentTitle>
  <IncidentTypeId>0</IncidentTypeId>
  <Intervention>String</Intervention>
  <Location>String</Location>
  <OccuredDt>0001-01-01T00:00:00</OccuredDt>
  <RASigned>String</RASigned>
  <ReportedDt>0001-01-01T00:00:00</ReportedDt>
  <ReportedTo>String</ReportedTo>
  <Reporter>String</Reporter>
</CreateIncident>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateIncidentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel.Incidents">
  <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>
  <Result>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</CreatedBy>
    <CreatedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</CreatedDt>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</ModifiedBy>
    <ModifiedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</ModifiedDt>
    <BuildingId>0</BuildingId>
    <Details>String</Details>
    <Followup>String</Followup>
    <Id>0</Id>
    <IncidentTitle>String</IncidentTitle>
    <IncidentTypeId>0</IncidentTypeId>
    <Intervention>String</Intervention>
    <Location>String</Location>
    <OccuredDt>0001-01-01T00:00:00</OccuredDt>
    <RASigned>String</RASigned>
    <ReportedDt>0001-01-01T00:00:00</ReportedDt>
    <ReportedTo>String</ReportedTo>
    <Reporter>String</Reporter>
  </Result>
</CreateIncidentResponse>