Example 4: GET a specific RF tuning value for a specific RF port
The following example assumes that the user has successfully logged onto the unit, received the session id
and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. Please change
the IP to the specific unit IP in use. This example retrieves one specific parameter value from the RF tuning
settings for RF port 3. Please note that the user
MUST
always specify the port number in the URI followed
by the URI argument the user wishes to retrieve. This example retrieves the IQ Mode from RF Port 3. Please
note that in GET URI
’
s only the port argument must contain a value for the port, all other arguments
DO NOT
contain values.
curl -X GET -i
-H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&iq"
If successful, the return body will be:
"input": {
"rf": {
"port": "3",
"iq": "Normal"
}
}
Example 5: GET multiple RF tuning values for a specific RF port
The following example assumes that the user has successfully logged onto the unit, received the session id
and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. Please change
the IP to the specific unit IP in use. This example retrieves multiple parameter value from the RF tuning
settings for RF port 3. Please note that the user
MUST
always specify the port number in the URI followed
by the URI arguments the user wishes to retrieve. This example retrieves the iq, sdten, niten and paten values
from RF Port 3. Please note that in GET URI
’
s only the port argument must contain a value for the port, all
other arguments
DO NOT
contain values.
curl -X GET -i
-H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&iq&paten&sdten&niten"
If successful, the return body will be:
"input": {
"rf": {
"port": "3",
"iq": "Normal",
"niten": "No",
"paten": "Yes",
"sdten": "Yes"
}
}
Miscellaneous Examples
Example 6: URI Parameters are misspelled or missing
curl -i -k -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/inputrf?port=1&act=Yes&dnlkfreq=1.421&symrate=32&mod=DVB-S2"
Expected Output:
1) No XML output will be returned.
2) HTTP return code is not value 200 (HTTP_OK).
HTTP/1.1 404 Not Found
Date: Fri, 23 Oct 2015 19:26:40 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 404
Remedy:
Client software must always first check HTTP return code.
Re-check that URI parameters portion of the command (the part before the ?) is correctly input
In the above example, /inputrf should be /input/rf.
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
144
API Definitions
Input Configuration Command