Operation createDocument |
Name: |
createDocument |
Signature: |
createDocument (type {xs:string}, properties {signature:PropertyList}) => sigId {xs:string} |
Java signature: |
String createDocument(String type, org.matrix.signature.PropertyList properties) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
type |
xs:string |
1 |
false |
false |
|
properties |
signature:PropertyList |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createDocument xmlns:ns2="http://signature.matrix.org/">
<type>{xs:string}</type>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</ns2:createDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createDocumentResponse xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
</ns2:createDocumentResponse>
</S:Body>
</S:Envelope> |
Operation putDocument |
Name: |
putDocument |
Signature: |
putDocument (document {signature:SignedDocument}) => sigId {xs:string} |
Java signature: |
String putDocument(org.matrix.signature.SignedDocument document) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putDocument xmlns:ns2="http://signature.matrix.org/">
<document>
<type>{xs:string}</type>
<data>{xs:base64Binary}</data>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</document>
</ns2:putDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:putDocumentResponse xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
</ns2:putDocumentResponse>
</S:Body>
</S:Envelope> |
Operation getDocumentData |
Name: |
getDocumentData |
Signature: |
getDocumentData (sigId {xs:string}) => data {xs:base64Binary} |
Java signature: |
byte[] getDocumentData(String sigId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
data |
xs:base64Binary |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDocumentData xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
</ns2:getDocumentData>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDocumentDataResponse xmlns:ns2="http://signature.matrix.org/">
<data>{xs:base64Binary}</data>
</ns2:getDocumentDataResponse>
</S:Body>
</S:Envelope> |
Operation addData |
Name: |
addData |
Signature: |
addData (sigId {xs:string}, dataType {xs:string}, data {xs:base64Binary}, properties {signature:PropertyList}) => return {xs:string} |
Java signature: |
String addData(String sigId, String dataType, byte[] data, org.matrix.signature.PropertyList properties) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
dataType |
xs:string |
1 |
false |
false |
|
data |
xs:base64Binary |
1 |
false |
false |
|
properties |
signature:PropertyList |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addData xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<dataType>{xs:string}</dataType>
<data>{xs:base64Binary}</data>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</ns2:addData>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addDataResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:addDataResponse>
</S:Body>
</S:Envelope> |
Operation addSignature |
Name: |
addSignature |
Signature: |
addSignature (sigId {xs:string}, certData {xs:base64Binary}) => dataToSign {xs:base64Binary} |
Java signature: |
byte[] addSignature(String sigId, byte[] certData) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
certData |
xs:base64Binary |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
dataToSign |
xs:base64Binary |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSignature xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<certData>{xs:base64Binary}</certData>
</ns2:addSignature>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSignatureResponse xmlns:ns2="http://signature.matrix.org/">
<dataToSign>{xs:base64Binary}</dataToSign>
</ns2:addSignatureResponse>
</S:Body>
</S:Envelope> |
Operation addSignatureWithAlgorithm |
Name: |
addSignatureWithAlgorithm |
Signature: |
addSignatureWithAlgorithm (sigId {xs:string}, certData {xs:base64Binary}, signAlgorithm {xs:string}) => dataToSign {xs:base64Binary} |
Java signature: |
byte[] addSignatureWithAlgorithm(String sigId, byte[] certData, String signAlgorithm) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
certData |
xs:base64Binary |
1 |
false |
false |
|
signAlgorithm |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
dataToSign |
xs:base64Binary |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSignatureWithAlgorithm xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<certData>{xs:base64Binary}</certData>
<signAlgorithm>{xs:string}</signAlgorithm>
</ns2:addSignatureWithAlgorithm>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSignatureWithAlgorithmResponse xmlns:ns2="http://signature.matrix.org/">
<dataToSign>{xs:base64Binary}</dataToSign>
</ns2:addSignatureWithAlgorithmResponse>
</S:Body>
</S:Envelope> |
Operation endSignature |
Name: |
endSignature |
Signature: |
endSignature (sigId {xs:string}, signatureData {xs:base64Binary}) => return {xs:string} |
Java signature: |
String endSignature(String sigId, byte[] signatureData) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
signatureData |
xs:base64Binary |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:endSignature xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<signatureData>{xs:base64Binary}</signatureData>
</ns2:endSignature>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:endSignatureResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:endSignatureResponse>
</S:Body>
</S:Envelope> |
Operation addExternalSignature |
Name: |
addExternalSignature |
Signature: |
addExternalSignature (sigId {xs:string}, signature {xs:base64Binary}) => return {xs:string} |
Java signature: |
String addExternalSignature(String sigId, byte[] signature) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
signature |
xs:base64Binary |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addExternalSignature xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<signature>{xs:base64Binary}</signature>
</ns2:addExternalSignature>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addExternalSignatureResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:addExternalSignatureResponse>
</S:Body>
</S:Envelope> |
Operation addSystemSignature |
Name: |
addSystemSignature |
Signature: |
addSystemSignature (sigId {xs:string}, alias {xs:string}) => return {xs:string} |
Java signature: |
String addSystemSignature(String sigId, String alias) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
alias |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSystemSignature xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<alias>{xs:string}</alias>
</ns2:addSystemSignature>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSystemSignatureResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:addSystemSignatureResponse>
</S:Body>
</S:Envelope> |
Operation getDocument |
Name: |
getDocument |
Signature: |
getDocument (sigId {xs:string}) => signedDocument {signature:SignedDocument} |
Java signature: |
org.matrix.signature.SignedDocument getDocument(String sigId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDocument xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
</ns2:getDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDocumentResponse xmlns:ns2="http://signature.matrix.org/">
<signedDocument>
<type>{xs:string}</type>
<data>{xs:base64Binary}</data>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</signedDocument>
</ns2:getDocumentResponse>
</S:Body>
</S:Envelope> |
Operation setDocumentProperties |
Name: |
setDocumentProperties |
Signature: |
setDocumentProperties (sigId {xs:string}, properties {signature:PropertyList}) => return {xs:string} |
Java signature: |
String setDocumentProperties(String sigId, org.matrix.signature.PropertyList properties) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
properties |
signature:PropertyList |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setDocumentProperties xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</ns2:setDocumentProperties>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setDocumentPropertiesResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:setDocumentPropertiesResponse>
</S:Body>
</S:Envelope> |
Operation validateDocument |
Name: |
validateDocument |
Signature: |
validateDocument (sigId {xs:string}, option {xs:string}*) => documentValidation {signature:DocumentValidation} |
Java signature: |
org.matrix.signature.DocumentValidation validateDocument(String sigId, List<String> option) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
option |
xs:string |
0..N |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:validateDocument xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<option>{xs:string}</option>
</ns2:validateDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:validateDocumentResponse xmlns:ns2="http://signature.matrix.org/">
<documentValidation>
<valid>{xs:boolean}</valid>
<signatureValidation>
<signatureId>{xs:string}</signatureId>
<format>{xs:string}</format>
<signer>{xs:string}</signer>
<signingDateTime>{mx:dateTime}</signingDateTime>
<expirationDateTime>{mx:dateTime}</expirationDateTime>
<valid>{xs:boolean}</valid>
<validationDetail>
<code>{xs:string}</code>
<message>{xs:string}</message>
</validationDetail>
</signatureValidation>
</documentValidation>
</ns2:validateDocumentResponse>
</S:Body>
</S:Envelope> |
Operation endDocument |
Name: |
endDocument |
Signature: |
endDocument (sigId {xs:string}, properties {signature:PropertyList}) => return {xs:string} |
Java signature: |
String endDocument(String sigId, org.matrix.signature.PropertyList properties) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
sigId |
xs:string |
1 |
false |
false |
|
properties |
signature:PropertyList |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
return |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:endDocument xmlns:ns2="http://signature.matrix.org/">
<sigId>{xs:string}</sigId>
<properties>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
</properties>
</ns2:endDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:endDocumentResponse xmlns:ns2="http://signature.matrix.org/">
<return>{xs:string}</return>
</ns2:endDocumentResponse>
</S:Body>
</S:Envelope> |