Create new Dh Duct

17 Jan 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Create new Dh Duct

Updated on 17 Jan 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/dh-duct/

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Dh Duct to be created

Expand All

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 Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

rent_paid

integer

Rent paid

role

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

state

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

type

object (DhDuctType)Required

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 Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

integer

Primary key

inner_diameter

number (float)

Inner diameter

material_id

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

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

Responses

201

A newly created Dh Duct

{
  "hole": [
    "1"
  ],
  "identification": [
    "test12345"
  ],
  "install_year": [
    "2021"
  ],
  "mslink": [
    "123456"
  ],
  "n_subducts": [
    "100"
  ],
  "owner": [
    "8680"
  ],
  "rent_paid": [
    "1"
  ],
  "role": [
    "2001"
  ],
  "state": [
    "310"
  ],
  "type": [
    "610"
  ]
}

object

Dh duct object. Flat version for patch and post methods

hole

integer

Hole

identification

string

Identification

install_year

integer

Install year

mslink

integer

Primary key

n_subducts

integer

Number of subducts

owner

integer

Owner id

rent_paid

integer

Rent paid

role

integer

Role id

state

integer

Usage state id

type

integer

Duct type id

400

There was an error in request. Usually field validation failed.

{
  "type": [
    "This field is required."
  ]
}

Fields which failed validation

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Delete Dh Duct