Schema documentation for component GetPublicNo

Namespace

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

Annotations

Get public phone numbers: request

Diagram

Properties

content:

complex

Model

channelID , inUse{0,1} , type{0,1} , filter{0,1} , (userID{0,1} | userIdentifier{0,1} | extendedNumber{0,1})

Children

channelID, extendedNumber, filter, inUse, type, userID, userIdentifier

Instance

<GetPublicNo 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">
  <channelData:channelID>{1,1}</channelData:channelID>
  <inUse>{0,1}</inUse>
  <type>{0,1}</type>
  <common:filter>{0,1}</common:filter>
  <common:userID>{0,1}</common:userID>
  <common:userIdentifier>{0,1}</common:userIdentifier>
  <common:extendedNumber>{0,1}</common:extendedNumber>
</GetPublicNo>

Source

<xs:element name="GetPublicNo">
  <xs:annotation>
    <xs:documentation>Get public phone numbers: request</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="channelData:channelID"/>
      <xs:element name="inUse" type="common:boolean" default="0" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Usage filter. For unset numbers: 1</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="type" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Assignation method: 'stacked' or
							'exclusive'.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="exclusive"/>
            <xs:enumeration value="stacked"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element ref="common:filter" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Filter public number list by external number, DID or
							callback extension</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:choice minOccurs="0">
        <xs:element ref="common:userID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Client that uses the public phone
								number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element ref="common:userIdentifier" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Client (identifier) that uses the public phone
								number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" ref="common:extendedNumber"/>
      </xs:choice>
    </xs:sequence>
  </xs:complexType>
</xs:element>

Showing: