Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Deletion
Sites

Delete Site

Unlike Credential and File deletions, Site deletion does not delete any related entities, but it does remove references to the deleted Site on those related entities. For example, Meters assigned to the site will be unassigned when the Site is deleted. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call this endpoint.

This endpoint supports Sandbox Mode.

delete/plug/sites/{siteId}

Path parameters

siteIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

accountCountinteger required

The number of accounts. Note: if this is 0, but the entity being deleted has associated accounts, those accounts will be unlinked from the deleted entity but remain in the system. This is because the accounts are associated with another file or credential that is not being deleted.

createdAtstring date-time required

A timestamp indicating when the entity was created.

createdBystring nullable required

User or system responsible for creating the entity.

deletionTargetIdstring required

The ID of the primary resource being deleted. May belong to an Account, Credential, File or Site.

fileCountinteger required

The total number of files that are requested to be deleted.

idstring required

A unique identifier for the entity.

meterCountinteger required

The total number of meters associated with the account.

siteCountinteger required

The total number of Sites.

statementCountinteger required

The total number of statements.

status'REQUESTED' | 'SCHEDULED' | 'SUCCESS' | 'FAILURE' required

Status of the resource.