Get circuit location details
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get circuit location details
- 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
Get
/circuitlocations/{id}/
Operation is used to retrieve full details of given circuit location id. Available from product version 3.2.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of circuit location
Responses
200
Circuit Location
object
apartment
string (url)
apartment of the location
circuit
string (url)
Circuit of the location
id
integer
Primary key
installationType
object (CircuitLocationType)
Circuit location type
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "KN_LOCATION_TYPE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
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?
