/channels

  • Mount Point: /resource/rest/channels

The following operations are supported on this resource:

GET

  • Aliases: POST

Get a list of channels for a region. Returns all channels who's region_pk matches regionId. Only limited set of fields are returned. Fordetailed output #getChannel(String, Integer, String, String) should be used.Note: this API might use caching configured in web.xml.

Parameters

name description type default
regionId Id of a region to retrieve channels for. This is required parameter. It should be not null. query
start 0..N - start offset for returned documents. Default value is 0. query 0
count 1..N - number of documents to return. By default, return all documents. query
filters Optional filters for channel fields. All channel fields are available for filtering. query
formatCode Code of format in which result should be shown. query

Output Payload

element produceable content type(s)
(custom)
  • */*
  • application/xml
description
Return list of channels.

Exceptions

name description
RESTWebserviceException if exception occurs.