Admin APIs
At its core, SyncTV is an API driven service. The APIs themselves are easy enough for developers to understand, but understanding the ecosystem is a little trickier. We've created the following tutorials to help you get your head around it.

Topics:

  • Exceptions

This document describes the API for reading the exceptions list.

Note:
Each call to the SyncTV V2 API described in this section requires an MD5 hash signature.
See the Authorization (User) API for details on generating the MD5 hash signature.
Actions

Url:

  • [GET] /api/v2/exceptions.[xml|json]

Returns a list of all API exceptions.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

[GET] https://service_name.synctv.com/api/v2/exceptions.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <exceptions>
    <exception>
      <id>0</id>
      <name>Api::Exception::Unknown</name>
    </exception>
    <exception>
      <id>1</id>
      <name>Api::Exception::ArgumentMissing</name>
    </exception>
    <exception>
      <id>2</id>
      <name>Api::Exception::ValidationError</name>
    </exception>
    <exception>
      <id>3</id>
      <name>Api::Exception::RecordNotFound</name>
    </exception>
    <exception>
      <id>4</id>
      <name>Api::Exception::AuthorizationError</name>
    </exception>
    <exception>
      <id>5</id>
      <name>Api::Exception::SamlError</name>
    </exception>
    <exception>
      <id>6</id>
      <name>Api::Exception::ArgumentUnsupported</name>
    </exception>
    <exception>
      <id>7</id>
      <name>Api::Exception::OwnershipInvalid</name>
    </exception>
    <exception>
      <id>8</id>
      <name>Api::Exception::InvoiceInvalid</name>
    </exception>
    <exception>
      <id>9</id>
      <name>Api::Exception::InvalidUtf8</name>
    </exception>
    <exception>
      <id>10</id>
      <name>Api::Exception::ArgumentInvalid</name>
    </exception>
    <exception>
      <id>11</id>
      <name>Api::Exception::InvalidRegion</name>
    </exception>
    <exception>
      <id>12</id>
      <name>Api::Exception::DeletionError</name>
    </exception>
    <exception>
      <id>13</id>
      <name>Api::Exception::ServiceUnavailable</name>
    </exception>
  </exceptions>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>

Url:

  • [GET] /api/v2/exceptions/:id.[xml|json]

Returns the specified API exception code and message.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

The following example returns the exception information. 
[GET] https://service_name.synctv.com/api/v2/exceptions/5.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <code>-6</code>
  <messages>
    <message>SAML error.</message>
  </messages>
</response>
Response Fields:
  • (Integer) code
    Contains the API code for this particular exception.
  • (String) message
    Contains the message response for this particular exception.