Release Port
- 28 Oct 2024
- 28 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Release Port
- Updated on 28 Oct 2024
- 28 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/releasePort/
NOTE: This API is provided by a separate service.
Release the active device port.
This service will find unambiguous circuit with the existing active device port reservation with given request parameters, and then releases it. Request must include information of the active device port (at the minimum KeyCom internal deviceId and either portId or portName), which will be removed from the circuit reservations (from the logical reservations, physical reservations, or both).
The service supports optional update parameters in the request to update the affected circuit and/or section with, after the active device port is successfully released.
Changes if only one circuit is found and active device port reservation can be released: (1) Port and its logical connection will be removed from the circuit's reservations (2) Circuit basic data will be updated with the optional data supplied by the client (3) Circuit section will be updated with the optional data supplied by the client in addition to section usage state being set to "Partially pre-connected" (4) The construction state of logical connections, that were released from circuit in conjunction with the released port, will be updated to "Deleted"
Available from product version 2024.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
Object featuring both the search criteria for finding and releasing the active device port, and also the optional data to update the affected circuit and/or its section with.
object
addressId
integer
Optional search parameter. Apartment level ID of circuit installation address
circuitId
integer
Optional search parameter. ID of the circuit
connectDatePlanned
string (date-time)
Optional Circuit Update parameter. Circuit section planned connect date
connectDateReal
string (date-time)
Optional Circuit Update parameter. Circuit section connect date
contractLength
string
Optional Circuit Update parameter. Circuit contract Length
contractNumber
string
Optional Circuit Update parameter. Circuit contract number
customerId
string
Optional Circuit Update parameter.Circuit Customer ID
deviceId
integer Required
Device ID of Active Device
disconnectDatePlanned
string (date-time)
Optional Circuit Update parameter. Circuit section planned disconnect date
disconnectDateReal
string (date-time)
Optional Circuit Update parameter. Circuit section disconnect date
importanceId
string
Optional Circuit Update parameter. Circuit Importance ID
name
string
Optional Circuit Update parameter. Circuit identifier
name2
string
Optional Circuit Update parameter. Circuit alternative identifier
orderNumber
string
Optional Circuit Update parameter. Circuit order number
organisationId
string
Optional Circuit Update parameter. Circuit Organization ID
portId
integer
Port ID of Active Device Port (Note! Required if portName not given)
portName
string
Port Name of Active Device Port (Note! Required if portId not given)
redundancyId
string
Optional Circuit Update parameter. Circuit Redundancy ID
sectionId
integer
Optional search parameter. ID of the circuit section
sourceSystem
integer
Optional search parameter. Source System (Apartment/Address Level) of circuit installation address
sourceSystemKey
integer
Optional search parameter. Source System Key (Apartment/Address Level) of circuit installation address
usageId
integer
Optional search parameter. Usage purpose ID of circuit section
Responses
200
Circuit and sections with reservation data, route information, total length and total attenuation.
[
{
"areaCode": null,
"comments": null,
"contractLength": 4,
"contractNumber": "O2738",
"createdBy": "test_user",
"createdTs": "2024-08-29",
"customer": {
"address": {
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/1999978/"
],
"buildingId": "",
"building_name": null,
"city": "City",
"cityAlt": "",
"country": "",
"createdBy": "test_user",
"createdTs": "2021-04-16T09:42:33Z",
"district": "",
"empty": 0,
"id": 24264170,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": "SRID=3067;POINT (456503.37275543 6702568.6459308)",
"municipality": "",
"propertyId": "",
"province": "",
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "StreetName",
"streetnameAlt": "",
"streetno": "",
"subdivision": "",
"updatedBy": "test_user",
"updatedTs": "2022-02-14T10:16:19Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": ""
},
"apartmentDivision": null,
"apartmentLetter": null,
"apartmentNumber": null,
"empty": 1,
"id": 1999978,
"listUrl": "/api/v2/apartments/",
"originProperty": "//0000001592212",
"originalStreetno": null,
"sourceSystem": null,
"sourceSystemKey": null,
"usagePurpose": null,
"usagePurposeAlt": null,
"usageState": null
},
"addressAlt": null,
"billingName": "",
"businessId": "",
"createdBy": "test_user",
"createdTs": "2021-04-16T09:42:38Z",
"email": "",
"id": 4744870,
"listUrl": "http://keycom.example.com/api/v2/customers/",
"mobilePhone": "",
"name": "Test Customer",
"number": "A-4744870",
"phone": "",
"smsProhibited": false,
"telefax": "",
"type": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CUST_TYPE",
"id": 6030,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
"logical_txt": "Yritys",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Company"
},
"updatedBy": "test_user",
"updatedTs": "2024-01-17T01:13:08Z"
},
"directLength": null,
"id": 2216174,
"identifier": "Circuit X",
"identifierAlt": "Circuit Test",
"importance": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "CIRCUIT_IMPORTANCE",
"id": 48195510,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/CIRCUIT_IMPORTANCE/",
"logical_txt": "1 (>60 000 km2)",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "1 (>60 000 km2)"
},
"installationAddresses": [
"http://keycom.example.com/api/v2/circuitlocations/51106590/"
],
"length": null,
"orderNumber": "O4260",
"organisation": null,
"redundancy": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "CIRCUIT_REDUNDANCY",
"id": 48195750,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/CIRCUIT_REDUNDANCY/",
"logical_txt": "No redundancy",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "No redundancy"
},
"sections": [
{
"abnormalConnections": [
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829922070,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336290/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336290/",
"hierarchy": null,
"id": 14889490,
"order": 1,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829923270/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53336690/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829922070/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53336290/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24807350,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14889890,
"order": 2,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829923270,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336690/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336690/",
"hierarchy": null,
"id": 14890290,
"order": 3,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829923670/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53337090/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829923270/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53336690/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6210,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Vastinpistekytkentä",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Other end connection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24806950,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14890690,
"order": 4,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031898/"
],
"buildingId": null,
"building_name": null,
"city": "CABINET CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:29:24Z",
"district": null,
"empty": 0,
"id": 301705770,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CABINET STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:29:24Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829923670,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53337090/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53337090/",
"hierarchy": null,
"id": 14891490,
"order": 5,
"premises": "http://keycom.example.com/api/v2/premises/80538890/",
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829924070/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53337490/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829923670/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53337090/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24806550,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14891090,
"order": 6,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031898/"
],
"buildingId": null,
"building_name": null,
"city": "CABINET CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:29:24Z",
"district": null,
"empty": 0,
"id": 301705770,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CABINET STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:29:24Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829924070,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53337490/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216194/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53337490/",
"hierarchy": null,
"id": 14891890,
"order": 7,
"premises": "http://keycom.example.com/api/v2/premises/80538890/",
"section": "http://keycom.example.com/api/v2/sections/34734741/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829922070,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336290/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216214/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336290/",
"hierarchy": null,
"id": 14893490,
"order": 1,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34735141/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216214/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829923270/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53336690/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829922070/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53336290/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24807350,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14893090,
"order": 2,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34735141/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829923270,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336690/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216214/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336690/",
"hierarchy": null,
"id": 14893890,
"order": 3,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34735141/"
}
],
"connectionsToDelete": [
{
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829924870/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80539290/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53338290/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829924470/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80539290/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53337890/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24808150
}
],
"constructionState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"id": 34734341,
"listUrl": "http://keycom.example.com/api/v2/sections/",
"name": "Circuit Section X",
"provisioningDevices": [
{
"ccp": "http://keycom.example.com/api/v2/ccps/829922070",
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"device": "http://keycom.example.com/api/v2/devices/53336290/",
"order": 1,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
}
],
"reservations": {
"logical": [
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829922070,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336290/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336290/",
"hierarchy": null,
"id": 14886290,
"order": 1,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829923270/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53336690/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829922070/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53336290/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24807350,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14885890,
"order": 2,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031878/"
],
"buildingId": null,
"building_name": null,
"city": "CENTER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:28:58Z",
"district": null,
"empty": 0,
"id": 301705370,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CENTER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:28:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829923270,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53336690/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53336690/",
"hierarchy": null,
"id": 14886690,
"order": 3,
"premises": "http://keycom.example.com/api/v2/premises/80538490/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829923670/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53337090/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829923270/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538490/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53336690/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6210,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Vastinpistekytkentä",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Other end connection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24806950,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14887090,
"order": 4,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031898/"
],
"buildingId": null,
"building_name": null,
"city": "CABINET CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:29:24Z",
"district": null,
"empty": 0,
"id": 301705770,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CABINET STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:29:24Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829923670,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53337090/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53337090/",
"hierarchy": null,
"id": 14887490,
"order": 5,
"premises": "http://keycom.example.com/api/v2/premises/80538890/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829924070/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53337490/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829923670/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53337090/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6230,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Ristikytkentä",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Crossconnection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24806550,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14887890,
"order": 6,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031898/"
],
"buildingId": null,
"building_name": null,
"city": "CABINET CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:29:24Z",
"district": null,
"empty": 0,
"id": 301705770,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "CABINET STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:29:24Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829924070,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53337490/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53337490/",
"hierarchy": null,
"id": 14888290,
"order": 7,
"premises": "http://keycom.example.com/api/v2/premises/80538890/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"ccp": null,
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": {
"attenuation": null,
"cableLength": null,
"ccp1Id": "http://keycom.example.com/api/v2/ccps/829924470/",
"ccp1PremId": "http://keycom.example.com/api/v2/premises/80539290/",
"ccp1TermId": "http://keycom.example.com/api/v2/devices/53337890/",
"ccp2Id": "http://keycom.example.com/api/v2/ccps/829924070/",
"ccp2PremId": "http://keycom.example.com/api/v2/premises/80538890/",
"ccp2TermId": "http://keycom.example.com/api/v2/devices/53337490/",
"connectionType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONNECTION_TYPE",
"id": 6210,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
"logical_txt": "Vastinpistekytkentä",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Other end connection"
},
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"directionId": null,
"id": 24805750,
"listUrl": "http://keycom.example.com/api/v2/ccp-connections/"
},
"details": null,
"device": null,
"hierarchy": null,
"id": 14888690,
"order": 8,
"premises": null,
"section": "http://keycom.example.com/api/v2/sections/34734341/"
},
{
"address": {
"apartments": [
"http://keycom.example.com/api/v2/apartments/22031918/"
],
"buildingId": null,
"building_name": null,
"city": "SUBSCRIBER CITY",
"cityAlt": null,
"country": "",
"createdBy": "test_user",
"createdTs": "2024-08-29T04:29:58Z",
"district": null,
"empty": 0,
"id": 301706170,
"listUrl": "http://keycom.example.com/api/v2/addresses/",
"location": null,
"municipality": null,
"propertyId": null,
"province": null,
"sourceSystem": null,
"sourceSystemKey": null,
"streetname": "SUBSCRIBER STREETNAME",
"streetnameAlt": null,
"streetno": "1",
"subdivision": null,
"updatedBy": "test_user",
"updatedTs": "2024-08-29T04:29:58Z",
"usagePurpose": null,
"usagePurposeAlt": null,
"zipcode": null
},
"ccp": {
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 1,
"connectorType": null,
"constState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 1.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Ready"
},
"freeStatus": 1,
"functionality": null,
"id": 829924470,
"listUrl": "http://keycom.example.com/api/v2/ccps/",
"name": "1",
"parent": null,
"priority": null,
"remarks": null,
"services": [],
"signalDirection": null,
"startThread": 1,
"subCcpOrder": null,
"subchannelsExist": null,
"technology": 1,
"terminal": "http://keycom.example.com/api/v2/devices/53337890/"
},
"circuit": "http://keycom.example.com/api/v2/circuits/2216174/",
"connection": null,
"details": null,
"device": "http://keycom.example.com/api/v2/devices/53337890/",
"hierarchy": null,
"id": 14889090,
"order": 9,
"premises": "http://keycom.example.com/api/v2/premises/80539290/",
"section": "http://keycom.example.com/api/v2/sections/34734341/"
}
]
},
"totalAttenuation": 0,
"totalLength": 0,
"usagePurpose": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "USAGE",
"id": 14750,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/USAGE/",
"logical_txt": "5 rahapuhelin",
"num_value": 5.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "5 Coin phone"
},
"usageState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "KN_USAGE_STATE",
"id": 6390,
"list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_USAGE_STATE/",
"logical_txt": "Osittainen nimikko",
"num_value": 6.0,
"num_value2": 1.0,
"num_value3": null,
"num_value4": null,
"txt": "Part legend"
}
}
],
"updatedBy": "test_user",
"updatedTs": "2024-08-29"
}
]Array of object
object
areaCode
string
Circuit area code
comments
string
Circuit comments. Available from product version 3.2.8.
contractLength
integer
Circuit contract length
contractNumber
string
Circuit contract number
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
customer
object (Customer)
address
object (Apartment)
address
object (Address)
buildingId
string
Building id
buildingName
string
Building name
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
empty
integer
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
object (SourceSystem)
External source system
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "SOURCE_SYSTEM" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
empty
integer
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
sourceSystem
object (SourceSystem)
External source system
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "SOURCE_SYSTEM" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
usagePurpose
object (ApartmentUsage)
Apartment Usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "APARTMENT_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usageState
object (ApartmentStatus)
Apartment status
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "APARTMENT_STATUS" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
addressAlt
object (Apartment)
address
object (Address)
buildingId
string
Building id
buildingName
string
Building name
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
empty
integer
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
object (SourceSystem)
External source system
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "SOURCE_SYSTEM" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
empty
integer
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Valid values[ 0, 1 ]
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
sourceSystem
object (SourceSystem)
External source system
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "SOURCE_SYSTEM" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
usagePurpose
object (ApartmentUsage)
Apartment Usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "APARTMENT_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usageState
object (ApartmentStatus)
Apartment status
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "APARTMENT_STATUS" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
billingName
string
Customer billing name
businessId
string
Customer bussiness id
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
email
string
Customer email
id
integer
Primary key
mobilePhone
string
Customer mobile phone number name
name
string
Customer name
number
string
Customer number
phone
string
Customer phone number
smsProhibited
boolean
Sending sms is prohibited to customer
telefax
string
Customer fax number
type
object (CustomerType)
Customer type
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_CUST_TYPE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
directLength
number (float)
Circuit direct length
id
integer
Primary key
identifier
string
Circuit identifier
identifierAlt
string
Circuit alternative identifier
importance
object (CircuitImportance)
Circuit importance
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "CIRCUIT_IMPORTANCE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
installationAddresses
Array of string
Circuit installations addresses
string (url)
length
number (float)
Circuit length
orderNumber
string
Circuit order number
organisation
object (CircuitOrganisation)
Circuit organisation
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_ORGANISATION" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
redundancy
object (CircuitRedundancy)
Circuit redundancy
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "CIRCUIT_REDUNDANCY" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
sections
Array of object (CircuitSection)
Circuit sections
object
bitrate
object (Bitrate)
description
string
Bitrate description
id
integer
Primary key
rate
integer
Bitrate value
circuit
string (url)
Circuit the section is in
connectionDate
string (date-time)
actual section connection date
constructionState
object (ConstructionState)
Txt constants construction state
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_CONST_STATE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
disconnectionDate
string (date-time)
actual section disconnection date
id
integer
Primary key
name
string
Section name
plannedConnectionDate
string (date-time)
planned section connection date
plannedDisconnectionDate
string (date-time)
planned section disconnection date
usagePurpose
object (CircuitUsage)
Circuit usage
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
usageState
object (CircuitUsageState)
Circuit usage state
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_USAGE_STATE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
300
Multiple Choices
{
"details": "Object has multiple resources"
}object
details
string
Detailed description of error
400
Bad Request
{
"details": "Bad request syntax or unsupported method"
}object
details
string
Detailed description of error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
