Search circuit

28 Oct 2024
16 Minutes to read
Contributors

Print
Dark
Light
PDF

Search circuit

Updated on 28 Oct 2024
16 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/searchCircuit/

NOTE: This API is provided by a separate service.

Operation is used to search existing circuits from KeyCom with given search attributes and return information including location and reserved components. Available from product version 3.4.0.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

search criterias for circuit

object

contractNumber

string

circuit contract number as alternative search criteria

name

string

circuit identifier as alternative search criteria

name2

string

circuit alternate identifier as alternative search criteria

orderNumber

string

circuit order number as alternative search criteria

circuitId

integer

ID of circuit as primary search criteria

sectionId

integer

ID of circuit section as primary search criteria

bitrateId

integer

ID of section bitrate which is related to the speed of section

connectDatePlanned

string (date-time)

section connect date planned

connectDateReal

string (date-time)

section connect date real

constStateId

integer

ID of section construction state

disconnectDatePlanned

string (date-time)

section disconnect date planned

disconnectDateReal

string (date-time)

section disconnect date real

sectionName

string

section name

usagePurposeId

integer

ID of section usage purpose

usageStateId

integer

ID of section usage state

addressId

integer

ID of apartment related to circuit installation address

comments

string

circuit comments

customerId

integer

ID of customer related to circuit customer

importanceId

integer

ID of importance

organisationId

integer

ID of organisation

redundancyId

integer

ID of redundancy

Responses

200

Circuits with location and sections with reservation data.

[
  {
    "areaCode": "",
    "comments": "",
    "contractLength": null,
    "contractNumber": "100",
    "createdBy": "KEYCOM_STAGE",
    "createdTs": "2021-09-03",
    "customer": {
      "address": {
        "address": {
          "apartments": [
            "http://keycom.example.com/api/v2/apartments/3281/"
          ],
          "buildingId": "",
          "city": "",
          "cityAlt": "",
          "country": "",
          "createdBy": "",
          "createdTs": null,
          "district": "",
          "empty": 1,
          "id": 390,
          "listUrl": "http://keycom.example.com/api/v2/addresses/",
          "location": null,
          "municipality": "",
          "propertyId": "",
          "province": "",
          "sourceSystem": null,
          "sourceSystemKey": null,
          "streetname": "",
          "streetnameAlt": "",
          "streetno": "",
          "subdivision": "",
          "updatedBy": "KEYCOM_STAGE30",
          "updatedTs": "2018-01-11T06:00:20Z",
          "usagePurpose": {
            "availability_end_ts": null,
            "availability_start_ts": null,
            "available": true,
            "groupname": "BUILDING_USAGE",
            "id": 233970,
            "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
            "logical_txt": "Asuinrakennus",
            "num_value": null,
            "num_value2": null,
            "num_value3": 1.0,
            "num_value4": null,
            "txt": "Residential building"
          },
          "usagePurposeAlt": null,
          "zipcode": ""
        },
        "apartmentDivision": "",
        "apartmentLetter": "",
        "apartmentNumber": "",
        "empty": 1,
        "id": 3281,
        "listUrl": "/api/v2/apartments/",
        "originProperty": "//0000000003281",
        "originalStreetno": "",
        "sourceSystem": null,
        "sourceSystemKey": null,
        "usagePurpose": null,
        "usagePurposeAlt": null,
        "usageState": null
      },
      "addressAlt": null,
      "billingName": "",
      "businessId": "",
      "createdBy": "",
      "createdTs": null,
      "email": "",
      "id": 2810,
      "listUrl": "http://keycom.example.com/api/v2/customers/",
      "mobilePhone": "",
      "name": "Testi Testinen",
      "number": "A-2810",
      "phone": "",
      "smsProhibited": null,
      "telefax": "",
      "type": null,
      "updatedBy": "KEYCOM_STAGE30",
      "updatedTs": "2018-01-03T11:02:58Z"
    },
    "directLength": null,
    "id": 287214,
    "identifier": "circuitName",
    "identifierAlt": "circuitOtherName",
    "importance": null,
    "installationAddresses": [
      {
        "apartment": "http://keycom-default-py3.tests2.keypro.fi/api/v2/apartments/3281/",
        "circuit": "http://keycom-default-py3.tests2.keypro.fi/api/v2/circuits/287214/",
        "id": 1526413,
        "installationType": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_LOCATION_TYPE",
          "id": 6210,
          "list_url": "http://keycom-default-py3.tests2.keypro.fi/api/v2/txt_constants/groupname/KN_LOCATION_TYPE/",
          "logical_txt": "AAAAAA",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Beginning"
        }
      }
    ],
    "length": null,
    "orderNumber": "100",
    "organisation": null,
    "redundancy": null,
    "sections": [
      {
        "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": 3369941,
        "listUrl": "http://keycom.example.com/api/v2/sections/",
        "name": "sectionName",
        "reservations": {
          "logical": [
            {
              "address": {
                "apartments": [
                  "http://keycom.example.com/api/v2/apartments/4289/"
                ],
                "buildingId": "",
                "city": "LOVIISA",
                "cityAlt": "",
                "country": "",
                "createdBy": "",
                "createdTs": null,
                "district": "",
                "empty": 0,
                "id": 80750,
                "listUrl": "http://keycom.example.com/api/v2/addresses/",
                "location": null,
                "municipality": "",
                "propertyId": "",
                "province": "",
                "sourceSystem": null,
                "sourceSystemKey": null,
                "streetname": "PUISTIKKOKATU",
                "streetnameAlt": "",
                "streetno": "1",
                "subdivision": "",
                "updatedBy": "KEYCOM_STAGE30",
                "updatedTs": "2018-01-11T06:00:22Z",
                "usagePurpose": {
                  "availability_end_ts": null,
                  "availability_start_ts": null,
                  "available": true,
                  "groupname": "BUILDING_USAGE",
                  "id": 233970,
                  "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
                  "logical_txt": "Asuinrakennus",
                  "num_value": null,
                  "num_value2": null,
                  "num_value3": 1.0,
                  "num_value4": null,
                  "txt": "Residential building"
                },
                "usagePurposeAlt": null,
                "zipcode": 7900
              },
              "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"
                },
                "device": [
                  {
                    "comments": "",
                    "connectorCount": 6,
                    "createdBy": "",
                    "createdTs": null,
                    "id": 21050,
                    "identification": "1",
                    "interface": "",
                    "managementAddress": "",
                    "managementAddress2": "",
                    "orderNo": null,
                    "owner": null,
                    "parent": null,
                    "premise": "http://keycom.example.com/api/v2/premises/23610/",
                    "renter": null,
                    "sourceSystem": null,
                    "sourceSystemKey": null,
                    "startPin": 1,
                    "type": "http://keycom.example.com/api/v2/terminal-types/2810/",
                    "updatedBy": "KEYCOM_STAGE",
                    "updatedTs": "2010-08-31T09:50:01Z",
                    "usageState": null
                  }
                ],
                "freeStatus": 0,
                "functionality": "",
                "id": 1319590,
                "listUrl": "http://keycom.example.com/api/v2/ccps/",
                "name": "1",
                "parent": null,
                "premises": [
                  {
                    "address": "http://keycom.example.com/api/v2/apartments/4289/",
                    "angle": 258.690210012265,
                    "capacity": 6,
                    "createdBy": "",
                    "createdTs": null,
                    "deviceRoom": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "PREM_PLACEMENT",
                      "id": 5381,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/PREM_PLACEMENT/",
                      "logical_txt": "Huone",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "Room"
                    },
                    "diagramConfirm": null,
                    "heightAccuracy": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "H_ACCURACY",
                      "id": 117210,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/H_ACCURACY/",
                      "logical_txt": "Ei määritelty",
                      "num_value": 1.0,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "Not defined"
                    },
                    "historyDate": null,
                    "id": 23610,
                    "identification": "PUISTIKKOKATU 1",
                    "importance": null,
                    "install_year": null,
                    "location": "SRID=3067;POINT Z (456644.3093 6702520.3081 0)",
                    "locationAccuracy": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "LOCATION_ACCURACY",
                      "id": 8301,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
                      "logical_txt": "2.0m",
                      "num_value": 2.0,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": 2.0,
                      "txt": "2.0m"
                    },
                    "manhole": null,
                    "mapper": "",
                    "mappingMethod": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "MAPPING_METHOD",
                      "id": 390,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/MAPPING_METHOD/",
                      "logical_txt": "Digitoitu",
                      "num_value": 4.0,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "Digitized"
                    },
                    "name": "",
                    "owner": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "PREM_OWNER",
                      "id": 2010,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/PREM_OWNER/",
                      "logical_txt": "Loviisan Puhelin",
                      "num_value": 1.0,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "Loviisan Puhelin"
                    },
                    "plan": null,
                    "pole": null,
                    "remarks": "",
                    "renter": null,
                    "scale": 4.0,
                    "sourceSystem": null,
                    "sourceSystemKey": null,
                    "survey_amount": "",
                    "technicalId": null,
                    "technicalInfo": "",
                    "telecomArea": "http://keycom.example.com/api/v2/telecom-areas/10/",
                    "type": {
                      "cost": null,
                      "id": 12,
                      "listUrl": "http://keycom.example.com/api/v2/premtypes/",
                      "manufacturer": "Tuntematon",
                      "productCode": "",
                      "type": {
                        "availability_end_ts": null,
                        "availability_start_ts": null,
                        "available": true,
                        "groupname": "PREM_TYPE",
                        "id": 3290,
                        "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/PREM_TYPE/",
                        "logical_txt": "Tilaajapiste",
                        "num_value": null,
                        "num_value2": null,
                        "num_value3": null,
                        "num_value4": null,
                        "txt": "Subscriber point"
                      }
                    },
                    "updatedBy": "KEYCOM_STAGE",
                    "updatedTs": "2021-08-31T10:27:12Z",
                    "usageState": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": true,
                      "groupname": "PREM_STATE",
                      "id": 14601,
                      "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/PREM_STATE/",
                      "logical_txt": "Käytössä",
                      "num_value": 1.0,
                      "num_value2": 1.0,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "In use"
                    }
                  }
                ],
                "priority": null,
                "remarks": "",
                "services": [],
                "signalDirection": null,
                "startThread": 1,
                "subCcpOrder": null,
                "subchannelsExist": "",
                "technology": 0,
                "terminal": "http://keycom.example.com/api/v2/devices/21050/"
              },
              "circuit": "http://keycom.example.com/api/v2/circuits/287214/",
              "connection": null,
              "details": "",
              "device": "http://keycom.example.com/api/v2/devices/21050/",
              "hierarchy": null,
              "id": 2413490,
              "order": 1,
              "premises": "http://keycom.example.com/api/v2/premises/23610/",
              "section": "http://keycom.example.com/api/v2/sections/3369941/"
            }
          ],
          "physical": [
            {
              "circuit": "http://keycom.example.com/api/v2/circuits/287214/",
              "circuitOrder": 1,
              "component": "1",
              "componentAttenuation": 0.5,
              "componentLength": null,
              "componentState": "Ready",
              "componentType": "connector",
              "container": "1",
              "containerId": 21050,
              "containerState": "",
              "containerType": "device",
              "section": "http://keycom.example.com/api/v2/sections/3369941/",
              "topContainer": "PUISTIKKOKATU 1",
              "topContainerState": "In use",
              "topContainerType": "telecom premises"
            }
          ]
        },
        "usagePurpose": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "USAGE",
          "id": 15050,
          "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/USAGE/",
          "logical_txt": "62 Vaihde kutsu",
          "num_value": 62.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "62 Vaihde kutsu"
        },
        "usageState": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_USAGE_STATE",
          "id": 6350,
          "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/KN_USAGE_STATE/",
          "logical_txt": "Pian käytössä",
          "num_value": 4.0,
          "num_value2": 1.0,
          "num_value3": null,
          "num_value4": null,
          "txt": "Soon in use"
        }
      }
    ],
    "updatedBy": "KEYCOM_STAGE",
    "updatedTs": "2021-09-03"
  }
]

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 ]

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" ]

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" ]

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" ]

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 ]

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" ]

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" ]

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" ]

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" ]

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 ]

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" ]

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" ]

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" ]

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 ]

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" ]

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" ]

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" ]

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" ]

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

string

Customer email

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" ]

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

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" ]

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" ]

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" ]

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

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" ]

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

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" ]

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" ]

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

404

Circuit not found

{
  "details": "Circuit not found"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Terminate work order