Contents x
    Get Failure Report details
    • 17 Jan 2024
    • 11 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get Failure Report details

    • Updated on 17 Jan 2024
    • 11 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /failure-report/{id}/

    Operation is used to retrieve full details of given Failure Report Id

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Path parameters
    id
    integerRequired

    Id of Failure Report

    Responses
    200

    Retrieved Failure Report(object)

    Expand All
    object
    Additional_damage
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Angle
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Common_reason
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Contract_season
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Contractor
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Corrosion_location
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Cover
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Damage_detect
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Damage_tas
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Designer
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Duct_install_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Duct_statistic_dn
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Duct_statistic_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Duct_statistic_usage
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Duct_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Error
    object (ErrorReport)
    Address
    object (Apartment)
    address
    object (Address)
    buildingId
    string

    Building id

    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

    id
    integer

    Primary key

    location
    string (ewkt)

    Geographical location

    municipality
    string

    Building municipality

    propertyId
    string

    Property number

    province
    string

    Building province

    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

    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

    txt
    string

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    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

    txt
    string

    Human readable textual representation

    zipcode
    string

    Building zipcode

    apartmentDivision
    string

    apartment division

    apartmentLetter
    string

    apartment letter

    apartmentNumber
    string

    apartment number

    id
    integer

    Primary key

    originProperty
    string

    apartment original property id

    originalStreetno
    string

    apartment original streen number

    usagePurpose
    object (ApartmentUsage)

    Apartment Usage purpose

    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

    txt
    string

    Human readable textual representation

    usagePurposeAlt
    object (AddressSecondaryUsage)

    Address usage purpose

    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

    txt
    string

    Human readable textual representation

    usageState
    object (ApartmentStatus)

    Apartment status

    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

    txt
    string

    Human readable textual representation

    DistrictId
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    FailureCause
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    FailureType
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    FaultCode
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    ReportState
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    SnErrorRestictedType
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    angle
    number (float)

    Angle

    announcer
    string

    Username of the announcer GDPR protected field

    announcer_tel
    string

    Telephone number of the announcer GDPR protected field

    consumer_point_count
    integer

    Number of consumer point

    created_by
    string

    Created by

    created_ts
    string (date-time)

    Date created

    damaged_part
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    distance
    number (float)

    Distance

    district
    string

    District

    e_coord
    number (float)

    Coordinate

    error_message
    string

    Error message

    failure_address
    string

    Failure address

    failure_cause
    string

    Failure cause

    failure_type
    string

    Failure type

    fault_code
    integer

    Fault code

    flush
    boolean

    Flush

    ground_plan
    string

    Ground plan

    joint_power
    number (float)

    Joint power

    location
    string (ewkt)

    Geographical location

    manhole
    string

    Manhole

    mapid
    integer

    Map id

    mslink
    integer

    Primary key

    n_coord
    number (float)

    Coordinate

    notes
    string

    Additional information

    noticed_by
    boolean

    If the report is noticed or not

    orderno
    integer

    Order number

    point_distance
    string

    Point distance

    receivedDate_ts
    string (date-time)

    Received date

    received_by
    string

    Username of the person received the report GDPR protected field

    repair_belong_to
    boolean
    repair_type
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    scale
    number (float)

    Scale

    symbol_added
    integer

    If report has location or not

    type_orderno
    integer

    Type order number

    updated_by
    string

    Updated by

    updated_ts
    string (date-time)

    Date updated

    volume
    number (float)

    Volume

    water
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Extra_reason
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Failure_location
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Foundation
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Ground_water_lvl
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Heat_season
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Insulation
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Joint_location
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Joint_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Leak_detect
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Location
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Orig_perdn
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Positioning_accuracy
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Service_point
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Soil_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Underground_drain
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Work_reason
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    Work_type
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    contract_year
    integer

    Contract year

    created_by
    string

    Username of failure report creator

    created_ts
    string (date-time)

    Date created

    customer_count
    integer

    Customer count

    duct_count_installed
    integer

    Number of duct installed

    duct_count_remove
    integer

    Number of duct removed

    duct_count_renovated
    integer

    Number of duct renovated

    duct_count_repaired
    integer

    Number of duct repaired

    duct_statistic_m
    string

    Duct statistic

    duct_statistic_mp
    string

    Duct statistic

    duct_trade_name
    string

    Duct trade name

    extra_information
    string

    Extra information

    failure_number
    string

    Failure number

    id
    integer

    Primary key

    interrupt_date
    string (date-time)

    Interrupt date

    interval
    string

    Interval

    joint_capacity
    number (float)

    Joint capacity

    joint_trade_name
    string

    Joint trade name

    map_sheet
    string

    Map sheet

    notes
    string

    Notes

    order_water_flow
    number (float)

    Order water flow

    orderno
    integer

    Order number

    other_reason
    string

    Other reason

    period
    string

    Period

    repair_date
    string (date-time)

    Repair date

    service_point_no
    integer

    Service point number

    shell_info
    string

    Shell information

    site_layout
    string

    Site layout

    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