Get the Zayo product catalog where products are represented as a productCode
. For each productCode
get the description and latest version.
Success
Bad Request
curl -i -X GET \ https://api.zayo.com/services/quote-management/v3/catalog/product-code \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "apiVersion": "v3",
- "data": {
- "productCodes": [
- {
- "productCode": "ETH-PDN-P2P",
- "version": "3.1.0",
- "description": "Ethernet connectivity across a completely private managed network operated by Zayo with dedicated fiber and dedicated equipment."
}, - {
- "productCode": "ETH-ELAN-M2M",
- "version": "3.1.0",
- "description": "A Carrier Ethernet, multipoint to multipoint configuration that allows communications across all locations. Allows for an aggregated commit across locations. Provides customers a simple WAN solution that is easier to maintain, support, and scale."
}, - {
- "productCode": "ETH-ELINE-P2P",
- "version": "3.3.0",
- "description": "Metro and Intercity Point to Point service configurations provide an Ethernet Layer 2 private line connection between two locations."
}, - {
- "productCode": "ETH-ELINE-NNI",
- "version": "3.2.0",
- "description": "Deliver full connectivity across your network by unifying multiple access points into a single aggregation point."
}, - {
- "productCode": "ETH-ELINE-UNI",
- "version": "3.3.0",
- "description": "Metro & Intercity Point-to-Multi-Point service provides a hub-and-spoke configuration where multiple locations (UNIs) are homed to a single hub or aggregation point (NNI) at a central location."
}, - {
- "productCode": "IP-VPN",
- "version": "3.3.0",
- "description": "IPVPN (Virtual Private Network using IP/MPLS backbone)."
}, - {
- "productCode": "IP-DIA",
- "version": "3.7.0",
- "description": "Zayo's high performance Dedicated Internet Access (DIA) service combines essential internet features with global internet reach and scalability for enterprises of all sizes."
}, - {
- "productCode": "IP-DIA-AGG",
- "version": "3.6.0",
- "description": "Zayo's high performance Aggregated Dedicated Internet Access (DIA) service combines essential internet features with global internet reach and scalability for enterprises of all sizes."
}, - {
- "productCode": "WAVES-STD-P2P",
- "version": "3.0.0",
- "description": "With Wavelength Point to Point solutions, feel confident with your bandwidth capacity. Zayo offers a range of flexible connectivity options that can be customized to meet your technical specifications. Connect between Tier 1-5 markets across North America."
}
]
}
}
After you get the latest semantic version from the product catalog route, plug the version and the product code into the product code details route to dynamically receive the latest quote request schema with required and optional attributes needed per product code/version combination. The response of this route is the guide to your quote request. The product code details response and quote request schema includes 3 major components - attrs
array, configuration
object, and preferences
object.
The attrs
array is where you can specify your existing quoteId
to make edits to your quote.
The configuration
object is where all of the product-specific attributes are returned. This schema will vary based on the product and version.
The preferences
object is where you can specific non-configuration attributes like notes and a unique Id like a corresponding quoteId from your system. This schema is the same for all products and versions.
Success
Bad Request
curl -i -X GET \ 'https://api.zayo.com/services/quote-management/v3/catalog/product-code-details/{productCode}/{version}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "apiVersion": "v3",
- "data": {
- "productCodeConfigurations": [
- {
- "attrs": [
- {
- "name": "quoteId",
- "displayName": "Quote Id",
- "description": "Unique API identifier to be used for subsequent routes.",
- "criteria": {
- "dataType": "string",
- "isRequired": false
}
}
], - "configuration": {
- "isRequired": true,
- "attrs": [
- {
- "name": "productCode",
- "displayName": "Product Code",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "ETH-ELINE-UNI"
}, - {
- "name": "version",
- "displayName": "Version",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "3.3.0"
}, - {
- "name": "nodeId",
- "displayName": "Node Id",
- "description": "36-character UUID",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "AAC758F0-F719-470D-B716-E8EC6804810F"
}, - {
- "name": "bandwidth",
- "displayName": "Bandwidth",
- "description": "Amount of data capacity for the service",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "options": [
- {
- "value": "10Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "20Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "30Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "40Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "50Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "60Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "70Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "80Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "90Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "100Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "150Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "200Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "250Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "300Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "400Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "500Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "600Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "700Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "800Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "900Mb",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "1G",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "2G",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "3G",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "5G",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}, - {
- "value": "10G",
- "defaultValue": false,
- "allowForControllingFields": [ ]
}
]
}, - {
- "name": "burstableService",
- "displayName": "Burstable Service",
- "description": "Ability for traffic to exceed the Comitted Information Rate (CIR) at a cost",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "Yes",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "No",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "qualityOfService",
- "displayName": "Quality of Service",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "Off",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}, - {
- "value": "Metro-On",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "mefCertified",
- "displayName": "MEF Certified",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "No",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}, - {
- "value": "Yes",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "currencyIsoCode",
- "displayName": "Currency ISO Code",
- "description": "Three letter ISO code for Currency",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "USD",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}, - {
- "value": "CAD",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "EUR",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "GDP",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "HKD",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "AUD",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "CHF",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "JPY",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "SGD",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "MXN",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "BRL",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "DKK",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "SEK",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "ZAR",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}
], - "children": [
- {
- "minCount": 1,
- "maxCount": 1,
- "attrs": [
- {
- "name": "productCode",
- "displayName": "Product Code",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "ETH-ELINE-UNI"
}, - {
- "name": "version",
- "displayName": "Version",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "3.3.0"
}, - {
- "name": "nodeId",
- "displayName": "Node Id",
- "description": "36-character UUID",
- "criteria": {
- "dataType": "String",
- "isRequired": true
}, - "value": "61DE1859-7A99-4218-B43E-F96CD57303A0"
}, - {
- "name": "portHandoffSpeed",
- "displayName": "Port Handoff Speed",
- "description": "GigE - Supports up to 1G, 10GigE - Supports up to 10G, 100GigE - Supports up to 100G",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "10/100/1000BaseT",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "bandwidth",
- "values": [
- {
- "value": "10Mb",
- "defaultValue": false
}, - {
- "value": "20Mb",
- "defaultValue": false
}, - {
- "value": "30Mb",
- "defaultValue": false
}, - {
- "value": "40Mb",
- "defaultValue": false
}, - {
- "value": "50Mb",
- "defaultValue": false
}, - {
- "value": "60Mb",
- "defaultValue": false
}, - {
- "value": "70Mb",
- "defaultValue": false
}, - {
- "value": "80Mb",
- "defaultValue": false
}, - {
- "value": "90Mb",
- "defaultValue": false
}, - {
- "value": "100Mb",
- "defaultValue": false
}, - {
- "value": "150Mb",
- "defaultValue": false
}, - {
- "value": "200Mb",
- "defaultValue": false
}, - {
- "value": "250Mb",
- "defaultValue": false
}, - {
- "value": "300Mb",
- "defaultValue": false
}, - {
- "value": "400Mb",
- "defaultValue": false
}, - {
- "value": "500Mb",
- "defaultValue": false
}, - {
- "value": "600Mb",
- "defaultValue": false
}, - {
- "value": "700Mb",
- "defaultValue": false
}, - {
- "value": "800Mb",
- "defaultValue": false
}, - {
- "value": "900Mb",
- "defaultValue": false
}, - {
- "value": "1G",
- "defaultValue": false
}
]
}
]
}, - {
- "value": "GigE",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "bandwidth",
- "values": [
- {
- "value": "10Mb",
- "defaultValue": false
}, - {
- "value": "20Mb",
- "defaultValue": false
}, - {
- "value": "30Mb",
- "defaultValue": false
}, - {
- "value": "40Mb",
- "defaultValue": false
}, - {
- "value": "50Mb",
- "defaultValue": false
}, - {
- "value": "60Mb",
- "defaultValue": false
}, - {
- "value": "70Mb",
- "defaultValue": false
}, - {
- "value": "80Mb",
- "defaultValue": false
}, - {
- "value": "90Mb",
- "defaultValue": false
}, - {
- "value": "100Mb",
- "defaultValue": false
}, - {
- "value": "150Mb",
- "defaultValue": false
}, - {
- "value": "200Mb",
- "defaultValue": false
}, - {
- "value": "250Mb",
- "defaultValue": false
}, - {
- "value": "300Mb",
- "defaultValue": false
}, - {
- "value": "400Mb",
- "defaultValue": false
}, - {
- "value": "500Mb",
- "defaultValue": false
}, - {
- "value": "600Mb",
- "defaultValue": false
}, - {
- "value": "700Mb",
- "defaultValue": false
}, - {
- "value": "800Mb",
- "defaultValue": false
}, - {
- "value": "900Mb",
- "defaultValue": false
}, - {
- "value": "1G",
- "defaultValue": false
}
]
}
]
}, - {
- "value": "10GigE",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "bandwidth",
- "values": [
- {
- "value": "10Mb",
- "defaultValue": false
}, - {
- "value": "20Mb",
- "defaultValue": false
}, - {
- "value": "30Mb",
- "defaultValue": false
}, - {
- "value": "40Mb",
- "defaultValue": false
}, - {
- "value": "50Mb",
- "defaultValue": false
}, - {
- "value": "60Mb",
- "defaultValue": false
}, - {
- "value": "70Mb",
- "defaultValue": false
}, - {
- "value": "80Mb",
- "defaultValue": false
}, - {
- "value": "90Mb",
- "defaultValue": false
}, - {
- "value": "100Mb",
- "defaultValue": false
}, - {
- "value": "150Mb",
- "defaultValue": false
}, - {
- "value": "200Mb",
- "defaultValue": false
}, - {
- "value": "250Mb",
- "defaultValue": false
}, - {
- "value": "300Mb",
- "defaultValue": false
}, - {
- "value": "400Mb",
- "defaultValue": false
}, - {
- "value": "500Mb",
- "defaultValue": false
}, - {
- "value": "600Mb",
- "defaultValue": false
}, - {
- "value": "700Mb",
- "defaultValue": false
}, - {
- "value": "800Mb",
- "defaultValue": false
}, - {
- "value": "900Mb",
- "defaultValue": false
}, - {
- "value": "1G",
- "defaultValue": false
}, - {
- "value": "2G",
- "defaultValue": false
}, - {
- "value": "3G",
- "defaultValue": false
}, - {
- "value": "5G",
- "defaultValue": false
}, - {
- "value": "10G",
- "defaultValue": false
}
]
}
]
}, - {
- "value": "100GigE",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "bandwidth",
- "values": [
- {
- "value": "10Mb",
- "defaultValue": false
}, - {
- "value": "20Mb",
- "defaultValue": false
}, - {
- "value": "30Mb",
- "defaultValue": false
}, - {
- "value": "40Mb",
- "defaultValue": false
}, - {
- "value": "50Mb",
- "defaultValue": false
}, - {
- "value": "60Mb",
- "defaultValue": false
}, - {
- "value": "70Mb",
- "defaultValue": false
}, - {
- "value": "80Mb",
- "defaultValue": false
}, - {
- "value": "90Mb",
- "defaultValue": false
}, - {
- "value": "100Mb",
- "defaultValue": false
}, - {
- "value": "150Mb",
- "defaultValue": false
}, - {
- "value": "200Mb",
- "defaultValue": false
}, - {
- "value": "250Mb",
- "defaultValue": false
}, - {
- "value": "300Mb",
- "defaultValue": false
}, - {
- "value": "400Mb",
- "defaultValue": false
}, - {
- "value": "500Mb",
- "defaultValue": false
}, - {
- "value": "600Mb",
- "defaultValue": false
}, - {
- "value": "700Mb",
- "defaultValue": false
}, - {
- "value": "800Mb",
- "defaultValue": false
}, - {
- "value": "900Mb",
- "defaultValue": false
}, - {
- "value": "1G",
- "defaultValue": false
}, - {
- "value": "2G",
- "defaultValue": false
}, - {
- "value": "3G",
- "defaultValue": false
}, - {
- "value": "5G",
- "defaultValue": false
}, - {
- "value": "10G",
- "defaultValue": false
}
]
}
]
}
]
}, - {
- "name": "handoff",
- "displayName": "Handoff",
- "description": "Handoff media expected for service delivery",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "2-Fiber (Optical MMF)",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "portHandoffSpeed",
- "values": [
- {
- "value": "GigE",
- "defaultValue": false
}, - {
- "value": "10GigE",
- "defaultValue": false
}, - {
- "value": "100GigE",
- "defaultValue": false
}
]
}
]
}, - {
- "value": "2-Fiber (Optical SMF)",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "portHandoffSpeed",
- "values": [
- {
- "value": "GigE",
- "defaultValue": true
}, - {
- "value": "10GigE",
- "defaultValue": true
}, - {
- "value": "100GigE",
- "defaultValue": true
}
]
}
]
}, - {
- "value": "Copper (RJ-45 Electrical)",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "portHandoffSpeed",
- "values": [
- {
- "value": "10/100/1000BaseT",
- "defaultValue": true
}, - {
- "value": "10GigE",
- "defaultValue": false
}, - {
- "value": "100GigE",
- "defaultValue": false
}
]
}
]
}
]
}, - {
- "name": "networkInterfaceDevice",
- "displayName": "Network Interface Device",
- "description": "N/A",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "No",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "handoff",
- "values": [
- {
- "value": "2-Fiber (Optical MMF)",
- "defaultValue": false
}, - {
- "value": "2-Fiber (Optical SMF)",
- "defaultValue": false
}, - {
- "value": "Copper (RJ-45 Electrical)",
- "defaultValue": false
}
]
}, - {
- "controllingField": "mefCertified",
- "values": [
- {
- "value": "No",
- "defaultValue": false
}, - {
- "value": "Yes",
- "defaultValue": false
}
]
}
]
}, - {
- "value": "Yes",
- "defaultValue": false,
- "allowedForControllingFields": [
- {
- "controllingField": "handoff",
- "values": [
- {
- "value": "2-Fiber (Optical MMF)",
- "defaultValue": false
}, - {
- "value": "2-Fiber (Optical SMF)",
- "defaultValue": false
}, - {
- "value": "Copper (RJ-45 Electrical)",
- "defaultValue": false
}
]
}, - {
- "controllingField": "mefCertified",
- "values": [
- {
- "value": "No",
- "defaultValue": false
}, - {
- "value": "Yes",
- "defaultValue": false
}
]
}
]
}
]
}, - {
- "name": "cfaProvidedBy",
- "displayName": "CFA Provided By",
- "description": "Entity responsible for Customer Facility Assignment",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "Zayo",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}, - {
- "value": "Customer",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "locationA",
- "displayName": "Location A",
- "description": "18-character location ID",
- "criteria": {
- "dataType": "Id",
- "isRequired": false,
- "anyRequired": [
- "locationA",
- "buildingA"
]
}
}, - {
- "name": "buildingA",
- "displayName": "Building A",
- "description": "18-character building ID",
- "criteria": {
- "dataType": "Id",
- "isRequired": false,
- "anyRequired": [
- "locationA",
- "buildingA"
]
}
}, - {
- "name": "nniId",
- "displayName": "NNI Id",
- "description": "18-character NNI ID",
- "criteria": {
- "dataType": "Id",
- "isRequired": false
}
}, - {
- "name": "cloudProvider",
- "displayName": "Cloud Provider",
- "description": "Name of provider",
- "criteria": {
- "dataType": "String",
- "isRequired": false,
- "schemaRefs": [
- {
- "$ref": "defs.json#/definitions/cloudlink"
}, - {
- "$ref": "defs.json#/definitions/checkProvider"
}, - {
- "$ref": "defs.json#/definitions/defaultConnectionType"
}
]
}, - "options": [
- {
- "value": null,
- "defaultValue": null,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "connectionType",
- "displayName": "Connection Type",
- "description": "Required when Cloud Provider is present.",
- "criteria": {
- "dataType": "String",
- "isRequired": false,
- "notRequired": true,
- "schemaRefs": [
- {
- "$ref": "defs.json#/definitions/evcEnabled"
}
]
}, - "options": [
- {
- "value": "Dedicated",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "Hosted",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "lag",
- "displayName": "LAG",
- "description": "LAG (Link Aggregation) gives you the ability to enhance your network capacity and reduce cost while maintaining a fast transmission speed by using all the same hardware devices.",
- "criteria": {
- "dataType": "String",
- "isRequired": false,
- "notRequired": true
}, - "options": [
- {
- "value": "Yes",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}, - {
- "value": "No",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}
]
}
], - "children": [ ]
}
]
}, - "preferences": {
- "isRequired": false,
- "attrs": [
- {
- "name": "requestFollowUp",
- "displayName": "Request Follow Up",
- "description": "If \\\"Yes\\\" then quote is routed to the Tranzact Experts desk for research. If \\\"No\\\" then quote is disregarded. Please provide contact information under Notes for direct follow up.",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}, - "options": [
- {
- "value": "No",
- "defaultValue": true,
- "allowedForControllingFields": [ ]
}, - {
- "value": "Yes",
- "defaultValue": false,
- "allowedForControllingFields": [ ]
}
]
}, - {
- "name": "notes",
- "displayName": "Notes",
- "description": "Free form text field limited to 255 characters. Use to provide additional information relevant to the quote, for example Customer Contact email for follow up.",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}
}, - {
- "name": "quoteNameIdentifier",
- "displayName": "Quote Name Identifier",
- "description": "Customer Identifier",
- "criteria": {
- "dataType": "String",
- "isRequired": false
}
}
]
}
}
]
}
}