Skip to main content
Index

How to Guide

Learn how to perform a variety of functions using ECP APIs!

 

 

To use these APIs, the user must have the required permissions for the specific IBX locations. If you are unaware of your user permissions, contact your Master Administrator. 

 

Order Management

 

Create Trouble Ticket Order (V2 Beta)

  • Mandatory permission: Trouble Ticket ordering permission
    • Additional permission that may be required: View Install Base permission (to retrieve asset reference identifiers for your trouble ticket)

 

Create Trouble Ticket Order (V1) 

  • Mandatory permission: Trouble Ticket ordering permission
    • Additional permission that may be required: View Install Base permission (if you want to include an asset ID number and need to retrieve it)

 

Create Smart Hands Order

  • Mandatory permission: Smart Hands ordering permission 
    • Additional permission that may be required: Work Visit ordering permission (if you need to schedule a Work Visit order for a Cage Access Escort Smart Hands order)
    • Additional permission that may be required: Shipments ordering permission (if you need to schedule an Inbound Shipping order for an Unpack Shipments or Locate Packages Smart Hands order)
    • Additional permission that may be required: View Install Base permission (if you need to retrieve the serial number of a cross connect for a Patch Cable Installation or Patch Cable Removal Smart Hands order)

 

Create Cross Connects Order (V2 Beta)

  • Mandatory permission: Cross Connect & Intra-Facility Cables ordering permission

 

Create Multiple Cross Connects Order (V1)

  • Mandatory permission: Cross Connect & Intra-Facility Cables ordering permission

 

Create Standard Cross Connect Order (V1)

  • Mandatory permission: Cross Connect & Intra-Facility Cables ordering permission

 

Schedule On-Site Services

Schedule work visit

  • Mandatory permission: Work Visit permission

 

Schedule Shipments

  • Mandatory permission: Shipments ordering permission

 

Retrieve Order History

  • Mandatory permission: Any ordering permission

 

Asset Inventory Overview

Retrieve Assets

  • Mandatory permission: View Install Base permission

 

Report Management

Install Base Report

  • Mandatory permission: View Install Base permission 

 

Billing

Download Invoice Document

  • Mandatory permission: Billing & Payments permission