POST api/incident

This method adds a new incident

Error messages
  • 400/BadRequest - An Incident cannot be saved without a status - Specify a Status ID
  • 400/BadRequest - An Incident cannot be saved without being able to determine the service level.
  • 400/BadRequest - An Incident cannot be saved without a symptom - Specify a Sympton ID
  • 400/BadRequest - An Incident cannot be saved without a site - Specify a Site ID
  • 400/BadRequest - An Incident cannot be saved for this site - User does not have permissions to log incidents for this site.
  • 400/BadRequest - Contact information must be provided, either as a ContactID, or manually specified using the ContactName and ContactPhone fields - Specify a ContactID or manually complete the required contact details
  • 400/BadRequest - Incidents are configured to require a priority - Specify the incident's priority
  • 400/BadRequest - Incidents are configured to require a category - Specify a category to which the incident belongs
  • 400/BadRequest - Incidents are configured to require an owner - Specify an owner of the incident
  • 400/BadRequest - The provided category is not compatible with this type of incident - Specify a category ID that is compatible with the specified incident ID. Use the GET-api-incident-categories method to find out which category IDs are compatible with what Incident Type IDs
  • 400/BadRequest - The specified symptom cannot be found - The specified symptom ID is not assigned to a symptom type
  • 400/BadRequest - The specified incident cannot be found - The specified Incident Type ID is not assigned to an incident type
  • 400/BadRequest - This method cannot create WLR3 incidents - Create an incident which is not a WLR3 incident
  • 404/NotFound - Priority note found.
  • 404/NotFound - Specified contact was not found. - Specified Contact ID is not assigned to a contact
  • 404/NotFound - Specified site was not found - Specified Site ID is not assigned to a site

Request Information

URI Parameters

None.

Body Parameters

IncidentPostRequest
NameDescriptionTypeAdditional information
IncidentTypeID A type descriptor for the incident integer

Required
SymptomID The kind of problems had integer

Required
OwnerID The ContactID of the owner. integer

None.
ContactID The ContactID of the customer. integer

None.
ContactName The name of the customer, if third-party. string

None.
ContactTelephone The phone number of the customer, if third-party. string

None.
ContactEmail The email of the customer, if third-party. string

None.
SiteID The ID of the site to add an incident for integer

Required
CLIs A list of incident CLIs, separated by commas or line-breaks Collection of string

Required
CategoryID A category descriptor for the incident integer

None.
Summary An overview of the incident string

None.
Notes Any miscellaneous notes regarding the incident string

None.
Priority The importance of the incident integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "IncidentTypeID": 1,
  "SymptomID": 2,
  "OwnerID": 1,
  "ContactID": 3,
  "ContactName": "sample string 4",
  "ContactTelephone": "sample string 5",
  "ContactEmail": "sample string 6",
  "SiteID": 7,
  "CLIs": [
    "sample string 1",
    "sample string 2"
  ],
  "CategoryID": 8,
  "Summary": "sample string 9",
  "Notes": "sample string 10",
  "Priority": 1
}

application/xml, text/xml

Sample: 
<IncidentPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <CLIs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CLIs>
  <CategoryID>8</CategoryID>
  <ContactEmail>sample string 6</ContactEmail>
  <ContactID>3</ContactID>
  <ContactName>sample string 4</ContactName>
  <ContactTelephone>sample string 5</ContactTelephone>
  <IncidentTypeID>1</IncidentTypeID>
  <Notes>sample string 10</Notes>
  <OwnerID>1</OwnerID>
  <Priority>1</Priority>
  <SiteID>7</SiteID>
  <Summary>sample string 9</Summary>
  <SymptomID>2</SymptomID>
</IncidentPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version Version

None.
Content HttpContent

None.
StatusCode HttpStatusCode

None.
ReasonPhrase string

None.
Headers Collection of Object

None.
RequestMessage HttpRequestMessage

None.
IsSuccessStatusCode boolean

None.