Get list of Circuits Reservation Data
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Circuits Reservation Data
- 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
/reservations/
Operation is used to get a list of Circuits Reservation Data. Available from product version 3.2.2.
Circuits reservation 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. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Minimum1
srs
string
Coordinate system to transform location to.
Example: srs=epsg:4326
__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))+++Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
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 circuits reservation data. Null if No next page exist
Prev
string (url)
Url to previous page of circuits reservation data. Null if No previous page exist
Results
Array of object (CircuitReservationData)
List of fetched circuits reservation data
object
circuit
string (url)
Reservation circuit
circuitOrder
integer
Reservation circuit order number
component
string
Reservation component name
componentAttenuation
number (float)
Reservation component attenuation
componentId
integer
Reservation component Id
componentLength
number (float)
Reservation component length
componentState
string
Reservation component state
componentType
string
Reservation component type
container
string
Reservation container name
containerId
integer
Reservation container Id
containerState
string
Reservation container state
containerType
string
Reservation container type
lineLocation
string (ewkt)
Linear geographical location of component
pointLocation
string (ewkt)
Point geographical location of component
section
string (url)
Reservation section
topContainer
string
Reservation top container name
topContainerId
integer
Reservation top container Id
topContainerState
string
Reservation top container state
topContainerType
string
Reservation top container type
Total
integer
Total number of circuits reservation data
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
