Menu

Lumen help

Vyvx reservations

Description

Get the status of all active services (reservations).

Note: This service does not require or accept a content body. Please ensure that the Content-Length HTTP header is set to 0.

The call returns a JSON collection with one keyed entry per reservation. The “state” field describes the overall state of the reservation, and the “ingress_state” field describes the informed estimation of the state of the signal at the ingress to the Lumen network.

Possible state values:

  • online—service is operating normally.
  • impaired—service is operating normally, with some non-service-impacting anomaly.
  • degraded—service is still operational, but is experiencing some service-impacting anomaly.
  • offline—service is not operational.
  • unknown—the state cannot be determined.

Method

GET

Base URI

https://ws.lumen.com/vyvx/v1.0

URI syntax

/customer/service/_active/status

Example

https://ws.lumen.com/vyvx/v1.0/customer/service/_active/status

{
“data”: {
“services”: {
“1234567”: { “state”: “offline”,”ingress_state”: “online” },
“9999999”: { “state”: “offline”,”ingress_state”: “online” }
},
“time”: “2019-01-02T15:04:05.000Z”
}

Possible status and error messages returned to client

200: Request Successful.

400: Bad Request—missing required request information.

401: Not Authorized—access to unauthorized resource.

500: Internal Server Error—internal errors (DB, etc).

Description

Get the status of a single active service (reservation).

Note: This service does not require or accept a content body. Please ensure that the Content-Length HTTP header is set to 0.

The call returns a JSON collection with one keyed entry per reservation. The “state” field describes the overall state of the reservation, and the “ingress_state” field describes the informed estimation of the state of the signal at the ingress to the Lumen network.

Possible state values:

  • online—service is operating normally.
  • impaired—service is operating normally, with some non-service-impacting anomaly.
  • degraded—service is still operational, but is experiencing some service-impacting anomaly.
  • offline—service is not operational.
  • unknown—the state cannot be determined.

Method

GET

Base URI

https://ws.lumen.com/vyvx/v1.0

URI syntax

/customer/service/(id)/status

id : Reservation ID (required)

Example

https://ws.lumen.com/vyvx/v1.0/customer/service/1234567/status

{
“data”: {
“services”: {
“1234567”: { “state”: “offline”, “ingress_state”: “online” }
},
“time”: “2019-01-02T15:04:05.000Z”
}

Possible status and error messages returned to client

200: Request Successful.

400: Bad Request—missing required request information.

401: Not Authorized—access to unauthorized resource.

500: Internal Server Error—internal errors (DB, etc).

Description

Get the details of a single active service. A service usually contains one reservation but can contain multiple reservations.

Note: This service does not require or accept a content body. Please ensure that the Content-Length HTTP header is set to 0.

The call returns a JSON collection with the following fields:

  • id
  • state
  • ingress_state
  • name
  • po_number
  • notes
  • origins
  • destinations
  • reservations (which includes the schedule of the reservation)
     

The state field describes the overall state of the reservation, and the ingress_state field describes the informed estimation of the state of the signal at the ingress to the Lumen network.  See the Vyvx state and ingress state response definitions for more detail.

The name field is the name of the reservation.

The po_number is the customer’s PO number / internal source ID.

The notes field contains all the notes on a reservation.

Origins and destinations contain information about the route of the service.  

And finally, the reservations field contains all the reservations on the service.  The reservations on the service hold information about the reservation’s schedule.  The schedule contains the following fields:

  • scheduled—scheduled time of reservation.
  • reserved—reserved time of reservation.
  • actual—actual time of reservation.
  • activated—when the reservation was activated or deactivated; can hold multiple values.
  • terminal—true or false.

Method

GET

Base URI

https://ws.lumen.com/vyvx/v1.0

URI syntax

/customer/service/(id)/details

id : reservation ID (required)

Example

https://ws.lumen.com/vyvx/v1.0/customer/service/1234567/status

{
  "data": {
    "services": {
      "1234567": {
        "id": "1234567",
        "state": "unknown",
        "ingress_state": "unknown",
        "name": "USA East",
        "po_number": "12345",
        "notes": [
          {
            "id": 169843,
            "date": "2021-09-28T12:56:00-04:00",
            "message": "Test Note"
          },
        ],
        "origins": [
          {
            "abbr": "DNVRCOCOMCSTDN",
            "name": "COMCAST MEDIA CENTER 1 (DCF)",
            "city": "Centennial",
            "country": "US"
          }
        ],
        "destinations": [
          {
            "abbr": "CHRLNCDSS",
            "name": "DSS | KMTC",
            "city": "Kings Mountain",
            "country": "US"
          }
        ],
        "reservations": [
          {
            "id": "1234567",
            "schedule": {
              "scheduled": {
                "start": "2021-01-29T21:00:00.000Z",
                "end": "2021-12-06T04:59:00.000Z"
              },
              "reserved": {
                "start": "2021-01-29T21:00:00.000Z",
                "end": "2021-12-06T04:59:00.000Z"
              },
              "actual": {
                "start": "2021-01-29T21:00:00.000Z",
                "end": ""
              },
              "activated": [
                {
                  "start": "2021-01-29T22:08:04.086Z",
                  "end": ""
                }
              ]
            }
          }
        ]
      }
    }
  },
  "timestamp": "2021-10-01T09:42:42.470Z"
}

Possible status and error messages returned to client

200: Request Successful.

400: Bad Request—missing required request information.

401: Not Authorized—access to unauthorized resource.

500: Internal Server Error—internal errors (DB, etc).

Description

Get the alarm history of a single active service (reservation).

Note: This service does not require or accept a content body. Please ensure that the Content-Length HTTP header is set to 0.

Method

GET

Base URI

https://ws.lumen.com/vyvx/v1.0

URI syntax

/customer/service/(id)/history?start=(start)&end=(end)

Example

https://ws.lumen.com/vyvx/v1.0/customer/service/1234567/history?2019-01-02T15:04:05.000Z&end=2019-01-03T15:04:05.000Z

{
“data”: {
“services”: {
“1234567”: { “history”: {
“events”: [
{ “interval”: {“start”: “2019-01-02T16:00:00.000Z”, “end”: “2019-01-02T17:00:00.000Z },
“state”: “offline”,
“message”: “TS Loss”
}
]
}
} },
“time”: “2019-01-02T15:04:05.000Z”
}

Possible status and error messages returned to client

200: Request Successful.

400: Bad Request—missing required request information.

401: Not Authorized—access to unauthorized resource.

500: Internal Server Error—internal errors (DB, etc).

Overview

Lumen provides live reservation state (health) information for video reservations through the Vyvx API system. Lumen defines two types of reservation state:

  • (overall) state
  • ingress state

The 'state' refers to the overall health of the service from end-to-end, while the 'ingress state' represents an informed estimation of the health of the signal being presented to the ingress demarcation point of the network (i.e. the quality of the signal being provided to Lumen for transport).

Possible state values

The state and ingress state fields use a defined terminology and are always one of the following values:

  • online—service is operating normally
  • impaired—service is operating normally, with some non-service-impacting anomaly
  • degraded—service is still operational, but is experiencing some service-impacting anomaly
  • offline—service is not operational
  • unknown—the state cannot be determined

Ingress state calculation

Lumen provides the ingress state as an informed estimation of the health of the signal being provided by the source. The ingress state is calculated by examining the health of the signal being presented to the first piece of equipment in the signal flow chain that can be actively monitored. Because Lumen does not maintain active monitoring equipment at all customer demarcations, the first monitored equipment may be at a location other than the demarcation point. This means that the ingress state presented by Lumen systems is an informed estimation of the health of the signal being provided, not an authoritative declaration.

Should there be no active monitoring equipment in the signal flow chain prior to long-haul transport, Lumen will determine the ingress state to be “unknown” should a service impairment be detected.