Jump to: navigation, search

API Documentation Conventions

The Rovi Cloud Services API documentation uses the following conventions to indicate types of information:

Brackets [ ] Optional component of a request.
Ellipsis . . . Optional repetition of the previous syntax element, but with different values.
Monospaced font. Request or response text.
Bold monospaced font. A variable in the syntax of a request, such as the value in a parameter=value argument, which must be replaced with an actual value.
Monospaced font in a dotted box
Syntax definition or sample request.
segment? option 1
option 2
option 3
Mutually exclusive options for a segment of a request.
Monospaced font on a shaded background
A sample response.
Personal tools