Zayo API Developer Portal logo

API Developer Portal

Open Search

Service Inventory

Monitor your critical services with our Service Inventory API.

Get services

Retrieve all non-disconnected services where locations of the services are reflected as components.

SecurityBearerToken or OAuthClientCredentials
Request
Request Body schema: application/json

Optional body to apply filters to return a list of non-disconnected services. Filter options include - service name, service id, billing account number, status, product group, product category, product, circuit id, legacy circuit id, customer circuit id, bandwidth, term, total mrc, and customer PO. Pagination with top and skip options.

object

Object to define filter options.

required
object

Object to define pagination for the number of records per page, and how many records to skip. Follows odata pagination standards.

search
string >= 3 characters
Responses
200

Success

400

Bad Request

post/services/service-management/v1/existing-services
Request samples
application/json
{
  • "filter": {
    • "serviceName": "022691",
    • "serviceId": "a0M60000007Mv6XEAS",
    • "status": "Active",
    • "productGroup": "Wavelengths - Metro",
    • "productCategory": "Point-to-Point",
    • "product": "Standard Wavelength",
    • "circuitId": "WAVE/ZGBU/TEST",
    • "term": 12
    },
  • "paging": {
    • "top": 50,
    • "skip": 0
    },
  • "search": "Wave"
}
Response samples
application/json
{
  • "apiVersion": "v1",
  • "data": {
    • "records": [
      • {
        • "serviceName": "254477",
        • "serviceId": "a0M6000000HKgWXEA1",
        • "accountName": "Test Account - Tranzact Billing",
        • "billingAccountNumber": "11-DevTest",
        • "status": "Pending Change",
        • "productGroup": "Wavelengths - Metro",
        • "productCategory": "Point-to-Point",
        • "product": "Standard Wavelength",
        • "circuitId": "WAVE/ZGBU/TEST",
        • "legacyCircuitId": null,
        • "customerCircuitId": null,
        • "bandwidth": "10G",
        • "term": 24,
        • "totalMrc": 4500,
        • "customerPO": "N/A",
        • "termStartDate": "2022-04-01",
        • "termEndDate": "2024-03-31",
        • "serviceNoticePeriodDays": 90,
        • "renewalIntervalMonths": 12,
        • "renewalTermType": "Auto-Renewal",
        • "components": [
          • {
            • "bandwidth": "10G",
            • "circuitId": "WAVE/ZGBU/TEST",
            • "customerCircuitId": null,
            • "legacyCircuitId": null,
            • "locations": [
              • {
                • "id": "a0b60000007Ws1vAAC",
                • "name": "639 E 18th Ave/Fl-B/Rm-B101",
                • "city": "Denver",
                • "state": "CO",
                • "postalCode": 80203,
                • "latitude": 39.7451918,
                • "longitude": -104.9792774
                },
              • {
                • "id": "a0b60000000XO4AAAW",
                • "name": "910 15th St/Fl-7/Rm-751",
                • "city": "Denver",
                • "state": "CO",
                • "postalCode": 80203,
                • "latitude": 39.74556,
                • "longitude": -104.995682
                }
              ],
            • "parentId": null,
            • "id": "a1X60000002Me9XEAS",
            • "type": null,
            • "cfa": null,
            • "cfaZ": null,
            • "components": [ ]
            }
          ]
        }
      ],
    • "metadata": {
      • "top": 10,
      • "skip": 0,
      • "currentPage": 1,
      • "totalPages": 1,
      • "totalRecordCount": 1
      }
    }
}