Operation is used to get a list of fault.
Fault list can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Token issued for API consumer.
Offset to start returning results.
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Coordinate system used to transform location fields in API responses. This parameter does not apply to locations sent in request query parameters or request bodies.
For locations in requests, use EWKT with SRID. If EWKT is provided without SRID, the system default SRID will be used.
Example: srs=epsg:4326
Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:
- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
- For numerics: gt, lt, gte, lte, isnull
- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby
Examples:
+++usage_state__txt__istartswith=in+++,+++plan__state__txt__startswith=In+++,+++creation_date__gte=2019-01-02T15:32:01+++,+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++Supports exclusive queries by field value using a not-operator preceding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
Selects the object field to order the returned objects by.
Can be used to sort in reverse order with '-' prefix.
Can have several ordering rules separated by comma.
Can be used only for object own fields and does not support structured queries.
Example: orderby=creator,-creation_date
A result response object.
{
"Next": "http://example.keypro.fi/keylight_keyuv/api/v2/faults/?limit=10&offset=10",
"Previous": null,
"Results": [
{
"TaskID": null,
"address": null,
"closedBy": null,
"closedTs": null,
"createdBy": "example@keypro.fi",
"createdTs": "2024-12-11T07:55:45.604Z",
"description": null,
"faultCategory": {
"description": "Lamp / fixture",
"groupname": "TYPE",
"id": 240,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/",
"name": "TYPE_1_LAMP",
"numValue": null,
"orderno": 0,
"txtValue": null
},
"faultId": 321,
"faultLocation": null,
"faultLocationDetails": null,
"networkObjects": [],
"privateCustomerEmail": null,
"privateCustomerName": "",
"privateCustomerPhone": null,
"reportDate": "2024-12-11T07:55:45.604Z",
"state": {
"description": "Open",
"groupname": "STATUS",
"id": 235,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/",
"name": "STATUS_OPEN_OPEN",
"numValue": null,
"orderno": 0,
"txtValue": null
}
},
{
"TaskID": null,
"address": null,
"closedBy": null,
"closedTs": null,
"createdBy": "example@keypro.fi",
"createdTs": "2024-12-11T08:19:09.226Z",
"description": null,
"faultCategory": {
"description": "Lamp / fixture",
"groupname": "TYPE",
"id": 240,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/",
"name": "TYPE_1_LAMP",
"numValue": null,
"orderno": 0,
"txtValue": null
},
"faultId": 373,
"faultLocation": null,
"faultLocationDetails": null,
"networkObjects": [],
"privateCustomerEmail": null,
"privateCustomerName": "",
"privateCustomerPhone": null,
"reportDate": "2024-12-11T08:19:09.227Z",
"state": {
"description": "Open",
"groupname": "STATUS",
"id": 235,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/",
"name": "STATUS_OPEN_OPEN",
"numValue": null,
"orderno": 0,
"txtValue": null
}
},
{
"TaskID": 373,
"address": null,
"closedBy": null,
"closedTs": null,
"createdBy": "example@keypro.fi",
"createdTs": "2024-12-11T08:49:43.049Z",
"description": null,
"faultCategory": {
"description": "Lamp / fixture",
"groupname": "TYPE",
"id": 240,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/",
"name": "TYPE_1_LAMP",
"numValue": null,
"orderno": 0,
"txtValue": null
},
"faultId": 425,
"faultLocation": "SRID=3067;POINT Z (385725.26254746155 6681967.87279204 0)",
"faultLocationDetails": null,
"networkObjects": [
{
"ct": 8216,
"id": 35532090
}
],
"privateCustomerEmail": "example@keypro.fi",
"privateCustomerName": " ",
"privateCustomerPhone": "",
"reportDate": "2024-12-11T08:49:43.050Z",
"state": {
"description": "Open",
"groupname": "STATUS",
"id": 235,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/",
"name": "STATUS_OPEN_OPEN",
"numValue": null,
"orderno": 0,
"txtValue": null
}
},
{
"TaskID": null,
"address": null,
"closedBy": null,
"closedTs": null,
"createdBy": "example@keypro.fi",
"createdTs": "2024-12-11T11:39:36.322Z",
"description": null,
"faultCategory": {
"description": "Lamp / fixture",
"groupname": "TYPE",
"id": 240,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/",
"name": "TYPE_1_LAMP",
"numValue": null,
"orderno": 0,
"txtValue": null
},
"faultId": 477,
"faultLocation": null,
"faultLocationDetails": null,
"networkObjects": [],
"privateCustomerEmail": null,
"privateCustomerName": "",
"privateCustomerPhone": null,
"reportDate": "2024-12-11T11:39:36.323Z",
"state": {
"description": "Open",
"groupname": "STATUS",
"id": 235,
"list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/",
"name": "STATUS_OPEN_OPEN",
"numValue": null,
"orderno": 0,
"txtValue": null
}
}
],
"Total": 424
}Url to next page of Fault list. Null if No next page exist
Url to previous page of Fault list. Null if No previous page exist
List of fetched Fault
Information about Fault
Related task ID
Building id
Building name
Building city name
Building city name in alternative language
Building country
creator
Creation date and time
Building district
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Primary key
Geographical location
Building municipality
Property number
Building province
External source system
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
source system key
Building street name
Building street name in alternative language
Building number
Building municipality subdivision
Last updater
Last update date time
Building usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Address usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Building zipcode
apartment division
apartment letter
apartment number
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Primary key
apartment original property id
apartment original streen number
External source system
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
source system key
Apartment Usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Address usage purpose
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Apartment status
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Fault closed by user
Fault close date time
Fault created by user
Fault created date time
Fault description
Fault Category
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Numeric value
Order number
Human readable textual representation
Fault primary key
Geographical location.
Fault location details
Network objects linked to fault
Fault Network Object
Information about Fault
Primary key
Object type readable identifier
Object type instances API endpoint URL.
Object type translated name. Not searchable.
Url to fetch all object types.
Network object id
Customer email
Customer name
Customer phone
Fault reported date time
Fault State
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Numeric value
Order number
Human readable textual representation
Total number of Faults
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Standard error response payload
Detailed description of error