Create new Gas Cable
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new Gas Cable

  • Dark
    Light
  • PDF

Article summary

Post
/gas-cable/
Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Gas Cable to be created

object

Gas cable object. Flat version for patch and post methods

CableType
integer Required

Gas cable type id

Contractor
integer

Contractor id

InstallationType
integer Required

Installation type id

Measure
integer

Measure id

NetType
integer

Network type id

Owner
integer Required

Owner id

Plan
integer

Plan id

Renter
integer

Renter id

State
integer Required

Usage state id

accuracy_id
integer

Accuracy id

created_by
string

Name of the user created the cable

created_ts
string (date-time)

Date created

false_cable
integer

False cable

h_accuracy_id
integer

Height accuracy id

history_date
string (date)

History date

identification
string

Identification

install_date
string (date)

Install date

install_year
integer

Install year

length
number (float)

Cable length

location
string (ewkt)

Geographical location

location_accuracy
integer

Location accuracy id

mapid
integer

Map id

mapper
string

Mapper

mapping_method_id
integer

Mapping method id

mslink
integer

Primary key

note
string

Additional details

survey_amaunt
integer

Survey amount

t_area_id
integer

Gas division id

updated_by
string

Name of the user updated the cable

updated_ts
string (date-time)

Date updated

Responses
201

A newly created Gas Cable

{
  "CableType": [
    "20178002"
  ],
  "InstallationType": [
    "290"
  ],
  "Owner": [
    "8740"
  ],
  "State": [
    "5361"
  ],
  "identification": [
    "test"
  ],
  "install_year": [
    "2021"
  ],
  "mslink": [
    "123456"
  ],
  "note": [
    "this is a test"
  ]
}
object

Gas cable object. Flat version for patch and post methods

CableType
integer

Gas cable type id

Contractor
integer

Contractor id

InstallationType
integer

Installation type id

Measure
integer

Measure id

NetType
integer

Network type id

Owner
integer

Owner id

Plan
integer

Plan id

Renter
integer

Renter id

State
integer

Usage state id

accuracy_id
integer

Accuracy id

created_by
string

Name of the user created the cable

created_ts
string (date-time)

Date created

false_cable
integer

False cable

h_accuracy_id
integer

Height accuracy id

history_date
string (date)

History date

identification
string

Identification

install_date
string (date)

Install date

install_year
integer

Install year

length
number (float)

Cable length

location
string (ewkt)

Geographical location

location_accuracy
integer

Location accuracy id

mapid
integer

Map id

mapper
string

Mapper

mapping_method_id
integer

Mapping method id

mslink
integer

Primary key

note
string

Additional details

survey_amaunt
integer

Survey amount

t_area_id
integer

Gas division id

updated_by
string

Name of the user updated the cable

updated_ts
string (date-time)

Date updated

400

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

{
  "CableType": [
    "This field is required."
  ],
  "InstallationType": [
    "This field is required."
  ],
  "Owner": [
    "This field is required."
  ],
  "State": [
    "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?