Client 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:

  • Platform types

This document describes the API for creating, reading, updating and deleting platform_types.

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

Url:

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

Returns a list of platform_types.

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 URL returns a listing of all platform_types.
[GET] https://service_name.synctv.com/api/v2/platform_types.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Integer) offset — Used for pagination of response data (default: 25 items per response). Specifies the offset of the next block of data to receive.
Example Response
XML JSON

<response>
  <platform_types>
    <platform_type>
      <id>1</id>
      <name>platform_type_1</name>
    </platform_type>
    <platform_type>
      <id>2</id>
      <name>platform_type_2</name>
    </platform_type>
  </platform_types>
</response>
Response Fields:
  • (Integer) platform_type[id]
    Unique identifier of the platform_type.
  • (String) platform_type[name]
    Name of the platform_type.

Url:

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

Returns information for the specified platform_type.

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 URL returns the platform_type information with id == 100 
[GET] https://service_name.synctv.com/api/v2/platform_types/100.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <platform_type>
    <id>100</id>
    <name>platform_type_3</name>
  </platform_type>
</response>
Response Fields:
  • (Integer) platform_type[id]
    Unique identifier of the platform_type.
  • (String) platform_type[name]
    Name of the platform_type.