Base Uri - Cisco D9800 Reference Manual

Web Services API
If an error occurs, a generic "failed" response is given. For example:
$ curl -k -H "X_SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?js=1"
{
}
The "code" in the generic "failed or success" response body is not used (most command responses set it
Note
to 10). We highly recommend that you do not change the field, unless otherwise indicated in the command
descriptions.

Base URI

The base URI for an API indicates a specific or a group of functionalities, which is used in conjunction with
URI parameters and options.
URI Parameters
Each web service API can have one or more URI parameters that can alter the semantics of the API. URI
parameters are appended to the base URI. For instance, a request to Show API can change the type of
information requested by providing a URI parameter such as "inventory" or "id-eeprom":
https://192.168.0.1/ws/v2/test/show/inventory
https://192.168.0.1/ws/v2/test/show/id-eeprom
URI parameters should be used separately, and are separated from the base URI by "/" character.
URI Arguments
Options are additional variables that an API can accept as input. Options are separated from URI parameters
or base URI by a "?" character and are separated from each other by the "&" character.
Each option has a name and a value. For instance, in the URL
"https://192.168.0.1/ws/v2/test/show/id-eeprom?card=NDM", the string "card" indicates an option with its
value set to "NDM".
• Argument Description
• Argument Type
"response": {
"code": "10",
"result": "failed",
"message": "Missing Key"
}
A brief description of the argument item.
Currently 5 different data types are supported for query options:
1 Integer
2 String
3 Boolean
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
Base URI
7