SelectChannels
Searches channels for specified information.
To search a single channel, specify Name or Id. To search a list of channels, specify NameList or IdList. To search channels matching the specified conditions, specify Search.
Request schema
<xsd:complexType name="SelectChannels">
<xsd:sequence>
<xsd:element name="ResultDef" type="typens:ArrayOfString"/>
<xsd:choice>
<xsd:element name="Search"
type="typens:ChannelSearch"/>
<xsd:element name="NameList"
type="typens:ArrayOfString"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="Id" type="xsd:string"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
ResultDef
The properties to retrieve.
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray.
NameList
The list of channel names to search. Specify either NameList or IdList.
IdList
The list of channel IDs to search. Specify either IdList or NameList.
Name
The name of a single channel to search. Specify either Name or Id.
Id
The ID of the single channel to search. Specify either Id or Name.
Response schema
<xsd:complexType name="SelectChannelsResponse">
<xsd:sequence>
<xsd:element name="Channels" type="typens:ArrayOfChannel"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:long"\
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
Channels
The selected channels.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set.