Skip to main content
Loading...

API docs by

This API is used to request a patch cable to be moved between devices.

Request

This API is used to request a patch cable to be moved between devices.

Headers
Authorizationstringrequired

Specify the Access token with prefix 'Bearer'.

Bodyapplication/json
customerReferenceNumberstring, [ 1 .. 50 ] characters(Customer Reference Number)

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

Example:"RSS41244"
purchaseOrderobject(Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

ibxLocationobject(IBX Location)required

IBX, Cage, Accounts and Cabinet information

contactsArray of objects, >= 3 items(Order Contacts Array)required

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Example:
[
  {
    "contactType": "ORDERING",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "NOTIFICATION",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "TECHNICAL",
    "name": "John Doe",
    "workPhone": "1111111",
    "workPhonePrefToCall": "ANYTIME",
    "mobilePhone": "1111111",
    "mobilePhonePrefToCall": "ANYTIME"
  }
]
scheduleobject(Schedule Info)required

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

attachmentsArray of objects, <= 5 items(Attachments Array)

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

serviceDetailsobjectrequired

Move Jumper Cable Service Details Object. Please fill out the Cable ID, Current Device (Name, Slot, Port) and New Device (Name, Slot, Port) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'currentDeviceDetails' and 'newDeviceDetails' objects are mandatory.

Payload
{
  "customerReferenceNumber": "RSS41244",
  "purchaseOrder": {
    "number": "123455",
    "purchaseOrderType": "EXISTING"
  },
  "ibxLocation": {
    "ibx": "AM1",
    "cages": [ … ]
  },
  "contacts": [
    { … },
    { … },
    { … }
  ],
  "schedule": {
    "scheduleType": "STANDARD",
    "requestedStartDate": "2017-04-05T12:00:00Z",
    "requestedCompletionDate": "2017-04-05T12:00:00Z"
  },
  "attachments": [
    { … }
  ],
  "serviceDetails": {
    "quantity": "1",
    "cableId": "A01-5-10",
    "currentDeviceDetails": { … },
    "newDeviceDetails": { … },
    "scopeOfWork": "Scope of work"
  }
}

Responses

Order has been submitted successfully

Response
No content
Was this page helpful?