Operation is used to get a list of Sewer Branch.
Sewer Branch data 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.
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))+++
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 supports structured queries.
Example: orderby=creator,-creation_date
A result response object
Url to next page of the list if applicable. (Null if none)
Url to previous page of the list if applicable. (Null if none)
List of fetched Sewer Branch
Building id
Building city name
Building city name in alternative language
Building country
creator
Creation date and time
Building district
Primary key
Geographical location
Building municipality
Property number
Building province
Building street name
Building street name in alternative language
Building number
Building municipality subdivision
Last updater
Last update date time
Building usage purpose
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Address usage purpose
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Building zipcode
apartment division
apartment letter
apartment number
Primary key
apartment original property id
apartment original streen number
Apartment Usage purpose
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Address usage purpose
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Apartment status
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Plan
District Heating Consumer Point Duct Diameter
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
District Heating Consumer Point Duct Diameter
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
Plan Construction
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
Plan Excavation
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
District Heating Consumer Point Limiter
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
Plan Piping
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
Agreed Delivery Date. Activated on request by customer.
Area Description. Activated on request by customer.
Begin Date
Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.
Contact Email Address. Activated on request by customer.
Contact Name. Activated on request by customer.
Contact phone number. Activated on request by customer.
Consumer Point Identification. Activated on request by customer.
Created by
Create Date
Customer Contact Date. Activated on request by customer.
Description
Desired Delivery Date. Activated on request by customer.
District Area
Geographical location as EWKT representation
Name of District Area
Duration. Activated on request by customer.
Expire Date
First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.
Unique id of plan
Implementation Date. Activated on request by customer.
Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
URL to the list of all Plans. Only shown when displaying plan details in related objects.
Geographical location. As EWKT representation
Louhi ID. Activated on request by customer.
Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.
Name of Plan
Plan Network Type
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
Plan Network Owner
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
Offer Accepted Date. Activated on request by customer.
Offer ID. Activated on request by customer.
URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.
Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.
Plumbing Start Date. Activated on request by customer.
Property address. Not shown when displaying plan details in related objects. Activated on request by customer.
Plan Publicity
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
Plan state
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.
Plan type
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Human readable textual representation
Updated by
Update Date
Work Activities. Activated on request by customer.
Plan Work Phase
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
Work Project. Activated on request by customer.
Plan Work Type
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
Plan Work Type Main
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
Plan Work Type Sub
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
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Duct diameter
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Primary key
Duct inner diameter
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Material abbreviation
Material text
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Outdated date
Presentation date
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Technical lifespan in years
Duct width
Connected sewer node Id at the beginning point of the duct
Z-coordinate of the beginning point
An indicator if the beginning point's z-coordinate is only an estimate
Build year
Connected duct ID
Created by
Date created
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Aqua duct type feature
Primary key
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Connected sewer node Id at the end point of the duct
Z-coordinate of the end point
An indicator if the end point's z-coordinate is only an estimate
Feature
Float direction
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
History date
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Landxml name
Label angle
Export label angle
Label color
Export label color
Label size
Export label size
3D length
2D length
Geographical location
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Mapper
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Primary key
Network
Additional details
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Plan date
Plan number
Flag for pressure
Removal year
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Survey number
Symbol angle
Export symbol angle
Symbol code gt
Symbol color
Export symbol color
Symbol name
Export symbol name
Symbol size
Export symbol size
Symbol text
Export symbol text
Symbol width
Export symbol width
Updated by
Date updated
User's ID
Condition info
Z-coordinate
Total number of Sewer Branch objects in the list
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Detailed description of error