Schema documentation for component GetChannels

Namespace

http://4psa.com/ChannelMessages.xsd/5.2.5

Annotations

Get channels: request

Diagram

Properties

content:

complex

Model

groupID{0,1} , enabled{0,1} , flow{0,1} , filter{0,1}

Children

enabled, filter, flow, groupID

Instance

<GetChannels xmlns="http://4psa.com/ChannelMessages.xsd/5.2.5" xmlns:channelData="http://4psa.com/ChannelData.xsd/5.2.5" xmlns:common="http://4psa.com/Common.xsd/5.2.5">
  <groupID>{0,1}</groupID>
  <enabled>{0,1}</enabled>
  <channelData:flow>{0,1}</channelData:flow>
  <common:filter>{0,1}</common:filter>
</GetChannels>

Source

<xs:element name="GetChannels">
  <xs:annotation>
    <xs:documentation>Get channels: request</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence minOccurs="0">
      <xs:element name="groupID" type="common:positiveInteger" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Channel group ID</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="enabled" type="common:boolean" default="1" minOccurs="0">
        <xs:annotation>
          <xs:documentation>1: only enabled channels, 2: disabled channels, 0: all
							channels. Default: all</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="channelData:flow" minOccurs="0"/>
      <xs:element ref="common:filter" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Filter channels list by name, login, hostname or channel
							group name.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

Showing: