ON-API (2.6.0)

Download OpenAPI specification:Download

E-mail: fiber-support@bitvis.se License: MIT

Bitvis interpretation of ON-API 2.6, a standardized, RESTful API description for seamless system integration.

Accesses

The accesses endpoint is used to get available accesses from a CO. The accesses contain details about the address where the access resides and equipment.

For more information, see the Orders API documentation.

Get a single access

The single access contains details about activated services and the services available for activation.

path Parameters

id

required

string

Unique identifier for a single object.

Responses

Response samples

200
400
404

Content type

application/json

{"accessId": "string",
"legacyAccessId": "string",
"streetName": "string",
"streetNumber": "string",
"streetLittera": "string",
"postalCode": "string",
"city": "string",
"countryCode": "string",
"premisesType": "COMMERCIAL",
"mduApartmentNumber": "string",
"mduDistinguisher": "string",
"outlet": "string",
"population": "string",
"priceGroup": 0,
"accessState": "PLANNED",
"nationalAddressUUID": "string"
}

Get all accesses

The accesses endpoint is used to get available accesses from a CO. The accesses contain details about the address where the access resides and equipment.

Responses

Response samples

200

Content type

application/json

[{"accessId": "string",
"legacyAccessId": "string",
"streetName": "string",
"streetNumber": "string",
"streetLittera": "string",
"postalCode": "string",
"city": "string",
"countryCode": "string",
"premisesType": "COMMERCIAL",
"mduApartmentNumber": "string",
"mduDistinguisher": "string",
"outlet": "string",
"population": "string",
"priceGroup": 0,
"accessState": "PLANNED",
"nationalAddressUUID": "string"
}
]

DHCP Lookup

Look up an access with values from DHCP logs, returns a single accessId if a unique access can be found.

For more information, see the DHCP Lookup API documentation

Get an accessId

Look up an access with values from DHCP logs, returns a single accessId if a unique access can be found

query Parameters

ipv4CircuitId	string
ipv4RemoteId	string
ipv6InterfaceId	string
ipv6RemoteId	string
ipv4option82	string

Responses

Response samples

200

Content type

application/json

{"accessId": "string"
}

Events

Lists object changes

For more information, see the Events API documentation

Get events

Get all events stored in the system up to the previous second

Responses

Invoice Specification

This endpoint aims to provide the service provider (SP) with a specification of each billing item, this enables the SP to follow up and verify the invoice and correct service delivery.

For more information, see the Invoice Specification API documentation

Get invoice specification period by id

Fetch a specific invoice specification period by id given from the response of the get all invoice specification periods endpoint

path Parameters

id

required

string

Responses

Get all invoice specification periods

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"fromDate": "string",
"toDate": "string"
}
]

Option82 Lookup

The endpoint enables service providers to lookup access-id using the option82 from the DHCP log

For more information, see the Option82 Lookup API documentation

Get access-id

Look up an access with values from DHCP logs, returns a single accessId if a unique access can be found

path Parameters

option82

required

string

Responses

Response samples

200

Content type

application/json

{"accessId": "string"
}

Orders

This endpoint allows the service provider to activate, deactivate, suspend, resume, update and change services. Once an order is no longer in the state "RECEIVED" no changes can be made to that order.

For more information, see the Orders API documentation.

Get orders

The orders endpoint is used to get available orders from a CO. The orders contain details about the address where the order resides and equipment

query Parameters

accessId	string Get all orders pertaining a specific acccessId
state	string Enum: "RECEIVED" "IN_PROGRESS" "DONE_FAILED" "DONE_SUCCESS" Get all orders with a certain state

Responses

Response samples

200

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string",
"path": "string"
}

Create a new order

The orders endpoint is used to create a new order from a CO. The orders contain details about the address where the order resides and equipment.

Request Body schema: application/json

orderId	string The unique identifier for the order.
accessId	string The unique identifier for the access given in '/accesses'.
service	string The technical service offered by the CO.
operation	string Enum: "ACTIVATE" "DEACTIVATE" "SUSPEND" "RESUME" "MODIFY" "CHANGE" The type of operation this order is intended to perform
requestedDateTime	string <date-time> Earliest date and time for the order to be executed. If date is omitted the order is executed immediately.If a date in the past is provided (current date is 2019-04-01 and provided date is 2019-03-28) order will be executed immediately.
expectedCompletionDate	string <date-time> The date and time when the order is expected to be delivered. This is an estimated time.
spReference	string Service provider reference.
spSubscriptionId	string Service provider subscription id.
subscriptionId	string Subscription id
externalNote	string Note that is formatted in such a way that it can be displayed to the end customer.
	object (Characteristics) Characteristics for the service
forcedTakeover	boolean If the SP wishes to replace the service from another SP this value is set to true. This is only possible if the accesses API responds with forcedTakeoverPossible: true for the service to be activated. If forcedTakeoverPossible is false this field must be omitted or be set to false.
	object (Equipment) Equipment which is used to deliver a service
state	string Enum: "RECEIVED" "IN_PROGRESS" "DONE_SUCCESS" "DONE_FAILED" The state of the order.
message	string Used in the response to describe why the status is DONE_FAILED

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string"
}

Response samples

201

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string",
"path": "string"
}

Get a single order

The single order contains details about activated services and the services available for activation.

path Parameters

id

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string",
"path": "string"
}

Update an order

With put it is possible to update an order for which the state is "RECEIVED", using the complete object. Use orderId as key.

path Parameters

id

required

string

Unique identifier for a single object.

Request Body schema: application/json

orderId	string The unique identifier for the order.
accessId	string The unique identifier for the access given in '/accesses'.
service	string The technical service offered by the CO.
operation	string Enum: "ACTIVATE" "DEACTIVATE" "SUSPEND" "RESUME" "MODIFY" "CHANGE" The type of operation this order is intended to perform
requestedDateTime	string <date-time> Earliest date and time for the order to be executed. If date is omitted the order is executed immediately.If a date in the past is provided (current date is 2019-04-01 and provided date is 2019-03-28) order will be executed immediately.
expectedCompletionDate	string <date-time> The date and time when the order is expected to be delivered. This is an estimated time.
spReference	string Service provider reference.
spSubscriptionId	string Service provider subscription id.
subscriptionId	string Subscription id
externalNote	string Note that is formatted in such a way that it can be displayed to the end customer.
	object (Characteristics) Characteristics for the service
forcedTakeover	boolean If the SP wishes to replace the service from another SP this value is set to true. This is only possible if the accesses API responds with forcedTakeoverPossible: true for the service to be activated. If forcedTakeoverPossible is false this field must be omitted or be set to false.
	object (Equipment) Equipment which is used to deliver a service
state	string Enum: "RECEIVED" "IN_PROGRESS" "DONE_SUCCESS" "DONE_FAILED" The state of the order.
message	string Used in the response to describe why the status is DONE_FAILED

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string"
}

Patch an order

Update an order for which the state is "RECEIVED", using only the changed part. Use orderId as key.

path Parameters

id

required

string

Unique identifier for a single object.

Request Body schema: application/json

orderId	string The unique identifier for the order.
accessId	string The unique identifier for the access given in '/accesses'.
service	string The technical service offered by the CO.
operation	string Enum: "ACTIVATE" "DEACTIVATE" "SUSPEND" "RESUME" "MODIFY" "CHANGE" The type of operation this order is intended to perform
requestedDateTime	string <date-time> Earliest date and time for the order to be executed. If date is omitted the order is executed immediately.If a date in the past is provided (current date is 2019-04-01 and provided date is 2019-03-28) order will be executed immediately.
expectedCompletionDate	string <date-time> The date and time when the order is expected to be delivered. This is an estimated time.
spReference	string Service provider reference.
spSubscriptionId	string Service provider subscription id.
subscriptionId	string Subscription id
externalNote	string Note that is formatted in such a way that it can be displayed to the end customer.
	object (Characteristics) Characteristics for the service
forcedTakeover	boolean If the SP wishes to replace the service from another SP this value is set to true. This is only possible if the accesses API responds with forcedTakeoverPossible: true for the service to be activated. If forcedTakeoverPossible is false this field must be omitted or be set to false.
	object (Equipment) Equipment which is used to deliver a service
state	string Enum: "RECEIVED" "IN_PROGRESS" "DONE_SUCCESS" "DONE_FAILED" The state of the order.
message	string Used in the response to describe why the status is DONE_FAILED

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"requestedDateTime": "2019-08-24T14:15:22Z",
"expectedCompletionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"subscriptionId": "string",
"externalNote": "Your service have been blocked due to outstanding payment",
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"forcedTakeover": true,
"equipment": {"vendorId": "string",
"macAddress": "string"
},
"state": "RECEIVED",
"message": "string"
}

Order Events

This endpoint lists changes to orders. When an order state changes a event row is created that can be polled with this endpoint.

For more information, see the Orders API documentation.

Get all order events

query Parameters

since

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

[{"event": "string",
"order": {"path": "string",
"accessId": "string",
"service": "string",
"operation": "ACTIVATE",
"state": "RECEIVED",
"message": "string"
}
}
]

Services

Used to fetch a list of all available services from a CO belonging to the current SP.

For more information, see the Services API documentation.

Lists services for a certain accessId

path Parameters

accessId

required

string

Responses

Response samples

200

Content type

application/json

{"accessId": "string",
"services": [{"connectionDateTime": "string",
"availableDateTime": "string",
"disconnectionDateTime": "string",
"forcedTakeoverPossible": true,
"comments": ["string"
],
"characteristics": {"empty": true,
"property1": {"required": true,
"values": [{ }
]
},
"property2": {"required": true,
"values": [{ }
]
}
},
"service": "string"
}
]
}

Lists all services

Responses

Response samples

200

Content type

application/json

[{"accessId": "string",
"services": [{"connectionDateTime": "string",
"availableDateTime": "string",
"disconnectionDateTime": "string",
"forcedTakeoverPossible": true,
"comments": ["string"
],
"characteristics": {"empty": true,
"property1": {"required": true,
"values": [{ }
]
},
"property2": {"required": true,
"values": [{ }
]
}
},
"service": "string"
}
]
}
]

Subscriptions

Fetch a list of all active subscriptions from a CO belonging to the current SP.

For more information, see the Orders API documentation.

Get subscriptions for an access

Fetch a list of all subscriptions from a CO belonging to the current SP.

path Parameters

id

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"accessId": "string",
"subscriptions": [{"subscriptionId": "string",
"service": "string",
"operationalState": "ACTIVATED",
"connectionDate": "2019-08-24T14:15:22Z",
"disconnectionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"option82": "string",
"dhcpIdentifier": { },
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"equipment": {"vendorId": "string",
"macAddress": "string"
}
}
]
}

Get all active subscriptions

Fetch a list of all active subscriptions from a CO belonging to the current SP.

Responses

Response samples

200

Content type

application/json

[{"accessId": "string",
"subscriptions": [{"subscriptionId": "string",
"service": "string",
"operationalState": "ACTIVATED",
"connectionDate": "2019-08-24T14:15:22Z",
"disconnectionDate": "2019-08-24T14:15:22Z",
"spReference": "string",
"spSubscriptionId": "string",
"option82": "string",
"dhcpIdentifier": { },
"characteristics": {"fixedIp": true,
"ipAddresses": ["string"
],
"sla": "string"
},
"equipment": {"vendorId": "string",
"macAddress": "string"
}
}
]
}
]

Technical Info

The information communicated is intended for troubleshooting purposes and is sourced from network elements. All parameters are optional.

Technical decisions and data structure design are taken with regards to network element resource utilization, and to promote programmatic decision making.

For more information, see the Technical Info API documentation

Fetch full cpe state

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"firmware": "string",
"vendor": "string",
"model": "string",
"mac": "string",
"up": true,
"upSince": "string",
"ports": [{"index": 0,
"ifDescription": "string",
"name": "string",
"link": true,
"fullDuplex": true,
"changedAt": "2019-08-24T14:15:22Z",
"loopDetectionStatus": "string",
"freeSeating": true,
"configuredSpeed": "string",
"linkSpeed": 0,
"transceiver": {"dbmRx": "string",
"dbmTx": "string",
"temp": "string",
"biasTx": "string",
"supplyVoltage": "string",
"vendor": "string",
"partNumber": "string",
"serialNumber": "string"
},
"statistics": {"counterResetAt": "2019-08-24T14:15:22Z",
"peakInputRate": {"counter": 0,
"timestamp": "2019-08-24T14:15:22Z"
},
"peakOutputRate": {"counter": 0,
"timestamp": "2019-08-24T14:15:22Z"
},
"lastFiveInput": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"lastFiveOutput": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"input": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"output": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
}
}
}
],
"macAddressTable": [{"mac": "string",
"serviceType": "string",
"vlan": 0,
"port": "string",
"learntAt": "2019-08-24T14:15:22Z"
}
],
"dhcpSnoopingTable": [{"ip": "string",
"mac": "string",
"serviceType": "string",
"timeout": "2019-08-24T14:15:22Z"
}
]
}

Get hardware information

Information about the customer-facing network element, eg. access switch.

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"up": true,
"upSince": "2019-08-24T14:15:22Z",
"vendor": "string",
"model": "string"
}

Fetch igmp snooping data from only the access interface

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"multicast": "string",
"timestamp": "2019-08-24T14:15:22Z",
"counter": 0
}

Fetch lease data from the access interface

Fetch lease data from the access interface.

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"mac": "string",
"serviceType": "string",
"vlan": 0,
"port": "string",
"learntAt": "2019-08-24T14:15:22Z"
}

Fetch access equipment access interface status

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"link": true,
"fullDuplex": true,
"linkSince": "2019-08-24T14:15:22Z",
"speed": "string",
"adminDown": true,
"statistics": {"counterResetAt": "2019-08-24T14:15:22Z",
"peakInputRate": {"counter": 0,
"timestamp": "2019-08-24T14:15:22Z"
},
"peakOutputRate": {"counter": 0,
"timestamp": "2019-08-24T14:15:22Z"
},
"lastFiveInput": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"lastFiveOutput": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"input": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
},
"output": {"packets": 0,
"bytes": 0,
"unicast": 0,
"broadcast": 0,
"multicast": 0,
"pauses": 0,
"errors": 0,
"crcErrors": 0
}
},
"transceiver": {"dbmRx": "string",
"dbmTx": "string",
"temp": "string",
"biasTx": "string",
"supplyVoltage": "string",
"vendor": "string",
"partNumber": "string",
"serialNumber": "string"
},
"configuredSpeeds": [{"serviceType": "string",
"queue": "string",
"cir": "string",
"pir": "string"
}
]
}

Fetch mac address table data from only the access interface

Fetch mac address table data from only the access interface.

path Parameters

accessId

required

string

Unique identifier for a single object.

Responses

Response samples

200

Content type

application/json

{"mac": "string",
"serviceType": "string",
"vlan": 0,
"port": "string",
"learntAt": "2019-08-24T14:15:22Z"
}

Tickets

Provides functionality for trouble tickets to be handled between service providers and communication operators.

For more information, see the Tickets API documentation.

Fetch tickets

Fetch one or many tickets, able to filter by created timestamp or ticket status

query Parameters

status	string Enum: "CREATED" "IN_PROGRESS_CO" "IN_PROGRESS_SP" "CLOSED"
created	string

Responses

Response samples

200

Content type

application/json

[{"coTicketReference": "string",
"spTicketReference": "string",
"status": "CREATED",
"responsible": "SP"
}
]

Create a ticket

Create a new ticket

Request Body schema: application/json

spReference	string SP Reference
spTicketReference	string SP Ticket Reference
accessId	string Unique identifier for an Access, owned by CO
createdBy	string Created By User
heading	string Heading
description	string Description
status	string Enum: "CREATED" "IN_PROGRESS_CO" "IN_PROGRESS_SP" "CLOSED" Status
subscriptionId	string Unique identifier for a Subscription, owned by CO
problemType	string Enum: "NO_LINK" "NO_ACCESS" "QUALITY" "OTHER" Problem Type
	object (TicketInfo) Additional info

Responses

Request samples

Payload

Content type

application/json

{"spReference": "string",
"spTicketReference": "string",
"accessId": "string",
"createdBy": "string",
"heading": "string",
"description": "string",
"status": "CREATED",
"subscriptionId": "string",
"problemType": "NO_LINK",
"additionalInfo": {"ip": "string",
"mac": "string",
"link": true
}
}

Response samples

201

Content type

application/json

{"coTicketReference": "string"
}

Fetch ticket by reference

Fetch a ticket by its reference

path Parameters

coTicketReference

required

string

Responses

Response samples

200

Content type

application/json

{"coTicketReference": "string",
"spReference": "string",
"spTicketReference": "string",
"accessId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"heading": "string",
"description": "string",
"comments": [{"createdBy": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"status": "CREATED",
"responsible": "SP",
"subscriptionId": "string",
"problemType": "NO_LINK",
"additionalInfo": {"ip": "string",
"mac": "string",
"link": true
}
}

Update ticket status

Update ticket status and add comments. Also used for closing a ticket

path Parameters

coTicketReference

required

string

Request Body schema: application/json

status	string Enum: "CREATED" "IN_PROGRESS_CO" "IN_PROGRESS_SP" "CLOSED" CO Ticket Reference
	object (AccessTicketComment) Comment
responsible	string Enum: "SP" "CO" Responsible party, used for SLA calculation

Responses

Request samples

Payload

Content type

application/json

{"status": "CREATED",
"comment": {"createdBy": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"responsible": "SP"
}