Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
dvr:dvr_recording_rules [2019/10/10 20:07] neds created |
dvr:dvr_recording_rules [2019/10/10 20:12] neds removed |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| ====API URL==== | ====API URL==== | ||
| + | <WRAP indent> | ||
| <code>https://api.hdhomerun.com/api/recording_rules</code> | <code>https://api.hdhomerun.com/api/recording_rules</code> | ||
| + | </WRAP> | ||
| ====List recording rules==== | ====List recording rules==== | ||
| + | <WRAP indent> | ||
| ^ Parameter ^ Type ^ Description ^ | ^ Parameter ^ Type ^ Description ^ | ||
| Line 25: | Line 28: | ||
| Returns: Details all matching recording rules, or "null" if no matching rules exist. Results are ordered DateTimeOnly first, then by priority highest first. | Returns: Details all matching recording rules, or "null" if no matching rules exist. Results are ordered DateTimeOnly first, then by priority highest first. | ||
| + | </WRAP> | ||
| ====Add a recording rule==== | ====Add a recording rule==== | ||
| + | <WRAP indent> | ||
| ^ Parameter ^ Type ^ Description ^ | ^ Parameter ^ Type ^ Description ^ | ||
| Line 47: | Line 52: | ||
| Returns: Details of all recording rules matching the given SeriesID including the newly created rule, or "null" if the request failed and no other matching rules exist. | Returns: Details of all recording rules matching the given SeriesID including the newly created rule, or "null" if the request failed and no other matching rules exist. | ||
| + | </WRAP> | ||
| ====Modify a recording rule==== | ====Modify a recording rule==== | ||
| + | <WRAP indent> | ||
| ^ Parameter ^ Type ^ Description ^ | ^ Parameter ^ Type ^ Description ^ | ||
| Line 66: | Line 73: | ||
| Returns: Details of all recording rules matching the given SeriesID after modification, or "null" if no matching rules exist. | Returns: Details of all recording rules matching the given SeriesID after modification, or "null" if no matching rules exist. | ||
| + | </WRAP> | ||
| ====Change the priority of a recording rule==== | ====Change the priority of a recording rule==== | ||
| + | <WRAP indent> | ||
| ^ Parameter ^ Type ^ Description ^ | ^ Parameter ^ Type ^ Description ^ | ||
| Line 78: | Line 87: | ||
| Returns: Details of the recording rule after modification, or "null" on failure. | Returns: Details of the recording rule after modification, or "null" on failure. | ||
| + | </WRAP> | ||
| ====Delete a recording rule==== | ====Delete a recording rule==== | ||
| + | <WRAP indent> | ||
| ^ Parameter ^ Type ^ Description ^ | ^ Parameter ^ Type ^ Description ^ | ||
| Line 102: | Line 113: | ||
| Returns: "null". | Returns: "null". | ||
| + | </WRAP> | ||
| ====Result format==== | ====Result format==== | ||
| + | <WRAP indent> | ||
| <code> | <code> | ||
| [ | [ | ||
| Line 125: | Line 138: | ||
| </code> | </code> | ||
| + | </WRAP> | ||
| ====Additional Details==== | ====Additional Details==== | ||
| + | <WRAP indent> | ||
| Specifying AfterOriginalAirdateOnly will restrict recordings to first-airings and shows with an original airdate greater than or equal to the given date. A first-airing will match regardless of the original airdate - this ensures shows without per-episode information are recorded. Repeats without a known original airdate are not recorded. | Specifying AfterOriginalAirdateOnly will restrict recordings to first-airings and shows with an original airdate greater than or equal to the given date. A first-airing will match regardless of the original airdate - this ensures shows without per-episode information are recorded. Repeats without a known original airdate are not recorded. | ||
| + | |||
| + | </WRAP> | ||