Report Operations

This section documents the API operations for Report service.

CallReport

CallReport

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: Get the call report: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
reportData:interval	reportData:interval (optional)
flow	inline (optional)	Call flow: in, out.
type	inline (optional)	Call type: local, elocal, out.
disposition	inline (optional)	Call disposition: ANSWERED, BUSY, FAILED, NO ANSWER, UNKNOWN, NOT ALLOWED.
records	common:integer (optional)	Number of records to be returned. Maximum: 1,000.
hangupCause	common:integer (optional)	Filter report by hangup cause
networkCode	common:string (optional)	Filter report by network code
(choice)		Either of
└ reportData:userID	reportData:userID
└ reportData:userIdentifier	reportData:userIdentifier
└ reportData:login	reportData:login

XSD Source

<xs:element name="CallReport">
  <xs:annotation>
    <xs:documentation>Get the call report: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="reportData:interval" type="reportData:interval" minOccurs="0"/>
        <xs:element name="flow" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Call flow: in, out.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="type" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Call type: local, elocal, out.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="disposition" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Call disposition: ANSWERED, BUSY, FAILED, NO ANSWER, UNKNOWN, NOT ALLOWED.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="records" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Number of records to be returned. Maximum: 1,000.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="hangupCause" type="common:integer" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter report by hangup cause</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="networkCode" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter report by network code</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="reportData:userID" type="reportData:userID" minOccurs="0"/>
          <xs:element name="reportData:userIdentifier" type="reportData:userIdentifier" minOccurs="0"/>
          <xs:element name="reportData:login" type="reportData:login" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

CallReportResponse

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: Get the call report: response

Properties

Property	Value
content	complex

Extends

Base type: reportData:CallReport

Elements

Element	Type	Description
common:notice	common:notice (0..*)

XSD Source

<xs:element name="CallReportResponse">
  <xs:annotation>
    <xs:documentation>Get the call report: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="reportData:CallReport">
          <xs:sequence>
            <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

CallCosts

CallCosts

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: Get the call costs report: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
prepareDelete	common:boolean (optional)	Set flag to mark client in state: ireversable suspension
(choice)		One of the following
└ reportData:userID	reportData:userID
└ reportData:userIdentifier	reportData:userIdentifier

XSD Source

<xs:element name="CallCosts">
  <xs:annotation>
    <xs:documentation>Get the call costs report: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="prepareDelete" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Set flag to mark client in state: ireversable suspension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="reportData:userID" type="reportData:userID" minOccurs="0"/>
          <xs:element name="reportData:userIdentifier" type="reportData:userIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

CallCostsResponse

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: Get the call costs report: response

Properties

Property	Value
content	complex

Extends

Base type: reportData:CallCostInfo

Elements

Element	Type	Description
common:notice	common:notice (0..*)

XSD Source

<xs:element name="CallCostsResponse">
  <xs:annotation>
    <xs:documentation>Get the call costs report: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="reportData:CallCostInfo">
          <xs:sequence>
            <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---

QuickStats

QuickStats

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: System statistics: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
common:scope	common:scope (optional)
(choice)		One of the following
└ reportData:userID	reportData:userID
└ reportData:userIdentifier	reportData:userIdentifier
└ reportData:login	reportData:login

XSD Source

<xs:element name="QuickStats">
  <xs:annotation>
    <xs:documentation>System statistics: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
        <xs:choice>
          <xs:element name="reportData:userID" type="reportData:userID" minOccurs="0"/>
          <xs:element name="reportData:userIdentifier" type="reportData:userIdentifier" minOccurs="0"/>
          <xs:element name="reportData:login" type="reportData:login" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

QuickStatsResponse

Namespace: http://4psa.com/ReportMessages.xsd/5.2.5

Description: System statistics: response

Properties

Property	Value
content	complex

Extends

Base type: reportData:QuickStats

Elements

Element	Type	Description
common:notice	common:notice (0..*)

XSD Source

<xs:element name="QuickStatsResponse">
  <xs:annotation>
    <xs:documentation>System statistics: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="reportData:QuickStats">
          <xs:sequence>
            <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

---