Web Service: Chaka

Target Namespace:
urn:chaka-0.9.5
Description:
KPNQwest Italia UMG SOAP interface (release 0.9.5)

Port Chaka Port typeSource code

Location:
http://soap.kqumg.it/chaka/beta/0.9.5/exec
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. browseDestinationsBySeqIdDetailSource code
  2. browseMessagesByDateDetailSource code
  3. checkDetailSource code
  4. sendMessageDetailSource code
  5. startDetailSource code
  6. storeDestinationListDetailSource code
  7. storeDocumentDetailSource code
  8. storeDocumentsDetailSource code

Operations

    Port type ChakaPortTypeSource code

    1. browseDestinationsBySeqId
      Description:
      selects a message and returns the status details of all destinations with 'seq-id' lying between 'first' and 'last' (inclusive); for convenience 'msg-summary' includes some useful details about the message.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      browseDestinationsBySeqId (SOAP:body, use = literal)Source code
      parameters type browseDestinationsBySeqId
      • auth - nillable; type token
      • msg-id type positiveInteger
      • first type positiveInteger
      • last type positiveInteger
      Output:
      browseDestinationsBySeqIdResponse (SOAP:body, use = literal)Source code
      parameters type browseDestinationsBySeqIdResponse
      • msg-summary type MessageDetail
        • msg-id type positiveInteger
        • subject - nillable; type string
        • created type dateTime
        • dest-count type positiveInteger
        • completed-dest-count - optional, nillable; type nonNegativeInteger
        • first-dest - optional, nillable; type DestinationDetail
          • seq-id - optional, nillable; type positiveInteger
          • address - nillable; type string
          • cc1 - optional, nillable; type string
          • cc2 - optional, nillable; type string
          • status - optional, nillable; type string
          • time - optional, nillable; type dateTime
          • pages - optional, nillable; type nonNegativeInteger
      • dest-list type MessageDestinationDetailList
        • last-seq-id - optional, nillable; type positiveInteger
        • first-seq-id - optional, nillable; type positiveInteger
        • msg-id type positiveInteger
        • dest - optional, unbounded; type DestinationDetail
          • seq-id - optional, nillable; type positiveInteger
          • address - nillable; type string
          • cc1 - optional, nillable; type string
          • cc2 - optional, nillable; type string
          • status - optional, nillable; type string
          • time - optional, nillable; type dateTime
          • pages - optional, nillable; type nonNegativeInteger
    2. browseMessagesByDate
      Description:
      returns a list of messages whose creation time lies between since and until (not including the upper end)
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      browseMessagesByDate (SOAP:body, use = literal)Source code
      parameters type browseMessagesByDate
      • auth - nillable; type token
      • since type dateTime
      • until type dateTime
      Output:
      browseMessagesByDateResponse (SOAP:body, use = literal)Source code
      parameters type browseMessagesByDateResponse
      • msg-list type MessageDetailList
        • oldest - optional, nillable; type dateTime
        • newest - optional, nillable; type dateTime
        • count type positiveInteger
        • msg - optional, unbounded; type MessageDetail
          • msg-id type positiveInteger
          • subject - nillable; type string
          • created type dateTime
          • dest-count type positiveInteger
          • completed-dest-count - optional, nillable; type nonNegativeInteger
          • first-dest - optional, nillable; type DestinationDetail
            • seq-id - optional, nillable; type positiveInteger
            • address - nillable; type string
            • cc1 - optional, nillable; type string
            • cc2 - optional, nillable; type string
            • status - optional, nillable; type string
            • time - optional, nillable; type dateTime
            • pages - optional, nillable; type nonNegativeInteger
    3. check
      Description:
      checks auth token and returns the expiration date
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      checkRequest (SOAP:body, use = literal)Source code
      parameters type check
      • auth - optional, nillable; type token
      Output:
      checkResponse (SOAP:body, use = literal)Source code
      parameters type checkResponse
      • expires type dateTime
    4. sendMessage
      Description:
      injects a message into the system and returns the relevant details, including the msg-id. Response attribute "cached-result" is true if a message with the same 'request-uid' has already been successfully processed, in which case the previous message's results are returned. ('scheduling' attribute and 'svc' values different than Standard are not supported as of version 0.9.2.)
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      sendMessage (SOAP:body, use = literal)Source code
      parameters type sendMessage
      • auth - nillable; type token
      • request-uid - nillable; type token
      • message - nillable; type Message
        • subject - nillable; type string
        • options - optional, nillable; type MessageOptions
          • flags - optional, nillable; type NMTOKENS
          • scheduling - optional; type dateTime
          • cost-center - optional, nillable; type string
          • bulksms type SMSMessage
              • destinations type DestinationList
                • item type Destination
                  • address - nillable; type string
                  • cc1 - optional, nillable; type string
                  • cc2 - optional, nillable; type string
                  • extra - optional, nillable; type DestinationExtraAttributes
                    • a0 - optional, nillable; type string
                    • a1 - optional, nillable; type string
                    • a2 - optional, nillable; type string
                    • a3 - optional, nillable; type string
                    • a4 - optional, nillable; type string
                    • a5 - optional, nillable; type string
                    • a6 - optional, nillable; type string
                    • a7 - optional, nillable; type string
                    • a8 - optional, nillable; type string
                    • a9 - optional, nillable; type string
              • destination-list-name - nillable; type string
            • short-msg - nillable; type string
          • sms type SMSMessage
              • destinations type DestinationList
                • item type Destination
                  • address - nillable; type string
                  • cc1 - optional, nillable; type string
                  • cc2 - optional, nillable; type string
                  • extra - optional, nillable; type DestinationExtraAttributes
                    • a0 - optional, nillable; type string
                    • a1 - optional, nillable; type string
                    • a2 - optional, nillable; type string
                    • a3 - optional, nillable; type string
                    • a4 - optional, nillable; type string
                    • a5 - optional, nillable; type string
                    • a6 - optional, nillable; type string
                    • a7 - optional, nillable; type string
                    • a8 - optional, nillable; type string
                    • a9 - optional, nillable; type string
              • destination-list-name - nillable; type string
            • short-msg - nillable; type string
          • fax type FAXMessage
              • destinations type DestinationList
                • item type Destination
                  • address - nillable; type string
                  • cc1 - optional, nillable; type string
                  • cc2 - optional, nillable; type string
                  • extra - optional, nillable; type DestinationExtraAttributes
                    • a0 - optional, nillable; type string
                    • a1 - optional, nillable; type string
                    • a2 - optional, nillable; type string
                    • a3 - optional, nillable; type string
                    • a4 - optional, nillable; type string
                    • a5 - optional, nillable; type string
                    • a6 - optional, nillable; type string
                    • a7 - optional, nillable; type string
                    • a8 - optional, nillable; type string
                    • a9 - optional, nillable; type string
              • destination-list-name - nillable; type string
            • documents type DocumentList
              • item - optional, unbounded; type DocumentChoiceElement
                • document type Document
                  • data - nillable; type base64Binary
                  • unique-name - nillable; type string
                  • content-type - optional, nillable; type string
                • document-ref type DocumentRef
                  • unique-name - nillable; type string
          • faxmsmerge type FAXMSMergeMessage
              • destinations type DestinationList
                • item type Destination
                  • address - nillable; type string
                  • cc1 - optional, nillable; type string
                  • cc2 - optional, nillable; type string
                  • extra - optional, nillable; type DestinationExtraAttributes
                    • a0 - optional, nillable; type string
                    • a1 - optional, nillable; type string
                    • a2 - optional, nillable; type string
                    • a3 - optional, nillable; type string
                    • a4 - optional, nillable; type string
                    • a5 - optional, nillable; type string
                    • a6 - optional, nillable; type string
                    • a7 - optional, nillable; type string
                    • a8 - optional, nillable; type string
                    • a9 - optional, nillable; type string
              • destination-list-name - nillable; type string
            • msword-doc type DocumentChoiceElement
              • document type Document
                • data - nillable; type base64Binary
                • unique-name - nillable; type string
                • content-type - optional, nillable; type string
              • document-ref type DocumentRef
                • unique-name - nillable; type string
          • umail type UMailMessage
              • destinations type DestinationList
                • item type Destination
                  • address - nillable; type string
                  • cc1 - optional, nillable; type string
                  • cc2 - optional, nillable; type string
                  • extra - optional, nillable; type DestinationExtraAttributes
                    • a0 - optional, nillable; type string
                    • a1 - optional, nillable; type string
                    • a2 - optional, nillable; type string
                    • a3 - optional, nillable; type string
                    • a4 - optional, nillable; type string
                    • a5 - optional, nillable; type string
                    • a6 - optional, nillable; type string
                    • a7 - optional, nillable; type string
                    • a8 - optional, nillable; type string
                    • a9 - optional, nillable; type string
              • destination-list-name - nillable; type string
            • documents type DocumentList
              • item - optional, unbounded; type DocumentChoiceElement
                • document type Document
                  • data - nillable; type base64Binary
                  • unique-name - nillable; type string
                  • content-type - optional, nillable; type string
                • document-ref type DocumentRef
                  • unique-name - nillable; type string
            • options type UMailMessageOptions
              • embed-files - optional; type boolean
              • from-name - nillable; type string
              • from-email - optional, nillable; type string
              • subject - optional, nillable; type string
              • no-receipt-request - optional; type boolean
      Output:
      sendMessageResponse (SOAP:body, use = literal)Source code
      parameters type sendMessageResponse
      • result type sendMessageResult
        • request-uid - nillable; type token
        • cached-result type boolean
        • info type SentMessageInfo
          • msg-id type positiveInteger
          • destination-count type positiveInteger
          • rejected-destination-count type nonNegativeInteger
    5. start
      Description:
      validates username/password and returns an 'auth' token to be used in all subsequent calls
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      startRequest (SOAP:body, use = literal)Source code
      parameters type start
      • userid - nillable; type string
      • password - nillable; type string
      • options - nillable; type UserOptions
        • contact-person - nillable; type anyURI
        • soap-callback - optional, nillable; type anyURI
        • max-browse-block100-count - optional, nillable; type positiveInteger
        • max-remote-operation-time - optional, nillable; type positiveInteger
        • max-method-completion-time - optional, nillable; type positiveInteger
      Output:
      startResponse (SOAP:body, use = literal)Source code
      parameters type startResponse
      • auth type token
    6. storeDestinationList
      Description:
      Service definition of function m1__storeDestinationList
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      storeDestinationList (SOAP:body, use = literal)Source code
      parameters type storeDestinationList
      • auth - nillable; type token
      • list - nillable; type StorableDestinationList
        • unique-name - nillable; type string
          • table type DestinationTable
            • address-column - optional, nillable; type string
            • cc1-column - optional, nillable; type string
            • cc2-column - optional, nillable; type string
            • columns - optional, nillable; type NMTOKENS
            • format type DestinationTableFormat - type string with restriction - enum { 'semicolon-csv', 'comma-csv', 'tab-csv', 'json-array' }
            • data - nillable; type base64Binary
            • expected-count - optional, nillable; type int
          • list type DestinationList
            • item type Destination
              • address - nillable; type string
              • cc1 - optional, nillable; type string
              • cc2 - optional, nillable; type string
              • extra - optional, nillable; type DestinationExtraAttributes
                • a0 - optional, nillable; type string
                • a1 - optional, nillable; type string
                • a2 - optional, nillable; type string
                • a3 - optional, nillable; type string
                • a4 - optional, nillable; type string
                • a5 - optional, nillable; type string
                • a6 - optional, nillable; type string
                • a7 - optional, nillable; type string
                • a8 - optional, nillable; type string
                • a9 - optional, nillable; type string
      Output:
      storeDestinationListResponse (SOAP:body, use = literal)Source code
      parameters type storeDestinationListResponse
      • name - optional, nillable; type string
      • count type positiveInteger
    7. storeDocument
      Description:
      uploads and stores a document (which can be later referred to through a 'document-ref' element; see sendMessage documentation). If a 'remote-document' is specified, the service will try to fetch it and store it locally (only "http" scheme is supported as of version 0.9.2). 'unique-name' will uniquely identify the document within the user's space.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      storeDocument (SOAP:body, use = literal)Source code
      parameters type storeDocument
      • auth - nillable; type token
      • source - nillable; type DocumentSource
        • document type Document
          • data - nillable; type base64Binary
          • unique-name - nillable; type string
          • content-type - optional, nillable; type string
        • remote-document type RemoteDocument
          • location - nillable; type anyURI
          • unique-name - nillable; type string
      Output:
      storeDocumentResponse (SOAP:body, use = literal)Source code
      parameters type storeDocumentResponse
      • stored type storeDocumentResult
        • name - optional, nillable; type string
        • md5 - optional, nillable; type string
        • size type positiveInteger
    8. storeDocuments
      Description:
      similar to storeDocument; accepts multiple documents and returns a list of file details if all operations are successful
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      storeDocuments (SOAP:body, use = literal)Source code
      parameters type storeDocuments
      • auth - nillable; type token
      • sources - nillable; type DocumentSources
        • source - optional, unbounded; type DocumentSource
          • document type Document
            • data - nillable; type base64Binary
            • unique-name - nillable; type string
            • content-type - optional, nillable; type string
          • remote-document type RemoteDocument
            • location - nillable; type anyURI
            • unique-name - nillable; type string
      Output:
      storeDocumentsResponse (SOAP:body, use = literal)Source code
      parameters type storeDocumentsResponse
      • stored-list type storeDocumentsResult
        • stored - optional, unbounded; type storeDocumentResult
          • name - optional, nillable; type string
          • md5 - optional, nillable; type string
          • size type positiveInteger

WSDL source code

<?xml version="1.0"?>
<definitions name="Chaka" targetNamespace="urn:chaka-0.9.5"
xmlns:tns="urn:chaka-0.9.5"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:MIME="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:WSDL="http://schemas.xmlsoap.org/wsdl/"
xmlns:DIME="http://schemas.xmlsoap.org/ws/2002/04/dime/wsdl/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:m1="urn:chaka-0.9.5"
xmlns:m2="urn:chaka-callback-0.9.5"
>
<types>
<schema targetNamespace="urn:chaka-0.9.5" elementFormDefault="qualified" attributeFormDefault="unqualified">
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
<!-- operation request element -->
<!-- operation response element -->
</schema>
</types>
<portType name="ChakaPortType">
<operation name="start">
<documentation>validates username/password and returns an 'auth' token to be used in all subsequent calls </documentation>
</operation>
<operation name="check">
<documentation>checks auth token and returns the expiration date</documentation>
</operation>
<operation name="storeDocument">
<documentation>uploads and stores a document (which can be later referred to through a 'document-ref' element; see sendMessage documentation). If a 'remote-document' is specified, the service will try to fetch it and store it locally (only "http" scheme is supported as of version 0.9.2). 'unique-name' will uniquely identify the document within the user's space.</documentation>
</operation>
<operation name="storeDocuments">
<documentation>similar to storeDocument; accepts multiple documents and returns a list of file details if all operations are successful</documentation>
</operation>
<operation name="sendMessage">
<documentation>injects a message into the system and returns the relevant details, including the msg-id. Response attribute "cached-result" is true if a message with the same 'request-uid' has already been successfully processed, in which case the previous message's results are returned. ('scheduling' attribute and 'svc' values different than Standard are not supported as of version 0.9.2.)</documentation>
</operation>
<operation name="browseMessagesByDate">
<documentation>returns a list of messages whose creation time lies between since and until (not including the upper end)</documentation>
</operation>
<operation name="browseDestinationsBySeqId">
<documentation>selects a message and returns the status details of all destinations with 'seq-id' lying between 'first' and 'last' (inclusive); for convenience 'msg-summary' includes some useful details about the message.</documentation>
</operation>
</portType>
<binding name="Chaka" type="tns:ChakaPortType"></binding>
</definitions>

About wsdl-viewer.xsl

This document was generated by SAXON 9.1.0.7 from Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.
This page has been generated by wsdl-viewer.xsl, version 3.1.01
Author: tomi vanek
Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT