Interface HierarchyNodeForAssetAPI

All Known Implementing Classes:

HierarchyNodeForAssetAPIJson

public interface HierarchyNodeForAssetAPI

The affected-customer-assets hierarchy (cage > cabinet > circuit) returned by the asset/tagpoint/affected-assets endpoint, wrapped in the payLoad/status envelope (HierarchyNodeForAssetAPI in the spec).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HierarchyNodeForAssetAPI.Payload	The payLoad of a HierarchyNodeForAssetAPI response.

Method Summary

Modifier and Type	Method	Description
HierarchyNodeForAssetAPI.Payload	getPayLoad()
Status	getStatus()

Method Details

getPayLoad

HierarchyNodeForAssetAPI.Payload getPayLoad()

Returns:

the affected-assets payload, or null when the response carried no data

getStatus

Status getStatus()

Returns:

the response status envelope