Complete circuit
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Complete circuit
- Updated on 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/circuits/{id}/complete_circuit/
Operation is used to complete circuit of given circuit id. Available from product version 3.4.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of circuit
Body parameters
date to be set in each section of the circuit
string (date-time)
Responses
201
List of completed circuit section
Array of object
List of completed circuit section
object
bitrate
integer
Circuit section bitrate id
circuit
string (url)
Circuit the section is in
connectionDate
string (date-time)
actual section connection date
constructionState
integer
Circuit section construction state id
disconnectionDate
string (date-time)
actual section disconnection date
id
integer
Primary key
name
string
Section name
plannedConnectionDate
string (date-time)
planned section connection date
plannedDisconnectionDate
string (date-time)
planned section disconnection date
usagePurpose
integer
Circuit section usage purpose id
usageState
integer
Circuit section usage state id
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
