🔧Create Fault Report

Use this endpoint to register a fault against a valid meter.

post

Header parameters

AuthorizationstringRequired

API token for user authentication

Example: {"value":"Token tk-abc-1234-xyz"}

Body

application/json

Following fields are mandatory

1. 'name'
2. 'address'
3. 'fault'
4. 'desc'

Valid options for fault are as below:

1. SeriousBoxDamage
2. FireWaterDamage
3. MeterDead
4. KeepsTripping
5. NoTrip
6. DisplayLightsButtons
7. IncorrectTI
8. IncorrectSGC
9. RecordMissing_NewInstallation
10. RecordMissing_MeterChangedOut
11. RecordMissing_ConvertedFrmConventional
12. NetworkFaultReport

When fault is != NetworkFaultReport -> one of below meter combinations must be provided:

1. 'meter_no'
2. 'meter_card'
3. ['meter_no', 'supply_group_code', 'key_rev_no', 'tariff_index', 'token_tech', 'algo_tech']

Optional parameters:

• 'contact_no'

addressstringOptionalExample: 123 Main St

algo_techstringOptionalExample: 29

contact_nostringOptionalExample: [phone]

descstringOptionalExample: The meter is not reading the correct consumption.

faultstringOptionalExample: RecordMissing_MeterChangedOut

key_rev_nostringOptionalExample: R2

meter_nostringOptionalExample: 12345678

namestringOptionalExample: John Doe

supply_group_codestringOptionalExample: S123

tariff_indexstringOptionalExample: T5

token_techstringOptionalExample: 98

Responses

200

Fault reported successfully

application/json

Responseall of

and

400

Invalid input

application/json

500

Failed to report fault

application/json

post

/api/v1/meter/report-fault

HTTPcURLJavaScriptPython

POST /api/v1/meter/report-fault HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "address": "123 Main St",
  "algo_tech": "29",
  "contact_no": "[phone]",
  "desc": "The meter is not reading the correct consumption.",
  "fault": "RecordMissing_MeterChangedOut",
  "key_rev_no": "R2",
  "meter_no": "12345678",
  "name": "John Doe",
  "supply_group_code": "S123",
  "tariff_index": "T5",
  "token_tech": "98"
}

{
  "id": "d9650f26-5037-4319-8c42-f27f36855855",
  "message": {
    "flow": "<flow_name>",
    "id_type": "5",
    "message_number": 183,
    "message_time": "20241116184733"
  },
  "address": "123 Main St",
  "client_id": "CLIENT123",
  "contact_no": "[phone]",
  "desc": "The meter is not reading the correct consumption.",
  "display_header": "Fault Report",
  "fault": "RecordMissing_MeterChangedOut",
  "name": "John Doe",
  "ref": "123456789",
  "resp_date_time": "2024-10-10T12:00:00",
  "terminal_id": "TERMINAL456"
}