Contents x
    Complete work order
    • 28 Oct 2024
    • 12 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Complete work order

    • Updated on 28 Oct 2024
    • 12 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /completeWorkOrder/

    NOTE: This API is provided by a separate service.

    This service will search existing circuit(s) from KeyCom based on provided parameters. If a single unambiguous circuit is found, it will then complete the circuit.

    Available from product version 3.4.0.

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Body parameters

    search criterias for circuit and work order completion date

    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

    connectDateReal
    string Required

    Connection date real

    Responses
    200

    Circuit with sections

    [
  {
    "areaCode": "",
    "comments": "",
    "contractLength": null,
    "contractNumber": "",
    "createdBy": "",
    "createdTs": null,
    "customer": null,
    "directLength": null,
    "id": 39028251,
    "identifier": "019 20840",
    "identifierAlt": "",
    "importance": null,
    "installationAddresses": [
      "https://example.keypro.fi/api/v2/circuitlocations/40935090/"
    ],
    "length": null,
    "orderNumber": "",
    "organisation": null,
    "redundancy": null,
    "sections": [
      {
        "bitrate": null,
        "circuit": 39028251,
        "connectionDate": "2018-01-12",
        "constructionState": 6050,
        "disconnectionDate": "2022-01-19",
        "id": 41379832,
        "name": "0",
        "plannedConnectionDate": null,
        "plannedDisconnectionDate": null,
        "usagePurpose": null,
        "usageState": 6310
      }
    ],
    "updatedBy": "testuser",
    "updatedTs": "2021-11-18"
  }
]
    Expand All
    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

    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?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved