Endpoints Reference

This page lists every endpoint in the IZO™+ Multi Cloud Connect API, grouped by functional area. All paths are relative to the base URL https://api.tatacommunications.com/gnsapi/izomcc/v1 and require a bearer token. Path parameters appear in {braces}; query parameters are listed per endpoint.

How to read this reference

Base URL: https://api.tatacommunications.com/gnsapi/izomcc/v1
Authentication: Authorization: Bearer <token> on every call (see Authentication and Tokens).
Body format: JSON (Content-Type: application/json) for POST and PUT.
Parameters: Values shown in {braces} are path parameters. Query parameters are named in the table. Request and response payloads are illustrated end-to-end in Request and Response Examples.

Geographic Address Management

Validates and resolves geographic and data-centre context.

Method	Endpoint	Purpose	Required parameters
POST	/geo	Validate the location and entity; returns an addressValidationId and the eligible data-centre cities.	Body: product, legalEntityId, emailId, dataCenterLocation

Product Offering Qualification Management

Submit, update, and delete the solution specification.

Method	Endpoint	Purpose	Required parameters
POST	/productOfferingQualification	Submit a solution (access ports, cloud connections, TCR) for feasibility and pricing; returns a quoteCode and per-component status.	Body: addressValidationId, product, solution
PUT	/productOfferingQualification/ {quoteCode}	Update the qualified components for an existing quote.	Path: quoteCode; Body: solution specification
POST	/productOfferingQualification/ delete	Delete one or more component rows (access port, cloud, TCR) from a quote.	Body: quoteCode plus the UUID lists to remove

Quote Management

Retrieve, update, validate, check out, and download a quote.

Method	Endpoint	Purpose	Required parameters
GET	/quote/{quoteCode}	Retrieve full quote details, including commercial and technical attributes and per-component validation status.	Path: quoteCode
PUT	/quote/{quoteCode}	Update quote-level metadata (solution name, service model, contract term, legal entity).	Path: quoteCode; Body: quote metadata
GET	/quote/download	Return quote-document metadata and a download URL when ready.	Query: quoteCode
GET	/quote/checkout	Perform or initiate the checkout step for a quote.	Query: quoteCode
GET	/quote/validationStatus	Return the validation status of a single component within a quote.	Query: quoteCode, componentUuid

Inventory & Product Catalog Management

Reference and catalogue helpers.

Method	Endpoint	Purpose	Required parameters
GET	/inventory/dataCenterLocation	List eligible data centres for the selected service model.	Query: mccFlavour (optional: locationCity, accessType)
GET	/inventory/fabricPort	Return access-port details for a quote component.	Query: quoteCode, fpUuid
GET	/inventory/tcr	Return TCR component details for a quote component.	Query: quoteCode, tcrUuid
GET	/inventory/cloudConnections	Return cloud-connection (VC) details for a quote component.	Query: quoteCode, cloudUuid
GET	/inventory/gvpnServiceInventory	Return underlay GVPN service-inventory rows for an entity.	Query: legalEntityId (optional: vpnTopology, lagType)
GET	/inventory/components	Return catalogue picklists: regions, cloud providers, service model, access types, component types, contract terms.	None
GET	/inventory/catalog	Return catalogue metadata for a service model.	Query: mccFlavour, isDemo

Ordering Management

Contracting, billing, credit, order placement, and ordered-service inventory.

Method	Endpoint	Purpose	Required parameters
GET	/order/getContractDetails	Return contracting and legal-entity details (billing and contracting addresses).	Query: legalEntityId
POST	/order/createUpdateBilling	Create or update a billing / legal-entity contact.	Query: contactType (le/billing), operationType (create/modify); Body: contact details
POST	/order/postContractingDetails	Persist contracting selections: currency, billing profile, contact, PO.	Body: quote, product, entity, currency, billing/contact ids, PO date
GET	/order/getCreditStatus	Return the credit decision, prepayment status, approval expiry, and remarks.	Query: quoteRefId
POST	/order/placeOrder	Place the order for a quote; returns an orderCode and a time-limited COF URL.	Body: quoteCode
GET	/order/getCOFDownload	Return Customer Order Form (COF) metadata and a pre-signed download URL.	Query: quoteRefId
GET	/order/getServiceInventory	Return ordered solutions with access-port, cloud-connection, and edge line inventory.	Query: legalEntityId

MACD Management

Move, Add, Change, Delete against live services.

Method	Endpoint	Purpose	Required parameters
POST	/macd/createMacdQuote	Start a MACD change quote from a live service id; returns a macdQuoteCode.	Body: solutionServiceId
PUT	/macd/updateFabricPort/ {macdQuoteCode}/{fpUuid}	Apply a bandwidth change to an access-port line on a MACD quote.	Path: macdQuoteCode, fpUuid; Body: change details
PUT	/macd/updateCloudConnection/ {macdQuoteCode}/{cloudUuid}	Apply a bandwidth change to a cloud connection on a MACD quote.	Path: macdQuoteCode, cloudUuid; Body: change details
POST	/macd/termination	Submit a termination request for a live service; returns a termination quoteCode.	Body: solutionServiceId

Response model and status codes

Every endpoint returns one of these statuses:

Status	Meaning	Body
200	Success	The endpoint-specific result object.
400	Bad request: missing or invalid field/parameter.	{ reason, message, referenceError, code }
401	Unauthorised: token missing, invalid, or expired.	{ faultcode, faultstring }
500	Internal error.	{ reason, message, referenceError, code }

Many success responses wrap their payload in an envelope carrying a status (for example SUCCESS), a message, and a data object; component-level results additionally carry a per-component status, message, and validationStatus. Always check the component-level validationStatus after qualification: a quote can be created while individual components are still validating or have failed. The full error model is covered in API Errors and Codes.