Web Service: TTPServicesV1

Target Namespace:
http://www.thetradingportal.com/api/soap/v1/ttp
Description:
Provides programmatic access to The Trading Portal's business-to-business electronic document interchange system.

Port TTPServicesV1Port Port typeSource code

Location:
https://www.thetradingportal.net/api/soap/v1/ttpservices.php
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:

Operations

    Port type TTPServicesV1PortTypeSource code

    1. actionItem
      Description:
      Performs actions on items and forwarded items (via their carrier item). The action types are: Forward, Update, Approve, Reject, Complete, and Close. Forward: Forwards an item or carrier to another user within the same company. The desired carrier can be provided in the carrierPayload element. Otherwise, the carrierPayload element should be omitted, and a default carrier will be generated for forwarding items or the existing carrier is used for forwarding carriers. When forwarding an item, the carrier is sent to the receiving user and the original is moved to the sending user's Archive system folder. When forwarding a forwarded item's carrier, the carrier is sent to the recipient user and the carrier is removed from the forwarding user's folder. The actionDescription element is used to specify the reason for forwarding the document and will be inserted into the carrier's change history. Any field change history that needs to be recorded for a forward action can be specified in actionField elements (one for each field, or none if not required). If no carrier is provided, the initialization and updating of the Owner field is automatically recorded in the carrier's change history. The recipient of the carrier automatically owns the carrier item (but not the original item), and this behaviour cannot be overridden by specifying another owner in the Addressing element of the carrier item. Update: Updates a forwarded item's carrier with the ability to append field changes to the change history log. The carrierPayload is required and should contain the updated carrier. Changes to the item type, addressing, id, and referenced original document are not supported and will result in a fault. As with the Forward action, the actionDescription element specifies the description of the action in the change history and any field changes can be specifed in zero or more actionField elements. The actionRecipientUserId element is not used by this action and may be omitted. Approve/Reject: Approves or Rejects a forwarded item's carrier with the ability to append changed fields to the carrier's change history. The carrierPayload element is optional and can contain an updated carrier or may be omitted. As with the Update action, changes to item metadata such as type, addressing, id, and referenced original item are not supported and will result in a fault. If no carrier is provided, the existing carrier's CarrierOwnerName and CarrierStatus document fields will be updated to the recipient's name and Approved/Rejected respectively, if they exist (default autogenerated carrier's will contain them) and field change history will be appended automatically to reflect the change. The carrier will be forwarded to the user specified in the actionRecipientUserId element and ownership transferred to them. The carrier will be removed from the approving/rejecting user's folder. Complete: Finishes the forwarding process of an item by updating and closing it's carrier item (but not the item itself). This signifies that the business process supported by the forwarding has finished and needed data collected. As with the Update action, the recipient element is not used and may be omitted, the carrierPayload element can contain an updated carrier or be omitted, and item metadata cannot be changed. If no carrier is provided, the ActiveInactive State element and the CarrierActiveInactive Document element will be set to 'Inactive' automatically, and appropriate change history recorded. Any changed fields may be recorded in carrier's change history via zero or more actionField elements. Close: Closes an item, any carbon copies of the item, and any carrier's forwarding the item, signifying that the business process it supports has concluded. This action cannot be used on carrier items. The actionRecipientUserId, carrierPayload, and actionField elements are not used and can be omitted. The actionDescription element should contain the value 'Close'.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      actionItem
      Input:
      actionItemRequestMessage (soap:body, use = literal)Source code
      request type actionItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • actionType type actionTypeType - type string with restriction - enum { 'Forward', 'Update', 'Approve', 'Reject', 'Complete', 'Close' }
      • actionDescription type string
      • actionRecipientUserId - optional; type keyType
      • carrierPayload - optional; type itemPayloadType
        • Type type itemNonemptyType - type string with restriction minLength(1)
        • Addressing type itemAddressingType
          • Sender type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Receiver type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Owner type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • CarbonCopy - optional;
            • Carbon - optional, unbounded; type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
        • Form type itemFormType
          • CommunityId type itemNullableKeyType
          • FormId type itemKeyType - type positiveInteger with restriction
          • Name type string
        • State type itemStateType
          • Name type string
          • StateId type itemNullableKeyType
          • WorkflowId type itemNullableKeyType
          • TemplateId type itemNullableKeyType
          • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
        • Action - type string with restriction - enum { 'Create', 'Update' }
        • DocId type itemNullableKeyType
        • ExternalId type itemExternalIdType
          • IssueId type string
          • RecordId type string
          • TableId type string
        • Download type itemDownloadType
          • Community type string
          • Parent type itemNullableKeyType
          • RelatedTo type itemNullableKeyType
        • Title type itemNonemptyType - type string with restriction minLength(1)
        • Description type itemNonemptyType - type string with restriction minLength(1)
        • Document type itemDocumentType
          • Fields - optional;
            • Field - optional, unbounded; type itemFieldType
              • Label type string
              • DBName type string
              • Value type string
          • ComplexElements - optional;
            • ComplexElement - optional, unbounded; type itemComplexElementType
              • Name type itemNonemptyType - type string with restriction minLength(1)
              • Field - unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
        • Attachments type itemAttachmentListType
          • Attachment - optional, unbounded; type itemAttachmentType
            • Id type itemNullableKeyType
            • Name type string
            • DisplayText type string
            • ExternalURI type string
            • Size type positiveInteger
            • Status type string
            • StatusItemId type itemNullableKeyType
      • actionField - optional, unbounded;
        • name type string
        • previousValue type string
        • currentValue type string
      Output:
      actionItemResponseMessage (soap:body, use = literal)Source code
      response type actionItemResponse
    2. createAttachment
      Description:
      Adds an attachment to an existing item specified by the itemId element. The attachment name is specified in the attachmentName element. The base64-encoded attachment binary is specified in the attachmentBinary element. Attachment metadata such as size, MIME type, and attaching user is automatically calculated from the request and attachment binary. The response will contain the Id of the newly created attachment in the attachmentId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      createAttachment
      Input:
      createAttachmentRequestMessage (soap:body, use = literal)Source code
      request type createAttachmentRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • attachmentName type string
      • attachmentBinary type base64Binary
      Output:
      createAttachmentResponseMessage (soap:body, use = literal)Source code
      response type createAttachmentResponse
      • attachmentId type keyType
    3. createFolder
      Description:
      Creates a new folder for the user specified by the userId element. The folder is given the name specified by the folderName element. Folder names can only contain alphanumeric characters, hyphens, and spaces, and must be between 1 and 80 characters in length (inclusive). The optional folderParentId element (may be omitted entirely or left empty) specifies an existing folder of which the newly created folder should be a child. If omitted or empty, the newly created folder will be a root level folder with no parent. The response is a folder element containing the newly created folder's attributes in folderId, folderName, and folderParentId elements.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      createFolder
      Input:
      createFolderRequestMessage (soap:body, use = literal)Source code
      request type createFolderRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • folderName - type string with restriction pattern([a-zA-Z0-9 \-]{1,80})
      • folderParentId - optional; type keyType
      Output:
      createFolderResponseMessage (soap:body, use = literal)Source code
      response type createFolderResponse
      • folder type folderType
        • folderId type keyType
        • parentId - optional; type keyType
        • name type string
    4. createItem
      Description:
      Creates a new item conforming to the TTP Item XML Schema. The response contains the Id of the newly created item in the itemId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      createItem
      Input:
      createItemRequestMessage (soap:body, use = literal)Source code
      request type createItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemPayload type itemPayloadType
        • Type type itemNonemptyType - type string with restriction minLength(1)
        • Addressing type itemAddressingType
          • Sender type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Receiver type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Owner type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • CarbonCopy - optional;
            • Carbon - optional, unbounded; type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
        • Form type itemFormType
          • CommunityId type itemNullableKeyType
          • FormId type itemKeyType - type positiveInteger with restriction
          • Name type string
        • State type itemStateType
          • Name type string
          • StateId type itemNullableKeyType
          • WorkflowId type itemNullableKeyType
          • TemplateId type itemNullableKeyType
          • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
        • Action - type string with restriction - enum { 'Create', 'Update' }
        • DocId type itemNullableKeyType
        • ExternalId type itemExternalIdType
          • IssueId type string
          • RecordId type string
          • TableId type string
        • Download type itemDownloadType
          • Community type string
          • Parent type itemNullableKeyType
          • RelatedTo type itemNullableKeyType
        • Title type itemNonemptyType - type string with restriction minLength(1)
        • Description type itemNonemptyType - type string with restriction minLength(1)
        • Document type itemDocumentType
          • Fields - optional;
            • Field - optional, unbounded; type itemFieldType
              • Label type string
              • DBName type string
              • Value type string
          • ComplexElements - optional;
            • ComplexElement - optional, unbounded; type itemComplexElementType
              • Name type itemNonemptyType - type string with restriction minLength(1)
              • Field - unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
        • Attachments type itemAttachmentListType
          • Attachment - optional, unbounded; type itemAttachmentType
            • Id type itemNullableKeyType
            • Name type string
            • DisplayText type string
            • ExternalURI type string
            • Size type positiveInteger
            • Status type string
            • StatusItemId type itemNullableKeyType
      Output:
      createItemResponseMessage (soap:body, use = literal)Source code
      response type createItemResponse
      • itemId type keyType
    5. deleteFolder
      Description:
      Deletes the folder specified in the folderId element. Any child folders are first moved to the root and any contained items are moved to the system-level Inbox folder before the specified folder is deleted.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      deleteFolder
      Input:
      deleteFolderRequestMessage (soap:body, use = literal)Source code
      request type deleteFolderRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • folderId type keyType
      Output:
      deleteFolderResponseMessage (soap:body, use = literal)Source code
      response type deleteFolderResponse
    6. deleteItem
      Description:
      Deletes the item specified in the itemId element from the folder specified in the folderId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      deleteItem
      Input:
      deleteItemRequestMessage (soap:body, use = literal)Source code
      request type deleteItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • folderId type keyType
      • itemId type keyType
      Output:
      deleteItemResponseMessage (soap:body, use = literal)Source code
      response type deleteItemResponse
    7. getAttachment
      Description:
      Retrieves the attachment specified in the attachmentId element for the item specified in the itemId element. The response is an attachment element containing the Id, name, size (in bytes), MIME type, creation datetime (as an ISO 8601 combined date and time string), and base64-encoded binary.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getAttachment
      Input:
      getAttachmentRequestMessage (soap:body, use = literal)Source code
      request type getAttachmentRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • attachmentId type keyType
      Output:
      getAttachmentResponseMessage (soap:body, use = literal)Source code
      response type getAttachmentResponse
      • attachment type attachmentType
        • attachmentId type keyType
        • companyId type keyType
        • userId type keyType
        • name type string
        • size type positiveInteger
        • mime type string
        • datetime type dateTime
        • binary - optional; type base64Binary
    8. getAttachmentList
      Description:
      Retrieves a list of all attachments for the item specified in the itemId element. The response contains zero or more attachment elements like that in the getAttachment response, less the base64-encoded binary.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getAttachmentList
      Input:
      getAttachmentListRequestMessage (soap:body, use = literal)Source code
      request type getAttachmentListRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      Output:
      getAttachmentListResponseMessage (soap:body, use = literal)Source code
      response type getAttachmentListResponse
      • attachment - optional, unbounded; type attachmentType
        • attachmentId type keyType
        • companyId type keyType
        • userId type keyType
        • name type string
        • size type positiveInteger
        • mime type string
        • datetime type dateTime
        • binary - optional; type base64Binary
    9. getAttachments
      Description:
      Retrieves a list of all attachments for the item specified in the itemId element. The response contains zero or more attachment elements like that in the getAttachment response, including the base64-encoded binary.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getAttachments
      Input:
      getAttachmentsRequestMessage (soap:body, use = literal)Source code
      request type getAttachmentsRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      Output:
      getAttachmentsResponseMessage (soap:body, use = literal)Source code
      response type getAttachmentsResponse
      • attachment - optional, unbounded; type attachmentType
        • attachmentId type keyType
        • companyId type keyType
        • userId type keyType
        • name type string
        • size type positiveInteger
        • mime type string
        • datetime type dateTime
        • binary - optional; type base64Binary
    10. getFolderItems
      Description:
      Retrieves a list of all items contained in the folder specified by the folderId element. The response contains zero or more item elements that each contain an item's Id, sender, receiver, active, read, datetime, and subject attributes.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getFolderList
      Input:
      getFolderItemsRequestMessage (soap:body, use = literal)Source code
      request type getFolderItemsRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • folderId type keyType
      Output:
      getFolderItemsResponseMessage (soap:body, use = literal)Source code
      response type getFolderItemsResponse
      • item - optional, unbounded; type itemType
        • itemId type keyType
        • sender
          • company type companyType
            • companyId type keyType
            • name type string
        • receiver
          • company type companyType
            • companyId type keyType
            • name type string
        • active type boolean
        • read type boolean
        • forwarding type boolean
        • datetime type dateTime
        • subject type string
        • payload - optional; type itemPayloadType
          • Type type itemNonemptyType - type string with restriction minLength(1)
          • Addressing type itemAddressingType
            • Sender type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Receiver type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Owner type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • CarbonCopy - optional;
              • Carbon - optional, unbounded; type itemAddressType
                • Id type itemAddressKeyType
                • Name - optional; type string
                • SponsorId - optional; type itemNullableKeyType
                • EdiQualifier - optional; type string
                • EdiAddress - optional; type string
          • Form type itemFormType
            • CommunityId type itemNullableKeyType
            • FormId type itemKeyType - type positiveInteger with restriction
            • Name type string
          • State type itemStateType
            • Name type string
            • StateId type itemNullableKeyType
            • WorkflowId type itemNullableKeyType
            • TemplateId type itemNullableKeyType
            • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
          • Action - type string with restriction - enum { 'Create', 'Update' }
          • DocId type itemNullableKeyType
          • ExternalId type itemExternalIdType
            • IssueId type string
            • RecordId type string
            • TableId type string
          • Download type itemDownloadType
            • Community type string
            • Parent type itemNullableKeyType
            • RelatedTo type itemNullableKeyType
          • Title type itemNonemptyType - type string with restriction minLength(1)
          • Description type itemNonemptyType - type string with restriction minLength(1)
          • Document type itemDocumentType
            • Fields - optional;
              • Field - optional, unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
            • ComplexElements - optional;
              • ComplexElement - optional, unbounded; type itemComplexElementType
                • Name type itemNonemptyType - type string with restriction minLength(1)
                • Field - unbounded; type itemFieldType
                  • Label type string
                  • DBName type string
                  • Value type string
          • Attachments type itemAttachmentListType
            • Attachment - optional, unbounded; type itemAttachmentType
              • Id type itemNullableKeyType
              • Name type string
              • DisplayText type string
              • ExternalURI type string
              • Size type positiveInteger
              • Status type string
              • StatusItemId type itemNullableKeyType
        • carrier - optional; type itemPayloadType
          • Type type itemNonemptyType - type string with restriction minLength(1)
          • Addressing type itemAddressingType
            • Sender type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Receiver type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Owner type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • CarbonCopy - optional;
              • Carbon - optional, unbounded; type itemAddressType
                • Id type itemAddressKeyType
                • Name - optional; type string
                • SponsorId - optional; type itemNullableKeyType
                • EdiQualifier - optional; type string
                • EdiAddress - optional; type string
          • Form type itemFormType
            • CommunityId type itemNullableKeyType
            • FormId type itemKeyType - type positiveInteger with restriction
            • Name type string
          • State type itemStateType
            • Name type string
            • StateId type itemNullableKeyType
            • WorkflowId type itemNullableKeyType
            • TemplateId type itemNullableKeyType
            • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
          • Action - type string with restriction - enum { 'Create', 'Update' }
          • DocId type itemNullableKeyType
          • ExternalId type itemExternalIdType
            • IssueId type string
            • RecordId type string
            • TableId type string
          • Download type itemDownloadType
            • Community type string
            • Parent type itemNullableKeyType
            • RelatedTo type itemNullableKeyType
          • Title type itemNonemptyType - type string with restriction minLength(1)
          • Description type itemNonemptyType - type string with restriction minLength(1)
          • Document type itemDocumentType
            • Fields - optional;
              • Field - optional, unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
            • ComplexElements - optional;
              • ComplexElement - optional, unbounded; type itemComplexElementType
                • Name type itemNonemptyType - type string with restriction minLength(1)
                • Field - unbounded; type itemFieldType
                  • Label type string
                  • DBName type string
                  • Value type string
          • Attachments type itemAttachmentListType
            • Attachment - optional, unbounded; type itemAttachmentType
              • Id type itemNullableKeyType
              • Name type string
              • DisplayText type string
              • ExternalURI type string
              • Size type positiveInteger
              • Status type string
              • StatusItemId type itemNullableKeyType
        • changeHistory - optional;
          • action - optional, unbounded; type actionType
            • type type actionTypeType - type string with restriction - enum { 'Forward', 'Update', 'Approve', 'Reject', 'Complete', 'Close' }
            • description type string
            • datetime type dateTime
            • user type userType
              • userId type keyType
              • companyId type keyType
              • groupId type keyType
              • department type string
              • name type nameType
                • username type string
                • last type string
                • first type string
              • email type string
              • phone type string
              • active type boolean
            • field - optional, unbounded;
              • name type string
              • previousValue type string
              • currentValue type string
    11. getFolderList
      Description:
      Retrieves a list of all of the folders owned by the user specified in the userId element. The response contains zero or more folder elements that each contain a folder's Id, name, and parent Id (if it has one). Root-level folders with no parent will have an empty parentId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getFolderList
      Input:
      getFolderListRequestMessage (soap:body, use = literal)Source code
      request type getFolderListRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      Output:
      getFolderListResponseMessage (soap:body, use = literal)Source code
      response type getFolderListResponse
      • folder - optional, unbounded; type folderType
        • folderId type keyType
        • parentId - optional; type keyType
        • name type string
    12. getItem
      Description:
      Retrieves the item specified by the itemId element. The response includes an item element with numerous child elements: itemId, subject, sender - contains a company element that has the sending company's name and Id, receiver - contains a company element that has the receiving company's name and Id, active - boolean value specifying if the item is active or inactive, read - boolean value specifying if the item has been opened by this user, forwarding - boolean value specifiying if the item is currently being forwarded via a carrier, datetime - creation date of the item (as an ISO 8601 combined date and time string), payload - item XML data model, carrier - carrier item XML data model (if original was forwarded), changeHistory - contains action elements describing the history of the carrier (if original was forwarded)
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getItem
      Input:
      getItemRequestMessage (soap:body, use = literal)Source code
      request type getItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      Output:
      getItemResponseMessage (soap:body, use = literal)Source code
      response type getItemResponse
      • item type itemType
        • itemId type keyType
        • sender
          • company type companyType
            • companyId type keyType
            • name type string
        • receiver
          • company type companyType
            • companyId type keyType
            • name type string
        • active type boolean
        • read type boolean
        • forwarding type boolean
        • datetime type dateTime
        • subject type string
        • payload - optional; type itemPayloadType
          • Type type itemNonemptyType - type string with restriction minLength(1)
          • Addressing type itemAddressingType
            • Sender type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Receiver type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Owner type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • CarbonCopy - optional;
              • Carbon - optional, unbounded; type itemAddressType
                • Id type itemAddressKeyType
                • Name - optional; type string
                • SponsorId - optional; type itemNullableKeyType
                • EdiQualifier - optional; type string
                • EdiAddress - optional; type string
          • Form type itemFormType
            • CommunityId type itemNullableKeyType
            • FormId type itemKeyType - type positiveInteger with restriction
            • Name type string
          • State type itemStateType
            • Name type string
            • StateId type itemNullableKeyType
            • WorkflowId type itemNullableKeyType
            • TemplateId type itemNullableKeyType
            • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
          • Action - type string with restriction - enum { 'Create', 'Update' }
          • DocId type itemNullableKeyType
          • ExternalId type itemExternalIdType
            • IssueId type string
            • RecordId type string
            • TableId type string
          • Download type itemDownloadType
            • Community type string
            • Parent type itemNullableKeyType
            • RelatedTo type itemNullableKeyType
          • Title type itemNonemptyType - type string with restriction minLength(1)
          • Description type itemNonemptyType - type string with restriction minLength(1)
          • Document type itemDocumentType
            • Fields - optional;
              • Field - optional, unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
            • ComplexElements - optional;
              • ComplexElement - optional, unbounded; type itemComplexElementType
                • Name type itemNonemptyType - type string with restriction minLength(1)
                • Field - unbounded; type itemFieldType
                  • Label type string
                  • DBName type string
                  • Value type string
          • Attachments type itemAttachmentListType
            • Attachment - optional, unbounded; type itemAttachmentType
              • Id type itemNullableKeyType
              • Name type string
              • DisplayText type string
              • ExternalURI type string
              • Size type positiveInteger
              • Status type string
              • StatusItemId type itemNullableKeyType
        • carrier - optional; type itemPayloadType
          • Type type itemNonemptyType - type string with restriction minLength(1)
          • Addressing type itemAddressingType
            • Sender type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Receiver type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • Owner type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
            • CarbonCopy - optional;
              • Carbon - optional, unbounded; type itemAddressType
                • Id type itemAddressKeyType
                • Name - optional; type string
                • SponsorId - optional; type itemNullableKeyType
                • EdiQualifier - optional; type string
                • EdiAddress - optional; type string
          • Form type itemFormType
            • CommunityId type itemNullableKeyType
            • FormId type itemKeyType - type positiveInteger with restriction
            • Name type string
          • State type itemStateType
            • Name type string
            • StateId type itemNullableKeyType
            • WorkflowId type itemNullableKeyType
            • TemplateId type itemNullableKeyType
            • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
          • Action - type string with restriction - enum { 'Create', 'Update' }
          • DocId type itemNullableKeyType
          • ExternalId type itemExternalIdType
            • IssueId type string
            • RecordId type string
            • TableId type string
          • Download type itemDownloadType
            • Community type string
            • Parent type itemNullableKeyType
            • RelatedTo type itemNullableKeyType
          • Title type itemNonemptyType - type string with restriction minLength(1)
          • Description type itemNonemptyType - type string with restriction minLength(1)
          • Document type itemDocumentType
            • Fields - optional;
              • Field - optional, unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
            • ComplexElements - optional;
              • ComplexElement - optional, unbounded; type itemComplexElementType
                • Name type itemNonemptyType - type string with restriction minLength(1)
                • Field - unbounded; type itemFieldType
                  • Label type string
                  • DBName type string
                  • Value type string
          • Attachments type itemAttachmentListType
            • Attachment - optional, unbounded; type itemAttachmentType
              • Id type itemNullableKeyType
              • Name type string
              • DisplayText type string
              • ExternalURI type string
              • Size type positiveInteger
              • Status type string
              • StatusItemId type itemNullableKeyType
        • changeHistory - optional;
          • action - optional, unbounded; type actionType
            • type type actionTypeType - type string with restriction - enum { 'Forward', 'Update', 'Approve', 'Reject', 'Complete', 'Close' }
            • description type string
            • datetime type dateTime
            • user type userType
              • userId type keyType
              • companyId type keyType
              • groupId type keyType
              • department type string
              • name type nameType
                • username type string
                • last type string
                • first type string
              • email type string
              • phone type string
              • active type boolean
            • field - optional, unbounded;
              • name type string
              • previousValue type string
              • currentValue type string
    13. getUser
      Description:
      Retrieves user information for the user specified in the userId element. The response is a user element that contains userId, companyId, groupId, department, name, email, phone, and active elements. The name element contains the elements username, last, and first.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getUser
      Input:
      getUserRequestMessage (soap:body, use = literal)Source code
      request type getUserRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      Output:
      getUserResponseMessage (soap:body, use = literal)Source code
      response type getUserResponse
      • user type userType
        • userId type keyType
        • companyId type keyType
        • groupId type keyType
        • department type string
        • name type nameType
          • username type string
          • last type string
          • first type string
        • email type string
        • phone type string
        • active type boolean
    14. getVersion
      Description:
      Retrieves the current version of the API and requires no parameters. The response contains the API version in the verion element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getVersion
      Input:
      getVersionRequestMessage (soap:body, use = literal)Source code
      request type getVersionRequest
      Output:
      getVersionResponseMessage (soap:body, use = literal)Source code
      response type getVersionResponse
      • version type string
    15. login
      Description:
      Authenticates a username and password passed in elements of the same names and establishes a session that can be used in place of usernames and passwords for authenticated operations. This session key will be returned as the response's sessionId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      login
      Input:
      loginRequestMessage (soap:body, use = literal)Source code
      request type loginRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      Output:
      loginResponseMessage (soap:body, use = literal)Source code
      response type loginResponse
      • sessionId type string
    16. logout
      Description:
      Closes a session specified in the sessionId element that was previously started using the login operation.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      logout
      Input:
      logoutRequestMessage (soap:body, use = literal)Source code
      request type logoutRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      Output:
      logoutResponseMessage (soap:body, use = literal)Source code
      response type logoutResponse
    17. moveItem
      Description:
      Moves the item specified in the itemId element from the folder specified in the currentFolderId element to the folder specified in the newFolderId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      moveItem
      Input:
      moveItemRequestMessage (soap:body, use = literal)Source code
      request type moveItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • currentFolderId type keyType
      • newFolderId type keyType
      Output:
      moveItemResponseMessage (soap:body, use = literal)Source code
      response type moveItemResponse
    18. renameFolder
      Description:
      Renames the folder specified in the folderId element using the name provided in the folderName element. The folder name has the same restrictions as that in the createFolder operation. The response format is identical to that of the createFolder operation.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      renameFolder
      Input:
      renameFolderRequestMessage (soap:body, use = literal)Source code
      request type renameFolderRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • folderId type keyType
      • folderName - type string with restriction pattern([a-zA-Z0-9 \-]{1,80})
      Output:
      renameFolderResponseMessage (soap:body, use = literal)Source code
      response type renameFolderResponse
      • folder type folderType
        • folderId type keyType
        • parentId - optional; type keyType
        • name type string
    19. replyToItem
      Description:
      Creates a new item as a reply to the item specified in the itemId element using an XML document conforming to the TTP Item XML Schema. The document data model is transferred base64-encoded in the SOAP envelope's itemPayload element. The response contains the Id of the newly created item in the itemId element.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      replyToItem
      Input:
      replyToItemRequestMessage (soap:body, use = literal)Source code
      request type replyToItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • itemPayload type itemPayloadType
        • Type type itemNonemptyType - type string with restriction minLength(1)
        • Addressing type itemAddressingType
          • Sender type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Receiver type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Owner type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • CarbonCopy - optional;
            • Carbon - optional, unbounded; type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
        • Form type itemFormType
          • CommunityId type itemNullableKeyType
          • FormId type itemKeyType - type positiveInteger with restriction
          • Name type string
        • State type itemStateType
          • Name type string
          • StateId type itemNullableKeyType
          • WorkflowId type itemNullableKeyType
          • TemplateId type itemNullableKeyType
          • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
        • Action - type string with restriction - enum { 'Create', 'Update' }
        • DocId type itemNullableKeyType
        • ExternalId type itemExternalIdType
          • IssueId type string
          • RecordId type string
          • TableId type string
        • Download type itemDownloadType
          • Community type string
          • Parent type itemNullableKeyType
          • RelatedTo type itemNullableKeyType
        • Title type itemNonemptyType - type string with restriction minLength(1)
        • Description type itemNonemptyType - type string with restriction minLength(1)
        • Document type itemDocumentType
          • Fields - optional;
            • Field - optional, unbounded; type itemFieldType
              • Label type string
              • DBName type string
              • Value type string
          • ComplexElements - optional;
            • ComplexElement - optional, unbounded; type itemComplexElementType
              • Name type itemNonemptyType - type string with restriction minLength(1)
              • Field - unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
        • Attachments type itemAttachmentListType
          • Attachment - optional, unbounded; type itemAttachmentType
            • Id type itemNullableKeyType
            • Name type string
            • DisplayText type string
            • ExternalURI type string
            • Size type positiveInteger
            • Status type string
            • StatusItemId type itemNullableKeyType
      Output:
      replyToItemResponseMessage (soap:body, use = literal)Source code
      response type replyToItemResponse
      • itemId type keyType
    20. updateItem
      Description:
      Updates the item specified in the itemId element in place using an XML document conforming to the TTP Item XML Schema specified in the itemPayload element. Changes to item metadata such as Id, type, addressing, state, and related item Ids are not supported and will result in a fault.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      updateItem
      Input:
      updateItemRequestMessage (soap:body, use = literal)Source code
      request type updateItemRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • itemId type keyType
      • itemPayload type itemPayloadType
        • Type type itemNonemptyType - type string with restriction minLength(1)
        • Addressing type itemAddressingType
          • Sender type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Receiver type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • Owner type itemAddressType
            • Id type itemAddressKeyType
            • Name - optional; type string
            • SponsorId - optional; type itemNullableKeyType
            • EdiQualifier - optional; type string
            • EdiAddress - optional; type string
          • CarbonCopy - optional;
            • Carbon - optional, unbounded; type itemAddressType
              • Id type itemAddressKeyType
              • Name - optional; type string
              • SponsorId - optional; type itemNullableKeyType
              • EdiQualifier - optional; type string
              • EdiAddress - optional; type string
        • Form type itemFormType
          • CommunityId type itemNullableKeyType
          • FormId type itemKeyType - type positiveInteger with restriction
          • Name type string
        • State type itemStateType
          • Name type string
          • StateId type itemNullableKeyType
          • WorkflowId type itemNullableKeyType
          • TemplateId type itemNullableKeyType
          • ActiveInactive - type string with restriction - enum { 'Active', 'Inactive' }
        • Action - type string with restriction - enum { 'Create', 'Update' }
        • DocId type itemNullableKeyType
        • ExternalId type itemExternalIdType
          • IssueId type string
          • RecordId type string
          • TableId type string
        • Download type itemDownloadType
          • Community type string
          • Parent type itemNullableKeyType
          • RelatedTo type itemNullableKeyType
        • Title type itemNonemptyType - type string with restriction minLength(1)
        • Description type itemNonemptyType - type string with restriction minLength(1)
        • Document type itemDocumentType
          • Fields - optional;
            • Field - optional, unbounded; type itemFieldType
              • Label type string
              • DBName type string
              • Value type string
          • ComplexElements - optional;
            • ComplexElement - optional, unbounded; type itemComplexElementType
              • Name type itemNonemptyType - type string with restriction minLength(1)
              • Field - unbounded; type itemFieldType
                • Label type string
                • DBName type string
                • Value type string
        • Attachments type itemAttachmentListType
          • Attachment - optional, unbounded; type itemAttachmentType
            • Id type itemNullableKeyType
            • Name type string
            • DisplayText type string
            • ExternalURI type string
            • Size type positiveInteger
            • Status type string
            • StatusItemId type itemNullableKeyType
      Output:
      updateItemResponseMessage (soap:body, use = literal)Source code
      response type updateItemResponse
    21. updateUser
      Description:
      Updates the user specified in the userId element using any specified user information elements out of the list of optional user information elements. These elements include userDepartment, userEmail, userPhone, userUsername, userNameLast, and userNameFirst. The department can only contain alphanumeric characters, hyphens, periods, commas, apostrophes, and spaces. The email must be a valid email address. The phone must be a a valid NANP-format phone number. The username can only contain alphanumeric characters, hyphens, and underscores, and must be between 5 and 20 characters in length inclusive. The first and last names can only contain letters, hyphens, apostrophes, and spaces. The response is identical to that of the getUser operation, containing the changes specified in the request.
      Style:
      document
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      updateUser
      Input:
      updateUserRequestMessage (soap:body, use = literal)Source code
      request type updateUserRequest
      • auth type authType
        • username - optional; type string
        • password - optional; type string
        • companyId - optional; type keyType
        • userId - optional; type keyType
        • sessionId - optional; type string
      • userDepartment - optional; - type string with restriction pattern([\w\-\'., ]+)
      • userEmail - optional; type string
      • userPhone - optional; - type string with restriction pattern((\d[-. ]-?)?\(?\d{3}\)?[-. ]?\d{3}[-. ]?\d{4})
      • userUsername - optional; - type string with restriction pattern([\w-_]{5,20})
      • userNameLast - optional; - type string with restriction pattern([a-zA-Z\-\' ]+)
      • userNameFirst - optional; - type string with restriction pattern([a-zA-Z\-\' ]+)
      Output:
      updateUserResponseMessage (soap:body, use = literal)Source code
      response type updateUserResponse
      • user type userType
        • userId type keyType
        • companyId type keyType
        • groupId type keyType
        • department type string
        • name type nameType
          • username type string
          • last type string
          • first type string
        • email type string
        • phone type string
        • active type boolean

WSDL source code

<?xml version="1.0"?>
<wsdl:definitions targetNamespace="http://www.thetradingportal.com/api/soap/v1/ttp"
xmlns:ttp="http://www.thetradingportal.com/api/soap/v1/ttp"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
>
<!-- type definitions -->
<wsdl:types>
<xsd:schema targetNamespace="http://www.thetradingportal.com/api/soap/v1/ttp"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
>
<!-- reusable simple types -->
<!-- reusable complex types -->
<!-- simple and complex types to define an item -->
<!-- Root Item Type -->
<!-- actionItem request and response -->
<!-- createAttachment request and response -->
<!-- createFolder request and response -->
<!-- createItem request and response -->
<!-- deleteFolder request and response -->
<!-- deleteItem request and response -->
<!-- getAttachment request and response -->
<!-- getAttachmentList request and response -->
<!-- getAttachments request and response -->
<!-- getFolderList request and response -->
<!-- getFolderItems request and response -->
<!-- getItem request and response -->
<!-- getUser request and response -->
<!-- getVersion request and response -->
<!-- login request and response -->
<!-- logout request and response -->
<!-- moveItem request and response -->
<!-- renameFolder request and response -->
<!-- replyToItem request and response -->
<!-- updateItem request and response -->
<!-- updateUser request and response -->
</xsd:schema>
</wsdl:types>
<!-- message definitions -->
<!-- implementation definitions -->
<wsdl:portType name="TTPServicesV1PortType">
<wsdl:operation name="actionItem">
<wsdl:documentation>Performs actions on items and forwarded items (via their carrier item). The action types are: Forward, Update, Approve, Reject, Complete, and Close. Forward: Forwards an item or carrier to another user within the same company. The desired carrier can be provided in the carrierPayload element. Otherwise, the carrierPayload element should be omitted, and a default carrier will be generated for forwarding items or the existing carrier is used for forwarding carriers. When forwarding an item, the carrier is sent to the receiving user and the original is moved to the sending user's Archive system folder. When forwarding a forwarded item's carrier, the carrier is sent to the recipient user and the carrier is removed from the forwarding user's folder. The actionDescription element is used to specify the reason for forwarding the document and will be inserted into the carrier's change history. Any field change history that needs to be recorded for a forward action can be specified in actionField elements (one for each field, or none if not required). If no carrier is provided, the initialization and updating of the Owner field is automatically recorded in the carrier's change history. The recipient of the carrier automatically owns the carrier item (but not the original item), and this behaviour cannot be overridden by specifying another owner in the Addressing element of the carrier item. Update: Updates a forwarded item's carrier with the ability to append field changes to the change history log. The carrierPayload is required and should contain the updated carrier. Changes to the item type, addressing, id, and referenced original document are not supported and will result in a fault. As with the Forward action, the actionDescription element specifies the description of the action in the change history and any field changes can be specifed in zero or more actionField elements. The actionRecipientUserId element is not used by this action and may be omitted. Approve/Reject: Approves or Rejects a forwarded item's carrier with the ability to append changed fields to the carrier's change history. The carrierPayload element is optional and can contain an updated carrier or may be omitted. As with the Update action, changes to item metadata such as type, addressing, id, and referenced original item are not supported and will result in a fault. If no carrier is provided, the existing carrier's CarrierOwnerName and CarrierStatus document fields will be updated to the recipient's name and Approved/Rejected respectively, if they exist (default autogenerated carrier's will contain them) and field change history will be appended automatically to reflect the change. The carrier will be forwarded to the user specified in the actionRecipientUserId element and ownership transferred to them. The carrier will be removed from the approving/rejecting user's folder. Complete: Finishes the forwarding process of an item by updating and closing it's carrier item (but not the item itself). This signifies that the business process supported by the forwarding has finished and needed data collected. As with the Update action, the recipient element is not used and may be omitted, the carrierPayload element can contain an updated carrier or be omitted, and item metadata cannot be changed. If no carrier is provided, the ActiveInactive State element and the CarrierActiveInactive Document element will be set to 'Inactive' automatically, and appropriate change history recorded. Any changed fields may be recorded in carrier's change history via zero or more actionField elements. Close: Closes an item, any carbon copies of the item, and any carrier's forwarding the item, signifying that the business process it supports has concluded. This action cannot be used on carrier items. The actionRecipientUserId, carrierPayload, and actionField elements are not used and can be omitted. The actionDescription element should contain the value 'Close'.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="createAttachment">
<wsdl:documentation>Adds an attachment to an existing item specified by the itemId element. The attachment name is specified in the attachmentName element. The base64-encoded attachment binary is specified in the attachmentBinary element. Attachment metadata such as size, MIME type, and attaching user is automatically calculated from the request and attachment binary. The response will contain the Id of the newly created attachment in the attachmentId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="createFolder">
<wsdl:documentation>Creates a new folder for the user specified by the userId element. The folder is given the name specified by the folderName element. Folder names can only contain alphanumeric characters, hyphens, and spaces, and must be between 1 and 80 characters in length (inclusive). The optional folderParentId element (may be omitted entirely or left empty) specifies an existing folder of which the newly created folder should be a child. If omitted or empty, the newly created folder will be a root level folder with no parent. The response is a folder element containing the newly created folder's attributes in folderId, folderName, and folderParentId elements.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="createItem">
<wsdl:documentation>Creates a new item conforming to the TTP Item XML Schema. The response contains the Id of the newly created item in the itemId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="deleteFolder">
<wsdl:documentation>Deletes the folder specified in the folderId element. Any child folders are first moved to the root and any contained items are moved to the system-level Inbox folder before the specified folder is deleted.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="deleteItem">
<wsdl:documentation>Deletes the item specified in the itemId element from the folder specified in the folderId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getAttachment">
<wsdl:documentation>Retrieves the attachment specified in the attachmentId element for the item specified in the itemId element. The response is an attachment element containing the Id, name, size (in bytes), MIME type, creation datetime (as an ISO 8601 combined date and time string), and base64-encoded binary.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getAttachmentList">
<wsdl:documentation>Retrieves a list of all attachments for the item specified in the itemId element. The response contains zero or more attachment elements like that in the getAttachment response, less the base64-encoded binary.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getAttachments">
<wsdl:documentation>Retrieves a list of all attachments for the item specified in the itemId element. The response contains zero or more attachment elements like that in the getAttachment response, including the base64-encoded binary.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getFolderList">
<wsdl:documentation>Retrieves a list of all of the folders owned by the user specified in the userId element. The response contains zero or more folder elements that each contain a folder's Id, name, and parent Id (if it has one). Root-level folders with no parent will have an empty parentId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getFolderItems">
<wsdl:documentation>Retrieves a list of all items contained in the folder specified by the folderId element. The response contains zero or more item elements that each contain an item's Id, sender, receiver, active, read, datetime, and subject attributes.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getItem">
<wsdl:documentation>Retrieves the item specified by the itemId element. The response includes an item element with numerous child elements: itemId, subject, sender - contains a company element that has the sending company's name and Id, receiver - contains a company element that has the receiving company's name and Id, active - boolean value specifying if the item is active or inactive, read - boolean value specifying if the item has been opened by this user, forwarding - boolean value specifiying if the item is currently being forwarded via a carrier, datetime - creation date of the item (as an ISO 8601 combined date and time string), payload - item XML data model, carrier - carrier item XML data model (if original was forwarded), changeHistory - contains action elements describing the history of the carrier (if original was forwarded)</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getUser">
<wsdl:documentation>Retrieves user information for the user specified in the userId element. The response is a user element that contains userId, companyId, groupId, department, name, email, phone, and active elements. The name element contains the elements username, last, and first.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="getVersion">
<wsdl:documentation>Retrieves the current version of the API and requires no parameters. The response contains the API version in the verion element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="login">
<wsdl:documentation>Authenticates a username and password passed in elements of the same names and establishes a session that can be used in place of usernames and passwords for authenticated operations. This session key will be returned as the response's sessionId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="logout">
<wsdl:documentation>Closes a session specified in the sessionId element that was previously started using the login operation.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="moveItem">
<wsdl:documentation>Moves the item specified in the itemId element from the folder specified in the currentFolderId element to the folder specified in the newFolderId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="renameFolder">
<wsdl:documentation>Renames the folder specified in the folderId element using the name provided in the folderName element. The folder name has the same restrictions as that in the createFolder operation. The response format is identical to that of the createFolder operation.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="replyToItem">
<wsdl:documentation>Creates a new item as a reply to the item specified in the itemId element using an XML document conforming to the TTP Item XML Schema. The document data model is transferred base64-encoded in the SOAP envelope's itemPayload element. The response contains the Id of the newly created item in the itemId element.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="updateItem">
<wsdl:documentation>Updates the item specified in the itemId element in place using an XML document conforming to the TTP Item XML Schema specified in the itemPayload element. Changes to item metadata such as Id, type, addressing, state, and related item Ids are not supported and will result in a fault.</wsdl:documentation>
</wsdl:operation>
<wsdl:operation name="updateUser">
<wsdl:documentation>Updates the user specified in the userId element using any specified user information elements out of the list of optional user information elements. These elements include userDepartment, userEmail, userPhone, userUsername, userNameLast, and userNameFirst. The department can only contain alphanumeric characters, hyphens, periods, commas, apostrophes, and spaces. The email must be a valid email address. The phone must be a a valid NANP-format phone number. The username can only contain alphanumeric characters, hyphens, and underscores, and must be between 5 and 20 characters in length inclusive. The first and last names can only contain letters, hyphens, apostrophes, and spaces. The response is identical to that of the getUser operation, containing the changes specified in the request.</wsdl:documentation>
</wsdl:operation>
</wsdl:portType>
<!-- bindings -->
<wsdl:binding name="TTPServicesV1Binding" type="ttp:TTPServicesV1PortType"></wsdl:binding>
<!-- service definitions -->
<wsdl:service name="TTPServicesV1">
<wsdl:documentation>Provides programmatic access to The Trading Portal's business-to-business electronic document interchange system.</wsdl:documentation>
</wsdl:service>
</wsdl:definitions>

About wsdl-viewer.xsl

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

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