Zayo API Developer Portal logo

API Developer Portal

Open Search

Ticket Catalog

View available tickets and ticket details to use in the Ticketing API.

Get ticket catalog

Get the Zayo trouble ticket catalog where tickets are represented as a ticketType. For each ticketType get the description and latest version.

SecurityBearerToken or OAuthClientCredentials
Responses
200

Success

400

Bad Request

get/services/service-management/v1/ticket-catalog
Request samples
curl -i -X GET \
  https://api.zayo.com/services/service-management/v1/ticket-catalog \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "apiVersion": "v1",
  • "data": {
    • "ticketTypes": [
      • {
        • "ticketType": "Billing",
        • "version": "1.0.0",
        • "description": "Inquiries related to receivables due on billing accounts."
        },
      • {
        • "ticketType": "Access Request",
        • "version": "1.0.0",
        • "description": "Request access into data centers and facilities."
        },
      • {
        • "ticketType": "Remote Hands",
        • "version": "1.0.0",
        • "description": "Support on tasks zColo can perform to be your hands and eyes regarding data center functions."
        },
      • {
        • "ticketType": "Customer Service",
        • "version": "1.0.0",
        • "description": "Customer support on general questions, service inventory, network documents, service credits and disputes."
        },
      • {
        • "ticketType": "Technical Support",
        • "version": "1.0.0",
        • "description": "Trouble ticket creation, escalate service repair issues, and RFO requests."
        }
      ]
    }
}

Get ticket type details

After you get the latest semantic version from the ticket-catalog route, plug this into the ticket-type-details route to dynamically receive the latest request schema with required and optional attributes needed per ticket type/version combination.

SecurityBearerToken or OAuthClientCredentials
Request
path Parameters
ticketType
required
string

Ticket type returned from the get ticket catalog route.

Enum: "Technical Support" "Access Request" "Billing" "Customer Service" "Remote Hands"
Example: Technical Support
version
required
string

Semantic version returned from the get ticket catalog route.

Enum: "1.0.0" "1.0.1"
Example: 1.0.0
Responses
200

Success

400

Bad Request

get/services/service-management/v1/ticket-type-details/{ticketType}/{version}
Request samples
curl -i -X GET \
  'https://api.zayo.com/services/service-management/v1/ticket-type-details/{ticketType}/{version}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "apiVersion": "v1",
  • "data": {
    • "attrs": [
      • {
        • "name": "ticketType",
        • "displayName": "Ticket Type",
        • "description": "Applicable ticket type from ticket catalog",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": true,
          • "anyRequired": [ ]
          },
        • "value": "Technical Support"
        },
      • {
        • "name": "componentId",
        • "displayName": "Component Id",
        • "description": "Unique Id obtained from GET Existing Services Route",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": false,
          • "anyRequired": [
            • "componentId, serviceId"
            ]
          }
        },
      • {
        • "name": "customerReferenceId",
        • "displayName": "Customer Reference Id",
        • "description": "Customer Input, reference specific to customer",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": false,
          • "anyRequired": [ ]
          }
        },
      • {
        • "name": "description",
        • "displayName": "Description",
        • "description": "Please provide a detailed statement of work",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": false,
          • "anyRequired": [ ]
          }
        },
      • {
        • "name": "downtimeInitialDate",
        • "displayName": "Downtime Initial Date",
        • "description": "ISO format date string of initial downtime",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": true,
          • "anyRequired": [ ]
          }
        },
      • {
        • "name": "downtimeInitialTime",
        • "displayName": "Downtime Initial Time",
        • "description": "ISO format time string of initial downtime",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": true,
          • "anyRequired": [ ]
          }
        },
      • {
        • "name": "serviceId",
        • "displayName": "Service Id",
        • "description": "Unique Id obtained from GET Existing Services Route",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": false,
          • "anyRequired": [
            • "componentId, serviceId"
            ]
          }
        },
      • {
        • "name": "serviceState",
        • "displayName": "Service state",
        • "description": "State of the service [Hard Down, Impaired, Request, Against, Service]",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": true,
          • "anyRequired": [ ]
          },
        • "options": [
          • {
            • "value": "Hard Down",
            • "defaultValue": false,
            • "allowedForControllingFields": [ ]
            },
          • {
            • "value": "Impaired",
            • "defaultValue": false,
            • "allowedForControllingFields": [ ]
            },
          • {
            • "value": "Request Against Service",
            • "defaultValue": false,
            • "allowedForControllingFields": [ ]
            }
          ]
        },
      • {
        • "name": "subject",
        • "displayName": "Subject",
        • "description": "Summary of request",
        • "criteria": {
          • "dataType": "string",
          • "isRequired": false,
          • "anyRequired": [ ]
          }
        }
      ],
    • "contacts": [
      • {
        • "attrs": [
          • {
            • "name": "contactType",
            • "displayName": "Contact Type",
            • "description": "Indicator of what this contact should be reached out for (Technical or Primary)",
            • "criteria": {
              • "dataType": "string",
              • "isRequired": false,
              • "anyRequired": [ ]
              },
            • "options": [
              • {
                • "value": "Primary",
                • "defaultValue": false,
                • "allowedForControllingFields": [ ]
                },
              • {
                • "value": "Technical",
                • "defaultValue": false,
                • "allowedForControllingFields": [ ]
                }
              ]
            },
          • {
            • "name": "email",
            • "displayName": "Email",
            • "description": "Contact email",
            • "criteria": {
              • "dataType": "string",
              • "isRequired": true,
              • "anyRequired": [ ]
              }
            },
          • {
            • "name": "fullName",
            • "displayName": "Full Name",
            • "description": "Contact full name",
            • "criteria": {
              • "dataType": "string",
              • "isRequired": true,
              • "anyRequired": [ ]
              }
            },
          • {
            • "name": "phone",
            • "displayName": "Phone",
            • "description": "Contact phone number",
            • "criteria": {
              • "dataType": "string",
              • "isRequired": true,
              • "anyRequired": [ ]
              }
            }
          ],
        • "minCount": 1,
        • "maxCount": 20
        }
      ],
    • "troubleshooting": {
      • "attrs": [
        • {
          • "name": "circuitPassTraffic",
          • "displayName": "Circuit Passing Traffic",
          • "description": "Has this circuit passed traffice before?",
          • "criteria": {
            • "dataType": "boolean",
            • "isRequired": false,
            • "anyRequired": [ ]
            }
          },
        • {
          • "name": "disconnectedFibers",
          • "displayName": "Disconnected Fibers",
          • "description": "Has physical maintenance been performed that disconnected fibers?",
          • "criteria": {
            • "dataType": "boolean",
            • "isRequired": false,
            • "anyRequired": [ ]
            }
          },
        • {
          • "name": "gearOn",
          • "displayName": "Gear on",
          • "description": "Do you have physical or remote access to your gear?",
          • "criteria": {
            • "dataType": "boolean",
            • "isRequired": false,
            • "anyRequired": [ ]
            }
          },
        • {
          • "name": "interfaceReset",
          • "displayName": "Interface Reset",
          • "description": "Does your interface have Duplex settings enabled?",
          • "criteria": {
            • "dataType": "boolean",
            • "isRequired": false,
            • "anyRequired": [ ]
            }
          },
        • {
          • "name": "verifyLightLevels",
          • "displayName": "Verify Light Levels",
          • "description": "Have you verified input/output light levels?",
          • "criteria": {
            • "dataType": "boolean",
            • "isRequired": false,
            • "anyRequired": [ ]
            }
          }
        ],
      • "isRequired": false
      }
    }
}