API docs by Redocly

Alliance Ground Faults (v2 (New))

Download OpenAPI specification:

API for External Grid Companies

ExternalGridGroundFaults

Validate if the server is alive or your authorization is working correctly

Authorizations:
Bearer
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Responses

Search ground faults

It will explicitly return ground faults only of the tenant by the specified GLN number

Authorizations:
Bearer
query Parameters
q
string
Default: ""
status
Array of strings (EGroundFaultStatus)
Default: "Open"
Items Enum: "Open" "Assigned" "Fixed" "Closed" "Canceled"
deadlinePassed
boolean
Default: false
from
string <date>
to
string <date>
page
integer <int32> [ -1 .. 2147483647 ]
Default: 0
itemsPerPage
integer <int32> [ 1 .. 1000 ]
Default: 15
sortBy
string
Default: "Id"
direction
string
Default: "desc"
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Responses

Response samples

Content type
No sample

Get ground fault by its id

Authorizations:
Bearer
path Parameters
id
required
string
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Responses

Response samples

Content type
No sample

Create a ground fault

Alongside creating a ground fault it will also generate the information PDF which will be sent to the customers

Note: emails to customers are not sent in DEV env

Authorizations:
Bearer
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Request Body schema:
meteringPointId
string
deadline
string <date>
description
string or null

Responses

Request samples

Content type
{
  • "meteringPointId": "string",
  • "deadline": "2019-08-24",
  • "description": "string"
}

Response samples

Content type
No sample

Close a ground fault

Will close an open ground fault, can be specified if closing PDF should be generated and sent to the customer of the plant Note: emails to customers are not sent in DEV env

Authorizations:
Bearer
path Parameters
id
required
string
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Request Body schema:
sendLetter
boolean

Responses

Request samples

Content type
{
  • "sendLetter": true
}

Annul a ground fault

Will annul a open ground fault, no documents are generated and no emails are sent

Authorizations:
Bearer
path Parameters
id
required
string
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Responses

Upload other attachments to a ground fault

Authorizations:
Bearer
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Request Body schema: multipart/form-data
files
Array of strings <binary> [ items <binary > ]
groundFaultId
string

Responses

Response samples

Content type
No sample

Send an overdue notice to a ground fault

An overdue PDF will be generated and sent to the customer. Note: emails to customers are not sent in DEV env

Authorizations:
Bearer
header Parameters
X-GLN-Number
required
string
Example: 708000..

GLN Number required for Alliance tenants resolution

Request Body schema:
id
required
string
newDeadline
required
string <date>

Responses

Request samples

Content type
{
  • "id": "string",
  • "newDeadline": "2019-08-24"
}