REST API

From ARGUS TV Wiki
Jump to: navigation, search


Contents

About REST API

ARGUS TV has an extensive REST API which you can access over HTTP or HTTPS.

  • Use port 49941 for HTTPS
  • Use port 49943 for HTTP

HTTP does not require authentication (only suited for your local LAN), whereas HTTPS does (so it can be opened up to the outside world through your router). You configure the credentials required at ARGUS TV installation time, or alternatively they can be changed in %PROGRAMFILES%\ARGUS TV\Scheduler\ArgusTV.Scheduler.exe.config


Endpoints

There is built-in documentation which describes each endpoint.

They are broken into six categories, which can be found at the addresses below (assuming your ARGUS TV server is at htpc.local)


Return Format

The API can return data in either JSON (the default) or XML. You choose which you want by sending the appropriate Content-type header in your request.

   Content-type: application/json


Examples

Get the ARGUS TV Server Version using curl

   curl --insecure -u user:password -d '' https://htpc.local:49941/ArgusTV/Core/Version

This should return a simple string (this endpoint doesn't actually return any JSON data).

  • --insecure means "don't complain about the self-signed SSL certificate ARGUS TV uses
  • -u user:password should be self-explanatory
  • -d normally contains POST data to send. For this endpoint, there is no POST data, but we still specify it to force the request into POST (all ARGUS TV REST API endpoints require POST requests).


Common Issues

Date Format

The date format expected by most of the endpoints in JSON is:

   /Date(xxxxx+0000)/

Here, xxxxx is the number of milliseconds in the GMT time zone, regular (non-daylight savings) time since midnight, January 1, 1970.

The +0000 part is the timezone offset and is really only there for informational purposes (since the number of milliseconds is always in the GMT timezone).

The date format on URLs is a more basic format and can be one of the following: "yyyy-MM-ddTHH:mm:sszzz", "yyyy-MM-ddTHH:mm:ss", "yyyyMMddTHHmmss", "yyyyMMdd" or "yyyy-MM-dd".


Download & Support

ICN WEB.PNG

Support: see ARGUS TV Forum's thread ICN FORUM INLINE.PNG ARGUS TV REST API

Namespaces

Variants
Actions
Navigation
Toolbox