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:

  • Tree

This document describes the API for reading container info in a placement specific manner.

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/containers/roots.[xml|json]

Returns a list of all root containers.

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 a list of all root containers.
[GET] https://service_name.synctv.com/api/v2/containers/roots.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — The unique identifier attribute of the container.
  • (String) name — Name attribute of the container.
  • (String) order_number — Order number of the container.
  • (String) ownerships_count — Count of ownership of the container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <containers>
    <container>
      <id>1</id>
      <name>Container-12</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:44Z</created_at>
      <updated_at>2014-05-01T21:31:44Z</updated_at>
      <images/>
      <external_id>557F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
    <container>
      <id>3</id>
      <name>Container-14</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:44Z</created_at>
      <updated_at>2014-05-01T21:31:44Z</updated_at>
      <images/>
      <external_id>657F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
  </containers>
</response>
Response Fields:
  • (String) container[id]
    The unique identifier of the container.
  • (String) container[name]
    The name of container.
  • (String) container[description]
    The description of container.
  • (Integer) container[parent_id]
    The unique identifier of the parent container.
  • (Integer) container[order_number]
    The order number. Containers will be ordered depending on value.
  • (Boolean) container[active]
    Determinate for whether the container is active or inactive.
  • (Boolean) container[leaf]
    Determinate for whether the container is a leaf or branch in the containers tree.
  • (Integer) container[container_type][id]
    The id of the container_type for the container.
  • (String) container[container_type][name]
    The name of the container_type for the container.
  • (Integer) container[meta_data_attributes][][id]
    The id of the meta data to update.
  • (String) container[meta_data_attributes][][key]
    The meta data key value.
  • (String) container[meta_data_attributes][][value]
    The meta data value value.
  • (DateTime) container[created_at]
    The date of when the container was first created.
  • (DateTime) container[updated_at]
    The date of when the container was last updated.
  • (String) container[external_id]
    The external ID value for the container.
  • (DateTime) container[published_at]
    The date of when the container was published.

Url:

  • [GET] /api/v2/containers/roots/count.[xml|json]

Returns a count of all root containers.

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 a count of all root containers.
[GET] https://service_name.synctv.com/api/v2/containers/roots.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <count>25</count>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>

Url:

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

Returns a list of the specified container's ancestors.

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 a list of container one's ancestors.
[GET] https://service_name.synctv.com/api/v2/containers/1/ancestors.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of the container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <containers>
    <container>
      <id>1</id>
      <name>Container-16</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:49Z</created_at>
      <updated_at>2014-05-01T21:31:49Z</updated_at>
      <images/>
      <external_id>757F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
    <container>
      <id>3</id>
      <name>Container-18</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:49Z</created_at>
      <updated_at>2014-05-01T21:31:49Z</updated_at>
      <images/>
      <external_id>857F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
  </containers>
</response>
Response Fields:
  • (String) container[id]
    The id of the container.
  • (String) container[name]
    The name of container.
  • (String) container[description]
    The description of container.
  • (Integer) container[parent_id]
    The unique identifier of the parent container.
  • (Integer) container[order_number]
    The order number. Containers will be ordered depending on value.
  • (Boolean) container[active]
    Determinate for whether the container is active or inactive.
  • (Boolean) container[leaf]
    Determinate for whether the container is a leaf or branch in containers tree.
  • (Integer) container[container_type][id]
    The id of the container_type for the container.
  • (String) container[container_type][name]
    The name of the container_type for the container.
  • (Integer) container[meta_data_attributes][][id]
    The id of the meta data to update.
  • (String) container[meta_data_attributes][][key]
    The meta data key value.
  • (String) container[meta_data_attributes][][value]
    The meta data value value.
  • (DateTime) container[created_at]
    The date of when the container was first created.
  • (DateTime) container[updated_at]
    The date of when the container was last updated.
  • (String) container[external_id]
    The external ID value for the container.
  • (DateTime) container[published_at]
    The date of when the container was published.

Url:

  • [GET] /api/v2/containers/:id/ancestors/count.[xml|json]

Returns a count of the specified container's ancestors.

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 a count of container one's ancestors.
[GET] https://service_name.synctv.com/api/v2/containers/1/ancestors/count.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <count>25</count>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>

Url:

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

Returns a list of the specified container's siblings.

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 a list of container one's siblings.
[GET] https://service_name.synctv.com/api/v2/containers/1/siblings.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <containers>
    <container>
      <id>1</id>
      <name>Container-20</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:53Z</created_at>
      <updated_at>2014-05-01T21:31:53Z</updated_at>
      <images/>
      <external_id>957F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
    <container>
      <id>3</id>
      <name>Container-22</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:53Z</created_at>
      <updated_at>2014-05-01T21:31:53Z</updated_at>
      <images/>
      <external_id>1057F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
  </containers>
</response>
Response Fields:
  • (String) container[id]
    The id of the container.
  • (String) container[name]
    The name of container.
  • (String) container[description]
    The description of container.
  • (Integer) container[parent_id]
    The unique identifier of the parent container.
  • (Integer) container[order_number]
    The order number. Containers will be ordered depending on value.
  • (Boolean) container[active]
    Determinate for whether the container is active or inactive.
  • (Boolean) container[leaf]
    Determinate for whether the container is a leaf or branch in containers tree.
  • (Integer) container[container_type][id]
    The id of the container_type for the container.
  • (String) container[container_type][name]
    The name of the container_type for the container.
  • (Integer) container[meta_data_attributes][][id]
    The id of the meta data to update.
  • (String) container[meta_data_attributes][][key]
    The meta data key value.
  • (String) container[meta_data_attributes][][value]
    The meta data value value.
  • (DateTime) container[created_at]
    The date of when the container was first created.
  • (DateTime) container[updated_at]
    The date of when the container was last updated.
  • (String) container[external_id]
    The external ID value for the container.
  • (DateTime) container[published_at]
    The date of when the container was published.

Url:

  • [GET] /api/v2/containers/:id/siblings/count.[xml|json]

Returns a count of the specified container's siblings.

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 a count of container one's siblings.
[GET] https://service_name.synctv.com/api/v2/containers/1/siblings/count.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <count>25</count>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>

Url:

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

Returns a list of the specified container's descendants.

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 a list of container one's descendants.
[GET] https://service_name.synctv.com/api/v2/containers/1/descendants.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <containers>
    <container>
      <id>1</id>
      <name>Container-24</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:58Z</created_at>
      <updated_at>2014-05-01T21:31:58Z</updated_at>
      <images/>
      <external_id>1157F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
    <container>
      <id>3</id>
      <name>Container-26</name>
      <description nil="true"/>
      <parent_id nil="true"/>
      <order_number>0</order_number>
      <active>true</active>
      <leaf>true</leaf>
      <container_type nil="true"/>
      <media_ids/>
      <meta_data/>
      <created_at>2014-05-01T21:31:58Z</created_at>
      <updated_at>2014-05-01T21:31:58Z</updated_at>
      <images/>
      <external_id>1257F34B</external_id>
      <published_at>2012-02-03T03:18:32Z</published_at>
      <container_group_id nil="true"/>
      <bundle_ids/>
      <avg_rating>0.0</avg_rating>
      <properties>
      </properties>
    </container>
  </containers>
</response>
Response Fields:
  • (String) container[id]
    The id of the container.
  • (String) container[name]
    The name of container.
  • (String) container[description]
    The description of container.
  • (Integer) container[parent_id]
    The unique identifier of the parent container.
  • (Integer) container[order_number]
    The order number. Containers will be ordered depending on value.
  • (Boolean) container[active]
    Determinate for whether the container is active or inactive.
  • (Boolean) container[leaf]
    Determinate for whether the container is a leaf or branch in containers tree.
  • (Integer) container[container_type][id]
    The id of the container_type for the container.
  • (String) container[container_type][name]
    The name of the container_type for the container.
  • (Integer) container[meta_data_attributes][][id]
    The id of the meta data to update
  • (String) container[meta_data_attributes][][key]
    The meta data key value.
  • (String) container[meta_data_attributes][][value]
    The meta data value value.
  • (DateTime) container[created_at]
    The date of when the container was first created.
  • (DateTime) container[updated_at]
    The date of when the container was last updated.
  • (String) container[external_id]
    The external ID value for the container.
  • (DateTime) container[published_at]
    The date of when the container was published.

Url:

  • [GET] /api/v2/containers/:id/descendants/count.[xml|json]

Returns a count of the specified container's descendants.

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 a count of container one's descendants.
[GET] https://service_name.synctv.com/api/v2/containers/1/descendants/count.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Boolean) active — Filters response by active state (e.g. active=true).
  • (String) sort_order — Defines the sort order of the response (e.g. sort_order=order_number).
  • (String) id — Id attribute of container.
  • (String) name — Name attribute of container.
  • (String) order_number — Order number of container.
  • (String) ownerships_count — Count of ownership for container.
  • (String) created_at — Timestamp when container was first created.
  • (String) published_at — Timestamp when container was first published.
  • (String) published_max — Timestamp criteria of when container was published.
  • (String) published_min — Timestamp criteria of when container was published.
  • (String) available_max — Timestamp criteria of when container was available.
  • (String) available_min — Timestamp criteria of when container was available.
  • (String) external_id — Filters response based on value of external_id field.
  • (String) type_id — Filters response based on given set of type_ids (e.g. type_id[]=1&type_id[]=2)
  • (String) key — Filters response based on the meta_data key.
  • (String) value — Filters response based on the meta_data value.
Example Response
XML JSON

<response>
  <count>25</count>
  <code>1</code>
  <messages>
    <message>Successfully completed.</message>
  </messages>
</response>