PATCH api/WLR3/Fault/{IncidentID}

Cancel, clear, or reject a fault. Only one code is accepted per request.

Error Messages
  • 400/BadRequest - Cannot specify more than one of the following at a time: CancelCode, ClearCode, RejectCode.
  • 400/BadRequest - One of the following actions must be specified: CancelCode, ClearCode, RejectCode.
  • 400/BadRequest - The provided ClearCode was not valid.
  • 400/BadRequest - The provided RejectCode was not valid.
  • 400/BadRequest - The specified CancelCode is invalid.
  • 400/BadRequest - This cannot be cancelled.
  • 400/BadRequest - This Fault cannot be cleared unless it's pending a response.
  • 400/BadRequest - This Fault cannot be rejected unless it's pending a response.
  • 404/NotFound - Incident not found.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncidentID The unique identifier of the fault to PATCH. integer

Required

Body Parameters

FaultPatch
NameDescriptionTypeAdditional information
CancelCode Cancel the specified fault. string

None.
ClearCode Clear the specified fault. string

None.
RejectCode Reject the specified fault. string

None.
Notes A plain English description of the change. string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CancelCode": "sample string 1",
  "ClearCode": "sample string 2",
  "RejectCode": "sample string 3",
  "Notes": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AvailableAppointmentResponse
NameDescriptionTypeAdditional information
Date The date of the appointment string

None.
Time The time of the appointment string

None.
Slot The appointment slot (i.e. AM slot, PM slot or Timeslot2) Wlr3AppointmentTimeSlot

None.
IsPremium Indicates that this is a premium booked appointment and will incur additional charges boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Date": "sample string 1",
  "Time": "sample string 2",
  "Slot": 0,
  "IsPremium": true
}

application/xml, text/xml

Sample: 
<AvailableAppointmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <Date>sample string 1</Date>
  <IsPremium>true</IsPremium>
  <Slot>Wlr3AppointmentTimeslotAM</Slot>
  <Time>sample string 2</Time>
</AvailableAppointmentResponse>