Interface Lookups

All Known Implementing Classes:

LookupsImpl

public interface Lookups

Client interface for colocation reference-data lookups in the Equinix Customer Portal.

Backed by the Colocation v2 lookup APIs under /colocations/v2. Provides the locations, patch panels, providers and connection services required when building cross-connect and other colocation orders.

Method Summary

Modifier and Type	Method	Description
PatchPanel	getPatchPanelById(String patchPanelId)	Retrieves the details of a patch panel by id.
List<? extends ConnectionService>	listConnectionServices(String ibx)	Lists the connection services available at an IBX.
List<? extends LookupLocation>	listLocations(String permissionCode)	Lists the locations the current user may order at, for the given permission code.
List<? extends LookupLocation>	listLocations(String permissionCode, List<String> ibxs, String providerAccountNumber, String aSideIbx, String connectionService, Boolean details)	Lists the locations the current user may order at, for the given permission code, with optional filters.
List<? extends PatchPanel>	listPatchPanels(String cabinetId)	Lists the patch panels in the given cabinet.
List<? extends Provider>	listProviders(String cageId, String accountNumber)	Lists the cross-connect providers available for a cabinet and account.

Method Details

listLocations

List<? extends LookupLocation> listLocations(String permissionCode)

Lists the locations the current user may order at, for the given permission code.

Maps to GET /colocations/v2/locations (Get Locations by permission code).

Parameters:

permissionCode - the permission code (CROSS_CONNECT, WORK_VISIT or SHIPMENTS)

Returns:

the list of permitted locations

listLocations

List<? extends LookupLocation> listLocations(String permissionCode,
 List<String> ibxs,
 String providerAccountNumber,
 String aSideIbx,
 String connectionService,
 Boolean details)

Lists the locations the current user may order at, for the given permission code, with optional filters.

Maps to GET /colocations/v2/locations (Get Locations by permission code). The providerAccountNumber, aSideIbx and connectionService filters apply only when permissionCode is CROSS_CONNECT.

Parameters:

permissionCode - the permission code (CROSS_CONNECT, WORK_VISIT or SHIPMENTS)

ibxs - the IBX codes to filter by, or null

providerAccountNumber - the service provider's (Z-side) account number, or null

aSideIbx - the A-side IBX used to fetch Z-side details, or null

connectionService - the connection service type used to fetch Z-side details, or null

details - when true, returns cage, cabinet and account details, or null for the default

Returns:

the list of permitted locations

listPatchPanels

List<? extends PatchPanel> listPatchPanels(String cabinetId)

Lists the patch panels in the given cabinet.

Maps to GET /colocations/v2/patchPanels (Retrieve all patch panels).

Parameters:

cabinetId - the cabinet id (required)

Returns:

the list of patch panels

getPatchPanelById

PatchPanel getPatchPanelById(String patchPanelId)

Retrieves the details of a patch panel by id.

Maps to GET /colocations/v2/patchPanels/{patchPanelId} (Retrieve patch panel details).

Parameters:

patchPanelId - the patch panel id

Returns:

the patch panel details

listProviders

List<? extends Provider> listProviders(String cageId,
 String accountNumber)

Lists the cross-connect providers available for a cabinet and account.

Maps to GET /colocations/v2/providers (Retrieve list of providers).

Parameters:

cageId - the cage id (required)

accountNumber - the account number (required)

Returns:

the list of providers

listConnectionServices

List<? extends ConnectionService> listConnectionServices(String ibx)

Lists the connection services available at an IBX.

Maps to GET /colocations/v2/connectionServices (Retrieve list of connection services).

Parameters:

ibx - the IBX code (required)

Returns:

the list of connection services