Start Encode (REST)

Overview

The REST Web Service, located at /xml/start_encode, is used to start a 24-hour encode on the server. It returns if the encode successfully started, if the server was already encoding, or if the encode failed to start.

NOTE: API Authorization Required!

Request URL

http://myserver/xml/start_encode?api_key=[api_key]

NOTE: JSON response is also available by accessing xml/start_encode.json

Return

Success

A successful return is in this format:

< ?xml version="1.0" encoding="utf-8" ?>
 
  started

The following is the result of attempting to start an encode while the server is already encoding:

< ?xml version="1.0" encoding="utf-8" ?>
 
  encoding

Failure

An unsuccessful return is in this format:

< ?xml version="1.0" encoding="utf-8" ?>
 
  failed

The following is typically the result of an invalid API Key:

< ?xml version="1.0" encoding="utf-8" ?>
 
  Access Denied

History

Introduced
Princeton Server 3.16.0
Facebooktwittergoogle_pluslinkedin