Get KeyUv Fault details

17 Jan 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Get KeyUv Fault details

Updated on 17 Jan 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/faults/{id}/

Operation retrieves full details by given id.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of Fault

Responses

200

KeyUv Fault

{
  "privateCustomerEmail": [
    "jdoe@email.com"
  ],
  "privateCustomerName": [
    "John Doe"
  ],
  "privateCustomerPhone": [
    "312-1234"
  ]
}

Expand All

object

KeyUvFault

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

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

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

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

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

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

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

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

closedBy

string

Closed by

closedTs

string (date-time)

Closed timestamp

createdBy

string

Created by

createdTs

string (date-time)

Created timestamp

description

string

Description

faultCategory

object (KeyUvSAttribute)

KeyUvSAttribute

attr_name

string

Attribute name

description

string

Description

groupname

string

Group name

integer

Primary key

model_ct

object (ContentType)

integer

Primary key

identifier

string

Object type readable identifier

instanceAPIUrl

string (url)

Object type instances API endpoint URL

name

string

Object type translated name. Not searchable.

objectTypesUrl

string (url)

Object types API endpoint URL

num_value

number (float)

Num value

orderno

integer

Order no.

txt_value

string

Txt value

faultId

integer

Primary key

faultLocation

string (ewkt)

Fault location

faultLocationDetails

string

Fault location details

networkObjects

object (KeyUvFaultNetworkObject)

KeyUvFaultNetworkObject

fault

integer

Primary key

network_object_ct

object (ContentType)

integer

Primary key

identifier

string

Object type readable identifier

instanceAPIUrl

string (url)

Object type instances API endpoint URL

name

string

Object type translated name. Not searchable.

objectTypesUrl

string (url)

Object types API endpoint URL

privateCustomerEmail

string

Private customer email

privateCustomerName

string

Private customer name

privateCustomerPhone

string

Private customer phone

reportDate

string (date-time)

Report date

state

object (KeyUvSAttribute)

KeyUvSAttribute

attr_name

string

Attribute name

description

string

Description

groupname

string

Group name

integer

Primary key

model_ct

object (ContentType)

integer

Primary key

identifier

string

Object type readable identifier

instanceAPIUrl

string (url)

Object type instances API endpoint URL

name

string

Object type translated name. Not searchable.

objectTypesUrl

string (url)

Object types API endpoint URL

num_value

number (float)

Num value

orderno

integer

Order no.

txt_value

string

Txt value

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

Update KeyUv Fault data partially