Get list of Dh Duct
- 17 Jan 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Dh Duct
- Updated on 17 Jan 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/dh-duct/
Operation is used to get a list of Dh Ducts.
Dh Duct data can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Query parameters
offset
integer
Offset to start returning results.
Minimum0
limit
integer
Limit number of results returned.
Minimum1
__any of the object fields__
string
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))+++
orderby
string
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
Responses
200
A result response object
object
Next
string (url)
Url to next page of the list if applicable. (Null if none)
Prev
string (url)
Url to previous page of the list if applicable. (Null if none)
Results
Array of object (DhDuct)
List of fetched Dh Ducts
object
hole
integer
Hole
identification
string
Identification
install_year
integer
Install year
mslink
integer
Primary key
n_subducts
integer
Number of subducts
owner
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)
rent_paid
integer
Rent paid
role
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)
state
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)
type
object (DhDuctType)
availability_end
string (date-time)
Availability end
availability_start
string (date-time)
Availability start
colour
string
Color
cross_section_cell
string
Microstation cellname for crosssection cell
form_code_id
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)
id
integer
Primary key
inner_diameter
number (float)
Inner diameter
material_id
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)
n_subducts
integer
Number of subducts
ordernum
integer
Order number
outer_diameter
number (float)
Outer diameter
renovation_cost
number (float)
Renovation price
subduct_type
string
Subduct type
type
string
Duct type
unit_cost
number (float)
New construction price
Total
integer
Total number of Dh Duct objects in the list
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
