POST api/WLR3/Fault

This method reports a line fault to Openreach. Before using this method, you will need to use the POST-api-WLR3-Appointmentand POST-api-WLR3-LineTest methods to get the required information to POST a fault

Notes:

Before POSTING a fault, chose an SQC from using method GET api/LineDetails
Sample calls is mandatory only if SQC selected is FNT,NU,CO,NSY,OWT,PET,WNO and is valid only for ISDN30 e or ISDN30 Dass line types. Then SampleCallData(date and time field),Affected CLI and DialledNumber are mandatory. Affected CLI and Dialled number should be a maximum 16 characters.
Feature in Mandatory only if SQC selected is ESF or CSS and the CLI has features associated with them
Timeband can be 0,1,2,3,4 by default it's 0.
- Band 0 -No authorisation
- Band 1 - Up to 2 hours
- Band 2 - Up to 4 hours
- Band 3 - Up to 6 hours
- Band 4 - unlimited
PIN is mandatory only if the feature selected is associated with PIN number. PIN is a 4 digit numeric value.
DownTime is mandatory for ISDN30 e and ISDn30 dass line types.
Access Availability is mandatory if service maintenance is 2,2.5,3,4 and AccessFrom and AccessTo is provided
Appointment Key is required when line test failed, fault location is customer apparatus and the service maintenance level is less than 3
Incident Type Id chosen, decides if a particular IncidentSymptomID and IncidentCategoryID is permissible or not. You can choose only those which belong to that particular Incident Type
IncidentTypeID, IncidentSymptomID, OwnerID, Summary are mandatory fields.

Request Information

URI Parameters

None.

Body Parameters

FaultPOSTForm

Name	Description	Type	Additional information
OwnerId		integer	Required
CLI	The CLI the fault report is for	string	Required
SiteContactID	The ID of the Site contact	integer	Required
ContactEmail	The email address of the Incident Owner	string	None.
ContactName	The name of the Incident Owner	string	None.
ContactTelephone	The telephone number of the Incident Owner	string	None.
ContactCompanyName		string	None.
IncidentTypeId	The Incident Type ID. This specifies the type of the incident this fault is	integer	Required
IncidentSymptomId	The incident symptom ID. This indicates the fault symptoms	integer	Required
IncidentCategoryId	The incident category the fault falls under	integer	None.
Summary	A summary of the incident	string	Required
IncidentPriority	The priority level of the incident	integer	None.
SQC	The SQC received from the line test	string	Required
SampleCallData	Any sample call data to provided as evidence for the fault	Collection of SampleCalls	None.
Lines	The affected lines	integer	None.
DownTime	The total time the line has been down	string	None.
AccessAvailability	The total time the site can be accessed	string	None.
Intermitent	Indicates that the fault is a malfunction that occurs at certain intervals, regular or irregular	boolean	None.
Feature	The network feature ID	string	None.
PIN	A PIN code for a Network Feature (if required)	string	Matching regular expression pattern: ^([0-9]{4})$
OpenReachReference	The openreach reference	string	None.
NoTestReasonCode	A reason if no test was performed	string	None.
Timeband	Denotes the amount of time required for work on the fault. The higher the band the higher the cost incurred	integer	Required Range: inclusive between 0 and 4
CareLevel	The care level ID	string	None.
ReservationKey	The appointment reference	string	None.
AppointmentDate	The date of the appointment	date	None.
AppointmentSlot	Indicates the appointment slot	Wlr3AppointmentTimeSlot	None.
AccessDetails	Any useful notes on how to access the site	string	None.
HazardNotes	Any hazard notes related to the site	string	None.
AccessFrom	If the site is not 24 hours, the time the site can be accessed from	date	None.
AccessTo	If the site is not 24 hours, the time the site can be accessed to	date	None.
TempCallRoute	Specify an temporary call route. Select None(0) Divert to number (1) or Busy out line(2)	CallRoutingOptions	None.
DivertToNumber	The number to divert calls to	string	None.
SuspendCPS	Specify whether CPS is to be suspended	boolean	None.
LineTestResult	The result for the Line Test is performed	Wlr3TestOutcome	None.

Request Formats

application/json, text/json

Sample:

{
  "OwnerId": 1,
  "CLI": "sample string 2",
  "SiteContactID": 3,
  "ContactEmail": "sample string 4",
  "ContactName": "sample string 5",
  "ContactTelephone": "sample string 6",
  "ContactCompanyName": "sample string 7",
  "IncidentTypeId": 8,
  "IncidentSymptomId": 9,
  "IncidentCategoryId": 1,
  "Summary": "sample string 10",
  "IncidentPriority": 1,
  "SQC": "sample string 11",
  "SampleCallData": [
    {
      "ToCLI": "sample string 1",
      "FromCLI": "sample string 2",
      "CallDateTime": "2025-04-25T14:12:47.765"
    },
    {
      "ToCLI": "sample string 1",
      "FromCLI": "sample string 2",
      "CallDateTime": "2025-04-25T14:12:47.765"
    }
  ],
  "Lines": 12,
  "DownTime": "sample string 13",
  "AccessAvailability": "sample string 14",
  "Intermitent": true,
  "Feature": "sample string 16",
  "PIN": "sample string 17",
  "OpenReachReference": "sample string 18",
  "NoTestReasonCode": "sample string 19",
  "Timeband": 20,
  "CareLevel": "sample string 21",
  "ReservationKey": "sample string 22",
  "AppointmentDate": "2025-04-25T14:12:47.765",
  "AppointmentSlot": 0,
  "AccessDetails": "sample string 23",
  "HazardNotes": "sample string 24",
  "AccessFrom": "2025-04-25T14:12:47.765",
  "AccessTo": "2025-04-25T14:12:47.765",
  "TempCallRoute": 0,
  "DivertToNumber": "sample string 25",
  "SuspendCPS": true,
  "LineTestResult": 0
}

application/xml, text/xml

Sample:

<FaultPOSTForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <AccessAvailability>sample string 14</AccessAvailability>
  <AccessDetails>sample string 23</AccessDetails>
  <AccessFrom>2025-04-25T14:12:47.765</AccessFrom>
  <AccessTo>2025-04-25T14:12:47.765</AccessTo>
  <AppointmentDate>2025-04-25T14:12:47.765</AppointmentDate>
  <AppointmentSlot>Wlr3AppointmentTimeslotAM</AppointmentSlot>
  <CLI>sample string 2</CLI>
  <CareLevel>sample string 21</CareLevel>
  <ContactCompanyName>sample string 7</ContactCompanyName>
  <ContactEmail>sample string 4</ContactEmail>
  <ContactName>sample string 5</ContactName>
  <ContactTelephone>sample string 6</ContactTelephone>
  <DivertToNumber>sample string 25</DivertToNumber>
  <DownTime>sample string 13</DownTime>
  <Feature>sample string 16</Feature>
  <HazardNotes>sample string 24</HazardNotes>
  <IncidentCategoryId>1</IncidentCategoryId>
  <IncidentPriority>1</IncidentPriority>
  <IncidentSymptomId>9</IncidentSymptomId>
  <IncidentTypeId>8</IncidentTypeId>
  <Intermitent>true</Intermitent>
  <LineTestResult>Wlr3TestUnknown</LineTestResult>
  <Lines>12</Lines>
  <NoTestReasonCode>sample string 19</NoTestReasonCode>
  <OpenReachReference>sample string 18</OpenReachReference>
  <OwnerId>1</OwnerId>
  <PIN>sample string 17</PIN>
  <ReservationKey>sample string 22</ReservationKey>
  <SQC>sample string 11</SQC>
  <SampleCallData>
    <SampleCalls>
      <CallDateTime>2025-04-25T14:12:47.765</CallDateTime>
      <FromCLI>sample string 2</FromCLI>
      <ToCLI>sample string 1</ToCLI>
    </SampleCalls>
    <SampleCalls>
      <CallDateTime>2025-04-25T14:12:47.765</CallDateTime>
      <FromCLI>sample string 2</FromCLI>
      <ToCLI>sample string 1</ToCLI>
    </SampleCalls>
  </SampleCallData>
  <SiteContactID>3</SiteContactID>
  <Summary>sample string 10</Summary>
  <SuspendCPS>true</SuspendCPS>
  <TempCallRoute>None</TempCallRoute>
  <Timeband>20</Timeband>
</FaultPOSTForm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FaultPOSTResponse

Name	Description	Type	Additional information
IncidentID	ID of new incident	integer	None.
Message		string	None.

Response Formats

application/json, text/json

Sample:

{
  "IncidentID": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<FaultPOSTResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <IncidentID>1</IncidentID>
  <Message>sample string 2</Message>
</FaultPOSTResponse>

URI parameters

Headers | Add header

Body

Status

Headers

Body

Developers Portal

POST api/WLR3/Fault

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml