Planned Works & Change Management API

The Planned Works API enables Colt to send Customers details of any planned works that impact your services: date and time of works, outage duration, and impacted circuits. Scheduled works, Updates, Reschedules, cancellations, completion (successful/ unsuccessful ) etc. are part of this service.

Note: API specification details and the try-out option are not available for this API at the moment as this API is unidirectional from the Colt system to the customer system.

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

How to use this API

Click below to download the API user guide.

Download User Guide
 

Not a customer yet?

Contact our Sales Team  

MEF APIs

Ondemand supports the MEF Sonata API specification used by carriers for inter-network connectivity. It enables customers to directly integrate with the Colt On Demand platform and place orders for Ethernet Virtual Private Line services from their own BSS/OSS platforms. 

Supported MEF features

We have implemented Billie version   of MEF Sonata API. Below features are supported by our API implementation.

Address Validation

  • Search On net and nearnet buildings providing Fielded address

  • Site availability check in a building

  • Details of building and site by providing identifiers

Product offering Qualification

  • Feature that helps customer to validate availability of product for supplied bandwidth and location details

Quote

  • Receive instant and defferred quotes for the product offering

Order

  • Place an order for new connection  (ethernet e-line only at the moment)

  • Ability to cease existing connection

  • Ability to upgrade bandwidth of an existing connection

Notification support

  • Order

  • Quote

Note: Click here  to see the Billie SDK documentation

 

How to get access to this API?

If you are a Colt customer then please contact your Account Executive.

 

What is the onboarding process?

Your Account Executive will request the logins for the sandbox account. AE will share the details with you.

The sandbox environment has production like features and you are free to test any use case using the APIs. Our devops team will support you during this period.

Once you are ready with API development and want to move to production , the Account executive has to raise separate registration request that creates Colt online logins and On demand platform credentials. We will then also create MEF production credential and set up NNIs which are essential for MEF API.

How to use the API via postman?

Step1. Add the X-MEF-SIG and X-MEF-APPID in headers and send a POST request to geographicAddressValidation API

Sample request and response will look as shown in the screenshot below

Step 2.  Add the X-MEF-SIG and X-MEF-APPID in headers and send a POST request to productOfferingQualification API. You will need an ENNI id which we will create for you and an Address id which is retrieved from Step 1.

The request/response will look as shown in screenshot below. We will provide you sample payload

Step 3.  Add the X-MEF-SIG and X-MEF-APPID in headers and send a POST request to quote API. You will need an ENNI id, the Address id and POQ Id which is retrieved from Step 2.

The request/response will look as shown in screenshot below. We will provide you sample payloads.

Step 4.  Add the X-MEF-SIG and X-MEF-APPID in headers and send a POST request to order API. You will need an ENNI id, the Address id and POQ Id and the Quote Id which is retrieved from Step 3.

The request/response will look as shown in screenshot below. We will provide you sample payloads.

You can use the support option available in On-demand portal   for post-production support.

Not a customer yet?

Contact our Sales Team  

 

Subscribe to