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

Submit trouble ticket (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)

Submit trouble ticket (V1)

  • 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 Smart Hands Order 

  • Mandatory permissionSmart 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 Connect Order

Order cross connects (V2) 

  • Mandatory permissionCross Connect & Intra-Facility Cables ordering permission

Order multiple cross connects (V1)

  • Mandatory permissionCross Connect & Intra-Facility Cables ordering permission

Order single, standard cross connect (V1)

  • Mandatory permissionCross Connect & Intra-Facility Cables ordering permission

 

Schedule On-Site Services

Schedule work visit (V2)

  • Mandatory permission: Work Visit request permission

Schedule work visit (V1)

  • Mandatory permission: Work Visit request permission

 

Schedule Shipments

Schedule inbound or outbound shipment (V2) 

  • Mandatory permission: Shipments ordering permission

Schedule inbound or outbound shipment (V1) 

  • Mandatory permission: Shipments ordering permission

 

Retrieve Order History (V1)

  • Mandatory permission: Any ordering permission

 

Asset Inventory Overview

Retrieve Assets (V1)

  • Mandatory permissionView Install Base permission

 

Report Management

Install Base Report (V1)

  • Mandatory permissionView Install Base permission 

 

Billing

Download Invoice Document (V1)

  • Mandatory permissionBilling & Payments permission

 

Reseller Customer Management

Create New Customer Account (V2)

  • Mandatory permission: Reseller Master Administrator role

 

User Management

Create New User (V2)

  • Mandatory permission: User Management permission

Terminate User (V2)

  • Mandatory permission: User Management permission