PackagingService v4

Introduction

PackagingService is a service with a SOAP web service interface. It is used for packaging one or more native Signed Data Objects (SDOs) into a richer PDF of different types. It may, for example, be used to package one or more LTV-SDOs into a PAdES SDO.

The service may be used from any platform capable of making a SOAP web service call.

The service relies on Signicat's standalone Session Data Storage (SDS) service for uploading and downloading binary document data.

Differences from PackagingService v3

PackagingService v4 adds the possibility to send the packaged result directly to Signicat's archive. If you specify send-result-to-archive in the createrequest call and set it to true, the return value will be a valid archive reference.

Location

The WSDL for the service is available at:

Infrastructure	Location
Pre-production	https://preprod.signicat.com/ws/packagingservice-v4?wsdl (opens new window)
Production	https://id.signicat.com/ws/packagingservice-v4?wsdl (opens new window)

Note

The only difference between the WSDL in pre-production and production is the SOAP address location attribute.

List of methods

Method	Description
createPackage	Creates a PAdES as specified in the request

createPackage

Purpose

This method is used for creating a PAdES PDF from one or many SDO packages. The file will be available for download in the standalone SDS system when this method returns.

Parameters

Name	Data type	Description
service	String	The name of the customer service (the customer account).
password	String	The password for the service. This is different in pre-production and production.
validation-policy	String	The name of the validation policy to use for validating the SDOs
packaging-method	String	The name of the method to use when creating the package. This method will define both the packaging format and graphical profiles (if relevant).
sdo	List of DocumentId or SdoExtended	Specifies SDOs to be included in the package. Each element in the list is typically a reference to the SDO of type DocumentId. To specify the original document separately from the SDO, use SdoExtended. The two types DocumentId and SdoExtended may be mixed.
send-result-to-archive	Boolean	Specifies if the packaging result will be archived or not. Default is false, meaning that the packaging result will be saved temporarily into Signicat's standalone SDS; the ID in the return value will be an SDS id. If specified and set to true, the packaging result will be archived in Signicat's archive and the return value will be an archive id.

Return value

Name	Data type	Description
id	String	URL to the document package in SDS or to Signicat's archive if sendresulttoarchive is true
error Error An error code and message

Data type: DocumentId

Description

The DocumentId data type is a reference to a document in Signicat's standalone SDS system. A DocumentId can be one of three data types that extend the general DocumentId data type.

Each extension provides field that identifies the document in each target system.

Extensions

Extension	Description
OrderDocumentId	A document that was created recently by the signature portal and is still available there.
ArchiveDocumentId	A document in the archive
SdsDocumentId	A document located in Signicat's standalone Session Data Storage. This is temporary storage that is accessible via a REST interface.

Data type: SdoExtended

Description

The SdoExtended data type contains references to an SDO and the corresponding original document in the SDS system.

Fields

Name	Data type	Description
sdo	DocumentId	A reference to the SDO.
supplementary-data	SupplementaryData	Contains a reference to the original document associated with this SDO

Data type: SupplementaryData

Description

The SupplementaryData data type contains data that is associated with the SDO.

Fields

Name	Data type	Description
original-document	DocumentId	Contains a reference to the original document