isRegisteredUser
This method is used to determine whether an intended recipient of a secure mail package is registered with the system prior to sending the package. If a package is intended for multiple recipients, a separate request can be sent for each of the intended recipients, or else the areRegisteredUsers message can be used. Its use is not mandatory, but is recommended.
isRegisteredUserEx
This method extends isRegisteredUser in that allows for automatic creation of users. Unregistered users are created only if the webservice user belongs to a group where “Create Unregistered Users” is enabled. Additionally This method allows for passing an additional if this username known as the replyTo user. This user must have “Create Unregistered Users” enabled for his group.
areRegisteredUsers
This method is used to determine whether one or more intended recipients of a secure mail package are registered with the system prior to sending the package. Its use is not mandatory, but is recommended.
areRegisteredUsersEx
This method is an extension to the areRegisteredUsers message (see the Description). This method works in the same way but implements the following additional functionality: dependent upon configuration of the Secure Document Exchange server, This method can also cause unregistered users to be created. The Request Parameters and Response are identical barring the following addition.
sendPackage
This method is used to send a secure mail package.
sendPackageEx
This method is an extension to the sendPackage message (see the Description). This method works in the same way as sendPackage, but takes a further parameter indicating that recipients of the package must provide additional authentication before they are allowed access to the package.
sendPackageEx2
This method is an extension to the sendPackageEx message. This method works in the same way but takes a further parameter indicating whether the recipient of the package will be requested to sign (or reject) the package. This allows you to specify that the package requires none or a combination of Additional Authentication and Signing. So the Request Parameters are identical barring the addition of the requestSign parameter.
sendPackageEx3
This method is an extension to the sendPackageEx2 message (see the Description). This method works in the same way but takes a further parameter which is used to indicate the start time of the package. Typically this is used in a “3day docs” scenario where the application date may precede the time the package was sent. There is only one addition to the parameters specified by sendPackageEx2; applicationTimestamp, described below.
sendReply
This method allows a calling process to send a response back to a message back into SDX via web services. The caller has a more limited number of options than when calling one of the sendPackage calls but the benefit is that the response is tied into the original package and includes all the original subject data or meta data as appropriate.
sendtoPaperOut
This method allows a calling process to ask the SDX system to re-route a package to the paperout account. This call was added to allow users of web services to add the ability to allow their users to manually request a paper version of the document.
signPackage
This method allows a calling process to sign an opened package. This will result in a signed package being returned to the original sender. A digital signature will be applied to the package and to all SDX attachments within the package. In addition, any attachments of type PDF will have an Adobe digital signature applied to them. Additional text and or watermarks could also be added to the PDF attachments, depending on the configuration of the skin being used.
getPackageStatus
This method is used to retrieve the status of a sent package.
getExtendedPackageStatus
This method is used to retrieve an extended status message for a sent package. This call is usually used where there is a need to provide a status file for a calling system. The resulting XML can be streamed to a file.
getExtendedPackageStatusEx
This method is an extension to the getExtendedPackageStatus message (see the getExtendedPackageStatus). This method works in the same way but takes a further parameter indicating whether the viewed status of attachments (if any) should be included in the response. It also returns <signed> and <rejected> elements as part of a <PackageStatus> section. So the Request Parameters are identical to those of getExtendedPackageStatus with the following addition.
recallPackage
This method is used to recall a previously sent package.
getPackageTrackingIds
This method is used to retrieve a list of package tracking ids for a specific sender. It is typically used by a calling system that wants to refresh its own view of all sent messages.
getPackageTrackingIdsSince
This method is used to retrieve a list of package tracking ids for a specific sender for which the tracking filter has changed since the given date. For example in order to find all messages that recipients have signed since yesterday. You would set the tracking filter to SIGNED and the date to yesterdays date. It is typically used by a calling system that wants to poll the SDX and only wants changes from the last time it polled.
getPackageStatusTypes
This method is used to retrieve the various filter types that can be used in getPackageTrackingsIds and getPackageTrackingIds since.
stopPackageExpiry
This method is used to stop a package from expiring.
sendPackageTRID
This method is used to send a secure mail package.
getGroupConfigData
This method returns a skin’s configuration data, such as metadata and challenge questions, in XML. System Administrators can use this web service to retrieve any skin configuration. Users can retrieve skin configuration for any skins to which that user has permission to or is a member of.
getSkinList
This method returns a list of all the skins on the SDX system. Only system administrators can use this web service call.
getConfigItemValueEx
This method returns a config item from a skin. System Administrators can use this web service to retrieve skin configuration items from any skin. Users can retrieve skin configuration items from any skins to which that user has permission to or is a member of.
getConfigDataEx
The method returns all the configuration item names that can be used with getConfigDataValueEx to retrieve config item values. System Administrators can use this web service to retrieve skin configuration items from any skin. Users can retrieve skin configuration items from any skins to which that user has permission to or is a member of.
getSentItemsBetween
This method returns a collection of packages sent over a date time period. Only system administrators can use this web service call.
getUpdatedItemsBetween
This web service generates an XML document that contains information about packages that have been signed, viewed, rejected, or archived on the given date. The packages in the XML are separated with one element per customer containing multiple packages. Each package's element contains the ID, along with the created date or completed date, if present.
rejectPackage
The method rejects an opened package, resulting in a rejected copy going back to the sender.
getSentItemsBetweenEx
This method is an extension of getSentItemsBetween and adds the option to return a collection of sent packages, oldest first.
sendPackageEx4
This method is an extension of sendPackageEx3 which adds an optional user tag field to the package. This field allows calling systems to add a unique identifier for packages in SDX that are more helpful to those systems. This field can then be seen during tracking and status pushes.
packageDeliveryExtract
This web service generates an XML document that contains information about packages that have been signed, viewed, rejected, or archived on the given date. The packages in the XML are separated with one element per customer containing multiple packages. Each package's element contains the ID, along with the created date or completed date, if present.
addNewContact
This method adds new a contact to the address book of the calling SDX user.
